traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added a reference to the discussion in Knuth's "Sorting and Searching", and 

noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
This commit is contained in:
Fred Drake 1998-04-07 19:58:19 +00:00
parent 41565f66b6
commit c708605f4f
2 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/lib/libsoundex.tex
View File

@ -16,7 +16,8 @@ misspellings together.
\begin{funcdesc}{get_soundex}{string}
Return the soundex hash value for a word; it will always be a
6-character string. \var{string} must contain the word to be hashed,
with no leading whitespace; the case of the word is ignored.
with no leading whitespace; the case of the word is ignored. (Note
that the original algorithm produces a 4-character result.)
\end{funcdesc}
\begin{funcdesc}{sound_similar}{string1, string2}
@ -25,3 +26,16 @@ is equivalent to
\code{get_soundex(\var{string1})} \code{==}
\code{get_soundex(\var{string2})}.
\end{funcdesc}
\begin{seealso}
\seetext{Donald E. Knuth, \emph{Sorting and Searching,} vol. 3 in
``The Art of Computer Programming.'' Addison-Wesley Publishing
Company: Reading, MA: 1973. pp.\ 391-392. Discusses the origin and
usefulness of the algorithm, as well as the algorithm itself. Knuth
gives his sources as \emph{U.S. Patents 1261167} (1918) and
\emph{1435663} (1922), attributing the algorithm to Margaret K. Odell
and Robert C. Russel. Additional references are provided.}
\end{seealso}

16
Doc/libsoundex.tex
View File

@ -16,7 +16,8 @@ misspellings together.
\begin{funcdesc}{get_soundex}{string}
Return the soundex hash value for a word; it will always be a
6-character string. \var{string} must contain the word to be hashed,
with no leading whitespace; the case of the word is ignored.
with no leading whitespace; the case of the word is ignored. (Note
that the original algorithm produces a 4-character result.)
\end{funcdesc}
\begin{funcdesc}{sound_similar}{string1, string2}
@ -25,3 +26,16 @@ is equivalent to
\code{get_soundex(\var{string1})} \code{==}
\code{get_soundex(\var{string2})}.
\end{funcdesc}
\begin{seealso}
\seetext{Donald E. Knuth, \emph{Sorting and Searching,} vol. 3 in
``The Art of Computer Programming.'' Addison-Wesley Publishing
Company: Reading, MA: 1973. pp.\ 391-392. Discusses the origin and
usefulness of the algorithm, as well as the algorithm itself. Knuth
gives his sources as \emph{U.S. Patents 1261167} (1918) and
\emph{1435663} (1922), attributing the algorithm to Margaret K. Odell
and Robert C. Russel. Additional references are provided.}
\end{seealso}