.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Soundex 3"
.TH Soundex 3 "2015-11-10" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::Soundex \- Implementation of the soundex algorithm.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Text::Soundex;
\&
\&  # Original algorithm.
\&  $code = soundex($name);    # Get the soundex code for a name.
\&  @codes = soundex(@names);  # Get the list of codes for a list of names.
\&
\&  # American Soundex variant (NARA) \- Used for US census data.
\&  $code = soundex_nara($name);    # Get the soundex code for a name.
\&  @codes = soundex_nara(@names);  # Get the list of codes for a list of names.
\&
\&  # Redefine the value that soundex() will return if the input string
\&  # contains no identifiable sounds within it.
\&  $Text::Soundex::nocode = \*(AqZ000\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Soundex is a phonetic algorithm for indexing names by sound, as
pronounced in English. The goal is for names with the same
pronunciation to be encoded to the same representation so that they
can be matched despite minor differences in spelling. Soundex is the
most widely known of all phonetic algorithms and is often used
(incorrectly) as a synonym for \*(L"phonetic algorithm\*(R". Improvements to
Soundex are the basis for many modern phonetic algorithms. (Wikipedia,
2007)
.PP
This module implements the original soundex algorithm developed by
Robert Russell and Margaret Odell, patented in 1918 and 1922, as well
as a variation called \*(L"American Soundex\*(R" used for \s-1US\s0 census data, and
current maintained by the National Archives and Records Administration
(\s-1NARA\s0).
.PP
The soundex algorithm may be recognized from Donald Knuth's
\&\fBThe Art of Computer Programming\fR. The algorithm described by
Knuth is the \s-1NARA\s0 algorithm.
.PP
The value returned for strings which have no soundex encoding is
defined using \f(CW$Text::Soundex::nocode\fR. The default value is \f(CW\*(C`undef\*(C'\fR,
however values such as \f(CW\*(AqZ000\*(Aq\fR are commonly used alternatives.
.PP
For backward compatibility with older versions of this module the
\&\f(CW$Text::Soundex::nocode\fR is exported into the caller's namespace as
\&\f(CW$soundex_nocode\fR.
.PP
In scalar context, \f(CW\*(C`soundex()\*(C'\fR returns the soundex code of its first
argument. In list context, a list is returned in which each element is the
soundex code for the corresponding argument passed to \f(CW\*(C`soundex()\*(C'\fR. For
example, the following code assigns \f(CW@codes\fR the value \f(CW\*(C`(\*(AqM200\*(Aq, \*(AqS320\*(Aq)\*(C'\fR:
.PP
.Vb 1
\&   @codes = soundex qw(Mike Stok);
.Ve
.PP
To use \f(CW\*(C`Text::Soundex\*(C'\fR to generate codes that can be used to search one
of the publically available \s-1US\s0 Censuses, a variant of the soundex
algorithm must be used:
.PP
.Vb 2
\&    use Text::Soundex;
\&    $code = soundex_nara($name);
.Ve
.PP
An example of where these algorithm differ follows:
.PP
.Vb 3
\&    use Text::Soundex;
\&    print soundex("Ashcraft"), "\en";       # prints: A226
\&    print soundex_nara("Ashcraft"), "\en";  # prints: A261
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Donald Knuth's examples of names and the soundex codes they map to
are listed below:
.PP
.Vb 6
\&  Euler, Ellery \-> E460
\&  Gauss, Ghosh \-> G200
\&  Hilbert, Heilbronn \-> H416
\&  Knuth, Kant \-> K530
\&  Lloyd, Ladd \-> L300
\&  Lukasiewicz, Lissajous \-> L222
.Ve
.PP
so:
.PP
.Vb 2
\&  $code = soundex \*(AqKnuth\*(Aq;         # $code contains \*(AqK530\*(Aq
\&  @list = soundex qw(Lloyd Gauss); # @list contains \*(AqL300\*(Aq, \*(AqG200\*(Aq
.Ve
.SH "LIMITATIONS"
.IX Header "LIMITATIONS"
As the soundex algorithm was originally used a \fBlong\fR time ago in the \s-1US\s0
it considers only the English alphabet and pronunciation. In particular,
non-ASCII characters will be ignored. The recommended method of dealing
with characters that have accents, or other unicode characters, is to use
the Text::Unidecode module available from \s-1CPAN.\s0 Either use the module
explicitly:
.PP
.Vb 2
\&    use Text::Soundex;
\&    use Text::Unidecode;
\&
\&    print soundex(unidecode("Fran\exE7ais")), "\en"; # Prints "F652\en"
.Ve
.PP
Or use the convenient wrapper routine:
.PP
.Vb 1
\&    use Text::Soundex \*(Aqsoundex_unicode\*(Aq;
\&
\&    print soundex_unicode("Fran\exE7ais"), "\en";    # Prints "F652\en"
.Ve
.PP
Since the soundex algorithm maps a large space (strings of arbitrary
length) onto a small space (single letter plus 3 digits) no inference
can be made about the similarity of two strings which end up with the
same soundex code.  For example, both \f(CW\*(C`Hilbert\*(C'\fR and \f(CW\*(C`Heilbronn\*(C'\fR end
up with a soundex code of \f(CW\*(C`H416\*(C'\fR.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 1998\-2003 by Mark Mielke.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "MAINTAINER"
.IX Header "MAINTAINER"
This module is currently maintain by Mark Mielke (\f(CW\*(C`mark@mielke.cc\*(C'\fR).
.SH "HISTORY"
.IX Header "HISTORY"
Version 3 is a significant update to provide support for versions of
Perl later than Perl 5.004. Specifically, the \s-1XS\s0 version of the
\&\fBsoundex()\fR subroutine understands strings that are encoded using \s-1UTF\-8\s0
(unicode strings).
.PP
Version 2 of this module was a re-write by Mark Mielke (\f(CW\*(C`mark@mielke.cc\*(C'\fR)
to improve the speed of the subroutines. The \s-1XS\s0 version of the \fBsoundex()\fR
subroutine was introduced in 2.00.
.PP
Version 1 of this module was written by Mike Stok (\f(CW\*(C`mike@stok.co.uk\*(C'\fR)
and was included into the Perl core library set.
.PP
Dave Carlsen (\f(CW\*(C`dcarlsen@csranet.com\*(C'\fR) made the request for the \s-1NARA\s0
algorithm to be included. The \s-1NARA\s0 soundex page can be viewed at:
\&\f(CW\*(C`http://www.archives.gov/research/census/soundex.html\*(C'\fR
.PP
Ian Phillips (\f(CW\*(C`ian@pipex.net\*(C'\fR) and Rich Pinder (\f(CW\*(C`rpinder@hsc.usc.edu\*(C'\fR)
supplied ideas and spotted mistakes for v1.x.
