annotate lisp/soundex.el @ 79408:a29ca195b71e

(c-crosses-statement-barrier-p): Fix typo in docstring.
author Juanma Barranquero <lekktu@gmail.com>
date Thu, 15 Nov 2007 18:27:06 +0000
parents 9355f9b7bbff
children 73661ddc7ac7 f55f9811f5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15261
bd56cdc4d07b Fixed up initial line
Erik Naggum <erik@naggum.no>
parents: 14169
diff changeset
1 ;;; soundex.el --- implement Soundex algorithm
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
74442
b2e5081b9320 Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 68651
diff changeset
3 ;; Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
75347
e3694f1cb928 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74442
diff changeset
4 ;; 2006, 2007 Free Software Foundation, Inc.
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Author: Christian Plaunt <chris@bliss.berkeley.edu>
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 38412
diff changeset
7 ;; Maintainer: FSF
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 ;; Keywords: matching
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; Created: Sat May 15 14:48:18 1993
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; This file is part of GNU Emacs.
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
78236
9355f9b7bbff Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
15 ;; the Free Software Foundation; either version 3, or (at your option)
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; any later version.
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; GNU General Public License for more details.
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 8028
diff changeset
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
26 ;; Boston, MA 02110-1301, USA.
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;;; Commentary:
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; The Soundex algorithm maps English words into representations of
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; how they sound. Words with vaguely similar sound map to the same string.
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 18383
diff changeset
33 ;;; Code:
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
7534
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
35 (defvar soundex-alist
8028
ba1bbdb8595e (soundex-alist): Delete the elements that mapped into nil.
Richard M. Stallman <rms@gnu.org>
parents: 7534
diff changeset
36 '((?B . "1") (?F . "1") (?P . "1") (?V . "1")
7534
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
37 (?C . "2") (?G . "2") (?J . "2") (?K . "2") (?Q . "2") (?S . "2")
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
38 (?X . "2") (?Z . "2") (?D . "3") (?T . "3") (?L . "4") (?M . "5")
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
39 (?N . "5") (?R . "6"))
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
40 "Alist of chars-to-key-code for building Soundex keys.")
9b82dae27c01 (soundex-alist): Put variable before fn that uses it.
Richard M. Stallman <rms@gnu.org>
parents: 5995
diff changeset
41
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 (defun soundex (word)
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 "Return a Soundex key for WORD.
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 Implemented as described in:
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 Knuth, Donald E. \"The Art of Computer Programming, Vol. 3: Sorting
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 and Searching\", Addison-Wesley (1973), pp. 391-392."
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 (let* ((word (upcase word)) (length (length word))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 (code (cdr (assq (aref word 0) soundex-alist)))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 (key (substring word 0 1)) (index 1) (prev-code code))
8028
ba1bbdb8595e (soundex-alist): Delete the elements that mapped into nil.
Richard M. Stallman <rms@gnu.org>
parents: 7534
diff changeset
50 ;; once we have a four char key, we're done
5995
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 (while (and (> 4 (length key)) (< index length))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 ;; look up the code for each letter in word at index
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 (setq code (cdr (assq (aref word index) soundex-alist))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 index (1+ index)
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 ;; append code to key unless the same codes belong to
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 ;; adjacent letters in the original string
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 key (concat key (if (or (null code) (string= code prev-code))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 ()
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 code))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 prev-code code))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 ;; return a key that is 4 chars long and padded by "0"s if needed
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 (if (> 4 (length key))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 (substring (concat key "000") 0 4)
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 key)))
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;(defvar soundex-test
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 ; '("Euler" "Gauss" "Hilbert" "Knuth" "Lloyd" "Lukasiewicz"
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 ; "Ellery" "Ghosh" "Heilbronn" "Kant" "Ladd" "Lissajous")
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 ; "\n Knuth's names to demonstrate the Soundex algorithm.")
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 ;
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;(mapcar 'soundex soundex-test)
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 ;("E460" "G200" "H416" "K530" "L300" "L222"
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ; "E460" "G200" "H416" "K530" "L300" "L222")
a24f3890171e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74
18383
11218164bc54 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 15261
diff changeset
75 (provide 'soundex)
11218164bc54 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 15261
diff changeset
76
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49597
diff changeset
77 ;;; arch-tag: b2615a98-feb7-430e-a717-171086738953
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 18383
diff changeset
78 ;;; soundex.el ends here