annotate lisp/utils/soundex.el @ 98:0d2f883870bc r20-1b1

Import from CVS: tag r20-1b1
author cvs
date Mon, 13 Aug 2007 09:13:56 +0200
parents ac2d302a0011
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 ;;; soundex.el -- implement Soundex algorithm
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 ;; Copyright (C) 1993 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 ;; Author: Christian Plaunt <chris@bliss.berkeley.edu>
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 ;; Maintainer: FSF
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 ;; Keywords: matching
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 ;; Created: Sat May 15 14:48:18 1993
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
10 ;; This file is part of XEmacs.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
12 ;; XEmacs is free software; you can redistribute it and/or modify it
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
13 ;; under the terms of the GNU General Public License as published by
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 ;; the Free Software Foundation; either version 2, or (at your option)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 ;; any later version.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
17 ;; XEmacs is distributed in the hope that it will be useful, but
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
20 ;; General Public License for more details.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
25 ;; 02111-1307, USA.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
27 ;;; Synched up with: FSF 19.34.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 ;;; Commentary:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 ;; The Soundex algorithm maps English words into representations of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 ;; how they sound. Words with vaguely similar sound map to the same string.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 ;;; Code:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 (defvar soundex-alist
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 '((?B . "1") (?F . "1") (?P . "1") (?V . "1")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 (?C . "2") (?G . "2") (?J . "2") (?K . "2") (?Q . "2") (?S . "2")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 (?X . "2") (?Z . "2") (?D . "3") (?T . "3") (?L . "4") (?M . "5")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 (?N . "5") (?R . "6"))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 "Alist of chars-to-key-code for building Soundex keys.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 (defun soundex (word)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 "Return a Soundex key for WORD.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 Implemented as described in:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 Knuth, Donald E. \"The Art of Computer Programming, Vol. 3: Sorting
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 and Searching\", Addison-Wesley (1973), pp. 391-392."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 (let* ((word (upcase word)) (length (length word))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 (code (cdr (assq (aref word 0) soundex-alist)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 (key (substring word 0 1)) (index 1) (prev-code code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 ;; once we have a four char key, we're done
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 (while (and (> 4 (length key)) (< index length))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 ;; look up the code for each letter in word at index
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 (setq code (cdr (assq (aref word index) soundex-alist))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 index (1+ index)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 ;; append code to key unless the same codes belong to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 ;; adjacent letters in the original string
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 key (concat key (if (or (null code) (string= code prev-code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 ()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 prev-code code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 ;; return a key that is 4 chars long and padded by "0"s if needed
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 (if (> 4 (length key))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 (substring (concat key "000") 0 4)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 key)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 ;(defvar soundex-test
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 ; '("Euler" "Gauss" "Hilbert" "Knuth" "Lloyd" "Lukasiewicz"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 ; "Ellery" "Ghosh" "Heilbronn" "Kant" "Ladd" "Lissajous")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 ; "\n Knuth's names to demonstrate the Soundex algorithm.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 ;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 ;(mapcar 'soundex soundex-test)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 ;("E460" "G200" "H416" "K530" "L300" "L222"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 ; "E460" "G200" "H416" "K530" "L300" "L222")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 ;; soundex.el ends here