Doc/lib/libsoundex.tex

   1 \section{\module{soundex} ---
   2          None}
   3 \declaremodule{builtin}{soundex}
   4
   5 \modulesynopsis{None}
   6
   7
   8
   9 The soundex algorithm takes an English word, and returns an
  10 easily-computed hash of it; this hash is intended to be the same for
  11 words that sound alike.  This module provides an interface to the
  12 soundex algorithm.
  13
  14 Note that the soundex algorithm is quite simple-minded, and isn't
  15 perfect by any measure.  Its main purpose is to help looking up names
  16 in databases, when the name may be misspelled --- soundex hashes common
  17 misspellings together.
  18
  19 \begin{funcdesc}{get_soundex}{string}
  20 Return the soundex hash value for a word; it will always be a
  21 6-character string.  \var{string} must contain the word to be hashed,
  22 with no leading whitespace; the case of the word is ignored.  (Note
  23 that the original algorithm produces a 4-character result.)
  24 \end{funcdesc}
  25
  26 \begin{funcdesc}{sound_similar}{string1, string2}
  27 Compare the word in \var{string1} with the word in \var{string2}; this
  28 is equivalent to
  29 \code{get_soundex(\var{string1})} \code{==}
  30 \code{get_soundex(\var{string2})}.
  31 \end{funcdesc}
  32
  33
  34 \begin{seealso}
  35   \seetext{Donald E. Knuth, \citetitle{Sorting and Searching}, vol. 3
  36            in ``The Art of Computer Programming.'' Addison-Wesley
  37            Publishing Company:  Reading, MA: 1973. pp.\ 391-392.
  38            Discusses the origin and usefulness of the algorithm, as
  39            well as the algorithm itself.  Knuth gives his sources as
  40            \emph{U.S. Patents 1261167} (1918) and \emph{1435663}
  41            (1922), attributing the algorithm to Margaret K. Odell and
  42            Robert C. Russel.  Additional references are provided.}
  43 \end{seealso}