annotate lisp/utils/soundex.el @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children ac2d302a0011
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 ;; GNU General Public License for more details.
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 ;;; Synched up with: FSF 19.30.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 ;;; Commentary:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 ;; The Soundex algorithm maps English words into representations of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 ;; how they sound. Words with vaguely similar sound map to the same string.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 ;;; Code:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 (defvar soundex-alist
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 '((?B . "1") (?F . "1") (?P . "1") (?V . "1")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 (?C . "2") (?G . "2") (?J . "2") (?K . "2") (?Q . "2") (?S . "2")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 (?X . "2") (?Z . "2") (?D . "3") (?T . "3") (?L . "4") (?M . "5")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 (?N . "5") (?R . "6"))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 "Alist of chars-to-key-code for building Soundex keys.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 (defun soundex (word)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 "Return a Soundex key for WORD.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 Implemented as described in:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 Knuth, Donald E. \"The Art of Computer Programming, Vol. 3: Sorting
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 and Searching\", Addison-Wesley (1973), pp. 391-392."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 (let* ((word (upcase word)) (length (length word))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 (code (cdr (assq (aref word 0) soundex-alist)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 (key (substring word 0 1)) (index 1) (prev-code code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 ;; once we have a four char key, we're done
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 (while (and (> 4 (length key)) (< index length))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 ;; look up the code for each letter in word at index
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 (setq code (cdr (assq (aref word index) soundex-alist))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 index (1+ index)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 ;; append code to key unless the same codes belong to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 ;; adjacent letters in the original string
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 key (concat key (if (or (null code) (string= code prev-code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 ()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 prev-code code))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 ;; 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
62 (if (> 4 (length key))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 (substring (concat key "000") 0 4)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 key)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 ;(defvar soundex-test
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 ; '("Euler" "Gauss" "Hilbert" "Knuth" "Lloyd" "Lukasiewicz"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 ; "Ellery" "Ghosh" "Heilbronn" "Kant" "Ladd" "Lissajous")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 ; "\n Knuth's names to demonstrate the Soundex algorithm.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 ;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 ;(mapcar 'soundex soundex-test)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 ;("E460" "G200" "H416" "K530" "L300" "L222"
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 ;; soundex.el ends here