Merge from origin/emacs-25

[gnu-emacs] / lisp / soundex.el

diff --git a/lisp/soundex.el b/lisp/soundex.el
index caa34fca925b0c9f3f02dc3964e148d58593c050..701904442f08f50b337523eabe1aab5849b40713 100644 (file)
--- a/lisp/soundex.el
+++ b/lisp/soundex.el
@@ -1,18 +1,18 @@
-;;; soundex.el -- implement Soundex algorithm
+;;; soundex.el --- implement Soundex algorithm
 
-;; Copyright (C) 1993 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 2001-2016 Free Software Foundation, Inc.
 
 ;; Author: Christian Plaunt <chris@bliss.berkeley.edu>
-;; Maintainer: FSF 
+;; Maintainer: emacs-devel@gnu.org
 ;; Keywords: matching
 ;; Created: Sat May 15 14:48:18 1993
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -20,15 +20,21 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;; The Soundex algorithm maps English words into representations of
 ;; how they sound.  Words with vaguely similar sound map to the same string.
 
-;;; Code: 
+;;; Code:
+
+(defvar soundex-alist
+  '((?B . "1") (?F . "1") (?P . "1") (?V . "1")
+    (?C . "2") (?G . "2") (?J . "2") (?K . "2") (?Q . "2") (?S . "2")
+    (?X . "2") (?Z . "2") (?D . "3") (?T . "3") (?L . "4") (?M . "5")
+    (?N . "5") (?R . "6"))
+  "Alist of chars-to-key-code for building Soundex keys.")
 
 (defun soundex (word)
   "Return a Soundex key for WORD.
@@ -38,7 +44,7 @@ and Searching\", Addison-Wesley (1973), pp. 391-392."
   (let* ((word (upcase word)) (length (length word))
         (code (cdr (assq (aref word 0) soundex-alist)))
         (key (substring word 0 1)) (index 1) (prev-code code))
-    ;; once we have a four char key, were done
+    ;; once we have a four char key, we're done
     (while (and (> 4 (length key)) (< index length))
       ;; look up the code for each letter in word at index
       (setq code (cdr (assq (aref word index) soundex-alist))
@@ -54,14 +60,6 @@ and Searching\", Addison-Wesley (1973), pp. 391-392."
        (substring (concat key "000") 0 4)
       key)))
 
-(defvar soundex-alist
-  '((?A . nil) (?E . nil) (?H . nil) (?I . nil) (?O . nil) (?U . nil)
-    (?W . nil) (?Y . nil) (?B . "1") (?F . "1") (?P . "1") (?V . "1")
-    (?C . "2") (?G . "2") (?J . "2") (?K . "2") (?Q . "2") (?S . "2")
-    (?X . "2") (?Z . "2") (?D . "3") (?T . "3") (?L . "4") (?M . "5")
-    (?N . "5") (?R . "6"))
-  "Alist of chars-to-key-code for building Soundex keys.")
-
 ;(defvar soundex-test
 ;  '("Euler" "Gauss" "Hilbert" "Knuth" "Lloyd" "Lukasiewicz"
 ;    "Ellery" "Ghosh" "Heilbronn" "Kant" "Ladd" "Lissajous")
@@ -71,4 +69,6 @@ and Searching\", Addison-Wesley (1973), pp. 391-392."
 ;("E460" "G200" "H416" "K530" "L300" "L222"
 ; "E460" "G200" "H416" "K530" "L300" "L222")
 
-;; soundex.el ends here
+(provide 'soundex)
+
+;;; soundex.el ends here