[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Text::Soundex.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::Soundex 3"
.TH Text::Soundex 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Text::Soundex \- Implementation of the Soundex Algorithm as Described by Knuth
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Text::Soundex;
.Ve
.PP
.Vb 2
\&  $code = soundex $string;            # get soundex code for a string
\&  @codes = soundex @list;             # get list of codes for list of strings
.Ve
.PP
.Vb 1
\&  # set value to be returned for strings without soundex code
.Ve
.PP
.Vb 1
\&  $soundex_nocode = 'Z000';
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements the soundex algorithm as described by Donald Knuth
in Volume 3 of \fBThe Art of Computer Programming\fR.  The algorithm is
intended to hash words (in particular surnames) into a small space using a
simple model which approximates the sound of the word when spoken by an English
speaker.  Each word is reduced to a four character string, the first
character being an upper case letter and the remaining three being digits.
.PP
If there is no soundex code representation for a string then the value of
\&\f(CW$soundex_nocode\fR is returned.  This is initially set to \f(CW\*(C`undef\*(C'\fR, but
many people seem to prefer an \fIunlikely\fR value like \f(CW\*(C`Z000\*(C'\fR
(how unlikely this is depends on the data set being dealt with.)  Any value
can be assigned to \f(CW$soundex_nocode\fR.
.PP
In scalar context \f(CW\*(C`soundex\*(C'\fR returns the soundex code of its first
argument, and 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 e.g.
.PP
.Vb 1
\&  @codes = soundex qw(Mike Stok);
.Ve
.PP
leaves \f(CW@codes\fR containing \f(CW\*(C`('M200', 'S320')\*(C'\fR.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Knuth's examples of various 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 'Knuth';              # $code contains 'K530'
\&  @list = soundex qw(Lloyd Gauss);      # @list contains 'L300', 'G200'
.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.
.PP
As it is mapping a large space (arbitrary length strings) 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 "AUTHOR"
.IX Header "AUTHOR"
This code was implemented by Mike Stok (\f(CW\*(C`stok@cybercom.net\*(C'\fR) from the 
description given by Knuth.  Ian Phillipps (\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.
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Text::Soundex 3"
132	.TH Text::Soundex 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133	.SH "NAME"
134	Text::Soundex \- Implementation of the Soundex Algorithm as Described by Knuth
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 1
138	\& use Text::Soundex;
139	.Ve
140	.PP
141	.Vb 2
142	\& $code = soundex $string; # get soundex code for a string
143	\& @codes = soundex @list; # get list of codes for list of strings
144	.Ve
145	.PP
146	.Vb 1
147	\& # set value to be returned for strings without soundex code
148	.Ve
149	.PP
150	.Vb 1
151	\& $soundex_nocode = 'Z000';
152	.Ve
153	.SH "DESCRIPTION"
154	.IX Header "DESCRIPTION"
155	This module implements the soundex algorithm as described by Donald Knuth
156	in Volume 3 of \fBThe Art of Computer Programming\fR. The algorithm is
157	intended to hash words (in particular surnames) into a small space using a
158	simple model which approximates the sound of the word when spoken by an English
159	speaker. Each word is reduced to a four character string, the first
160	character being an upper case letter and the remaining three being digits.
161	.PP
162	If there is no soundex code representation for a string then the value of
163	\&\f(CW$soundex_nocode\fR is returned. This is initially set to \f(CW\(C`undef\(C'\fR, but
164	many people seem to prefer an \fIunlikely\fR value like \f(CW\(C`Z000\(C'\fR
165	(how unlikely this is depends on the data set being dealt with.) Any value
166	can be assigned to \f(CW$soundex_nocode\fR.
167	.PP
168	In scalar context \f(CW\(C`soundex\(C'\fR returns the soundex code of its first
169	argument, and in list context a list is returned in which each element is the
170	soundex code for the corresponding argument passed to \f(CW\(C`soundex\(C'\fR e.g.
171	.PP
172	.Vb 1
173	\& @codes = soundex qw(Mike Stok);
174	.Ve
175	.PP
176	leaves \f(CW@codes\fR containing \f(CW\(C`('M200', 'S320')\(C'\fR.
177	.SH "EXAMPLES"
178	.IX Header "EXAMPLES"
179	Knuth's examples of various names and the soundex codes they map to
180	are listed below:
181	.PP
182	.Vb 6
183	\& Euler, Ellery -> E460
184	\& Gauss, Ghosh -> G200
185	\& Hilbert, Heilbronn -> H416
186	\& Knuth, Kant -> K530
187	\& Lloyd, Ladd -> L300
188	\& Lukasiewicz, Lissajous -> L222
189	.Ve
190	.PP
191	so:
192	.PP
193	.Vb 2
194	\& $code = soundex 'Knuth'; # $code contains 'K530'
195	\& @list = soundex qw(Lloyd Gauss); # @list contains 'L300', 'G200'
196	.Ve
197	.SH "LIMITATIONS"
198	.IX Header "LIMITATIONS"
199	As the soundex algorithm was originally used a \fBlong\fR time ago in the \s-1US\s0
200	it considers only the English alphabet and pronunciation.
201	.PP
202	As it is mapping a large space (arbitrary length strings) onto a small
203	space (single letter plus 3 digits) no inference can be made about the
204	similarity of two strings which end up with the same soundex code. For
205	example, both \f(CW\(C`Hilbert\(C'\fR and \f(CW\(C`Heilbronn\(C'\fR end up with a soundex code
206	of \f(CW\(C`H416\(C'\fR.
207	.SH "AUTHOR"
208	.IX Header "AUTHOR"
209	This code was implemented by Mike Stok (\f(CW\(C`stok@cybercom.net\(C'\fR) from the
210	description given by Knuth. Ian Phillipps (\f(CW\(C`ian@pipex.net\(C'\fR) and Rich Pinder
211	(\f(CW\(C`rpinder@hsc.usc.edu\(C'\fR) supplied ideas and spotted mistakes.