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