jellyfish/docs/phonetic.rst

Phonetic Encoding
=================

These algorithms convert a string to a normalized phonetic encoding, converting a word to a representation of its pronunciation.  Each takes a single string and returns a coded representation.


American Soundex
----------------

.. py:function:: soundex(s)

    Calculate the American Soundex of the string s.

Soundex is an algorithm to convert a word (typically a name) to a four digit code in the form 
'A123' where 'A' is the first letter of the name and the digits represent similar sounds.

For example ``soundex('Ann') == soundex('Anne') == 'A500'`` and
``soundex('Rupert') == soundex('Robert') == 'R163'``.

See the `Soundex article at Wikipedia <http://en.wikipedia.org/wiki/Soundex>`_ for more details.


Metaphone
---------

.. py:function:: metaphone(s)

    Calculate the metaphone code for the string s.

The metaphone algorithm was designed as an improvement on Soundex.  It transforms a word into a
string consisting of '0BFHJKLMNPRSTWXY' where '0' is pronounced 'th' and 'X' is a '[sc]h' sound.

For example ``metaphone('Klumpz') == metaphone('Clumps') == 'KLMPS'``.

See the `Metaphone article at Wikipedia <http://en.wikipedia.org/wiki/Metaphone>`_ for more details.


NYSIIS
------

.. py:function:: nysiis(s)

    Calculate the NYSIIS code for the string s.

The NYSIIS algorithm is an algorithm developed by the New York State Identification and Intelligence System.  It transforms a word into a phonetic code.  Like soundex and metaphone it is primarily intended for use on names (as they would be pronounced in English).

For example ``nysiis('John') == nysiis('Jan') == JAN``.

See the `NYSIIS article at Wikipedia <http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System>`_ for more details.

Match Rating Approach (codex)
-----------------------------

.. py:function:: match_rating_codex(s)

    Calculate the match rating approach value (also called PNI) for the string s.

The Match rating approach algorithm is an algorithm for determining whether or not two names are
pronounced similarly.  The algorithm consists of an encoding function (similar to soundex or nysiis)
which is implemented here as well as :py:func:`match_rating_comparison` which does the actual comparison.

See the `Match Rating Approach article at Wikipedia <http://en.wikipedia.org/wiki/Match_rating_approach>`_ for more details.
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00			`Phonetic Encoding`
needs review, but all methods documented 2015-02-25 20:49:26 +00:00			`=================`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
revise docs a bit 2015-02-27 06:02:37 +00:00			`These algorithms convert a string to a normalized phonetic encoding, converting a word to a representation of its pronunciation. Each takes a single string and returns a coded representation.`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00

needs review, but all methods documented 2015-02-25 20:49:26 +00:00			`American Soundex`
			`----------------`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
revise docs a bit 2015-02-27 06:02:37 +00:00			`.. py:function:: soundex(s)`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
			`Calculate the American Soundex of the string s.`

			`Soundex is an algorithm to convert a word (typically a name) to a four digit code in the form`
			`'A123' where 'A' is the first letter of the name and the digits represent similar sounds.`

			For example ``soundex('Ann') == soundex('Anne') == 'A500'`` and
			``soundex('Rupert') == soundex('Robert') == 'R163'``.

			See the `Soundex article at Wikipedia <http://en.wikipedia.org/wiki/Soundex>`_ for more details.


needs review, but all methods documented 2015-02-25 20:49:26 +00:00			`Metaphone`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00			`---------`

revise docs a bit 2015-02-27 06:02:37 +00:00			`.. py:function:: metaphone(s)`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
			`Calculate the metaphone code for the string s.`

			`The metaphone algorithm was designed as an improvement on Soundex. It transforms a word into a`
			`string consisting of '0BFHJKLMNPRSTWXY' where '0' is pronounced 'th' and 'X' is a '[sc]h' sound.`

revise docs a bit 2015-02-27 06:02:37 +00:00			For example ``metaphone('Klumpz') == metaphone('Clumps') == 'KLMPS'``.
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
			See the `Metaphone article at Wikipedia <http://en.wikipedia.org/wiki/Metaphone>`_ for more details.


needs review, but all methods documented 2015-02-25 20:49:26 +00:00			`NYSIIS`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00			`------`

revise docs a bit 2015-02-27 06:02:37 +00:00			`.. py:function:: nysiis(s)`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
			`Calculate the NYSIIS code for the string s.`

			`The NYSIIS algorithm is an algorithm developed by the New York State Identification and Intelligence System. It transforms a word into a phonetic code. Like soundex and metaphone it is primarily intended for use on names (as they would be pronounced in English).`

			For example ``nysiis('John') == nysiis('Jan') == JAN``.

			See the `NYSIIS article at Wikipedia <http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System>`_ for more details.

			`Match Rating Approach (codex)`
			`-----------------------------`

revise docs a bit 2015-02-27 06:02:37 +00:00			`.. py:function:: match_rating_codex(s)`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
revise docs a bit 2015-02-27 06:02:37 +00:00			`Calculate the match rating approach value (also called PNI) for the string s.`
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
			`The Match rating approach algorithm is an algorithm for determining whether or not two names are`
			`pronounced similarly. The algorithm consists of an encoding function (similar to soundex or nysiis)`
revise docs a bit 2015-02-27 06:02:37 +00:00			which is implemented here as well as :py:func:`match_rating_comparison` which does the actual comparison.
initial pass at algorithms docs 2015-02-24 23:15:51 +00:00
revise docs a bit 2015-02-27 06:02:37 +00:00			See the `Match Rating Approach article at Wikipedia <http://en.wikipedia.org/wiki/Match_rating_approach>`_ for more details.