Namespace Lucene.Net.Analysis.Phonetic.Language

Classes

AbstractCaverphone

Encodes a string into a Caverphone value.

This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0 algorithm:

This class is immutable and thread-safe.

See Wikipedia - Caverphone

Caverphone1

Encodes a string into a Caverphone 1.0 value.

This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 1.0 algorithm:

See: Wikipedia - Caverphone

See: Caverphone 1.0 specification

This class is immutable and thread-safe.

since 1.5

Caverphone2

Encodes a string into a Caverphone 2.0 value.

This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0 algorithm:

See: Wikipedia - Caverphone

See: Caverphone 2.0 specification

This class is immutable and thread-safe.

ColognePhonetic

Encodes a string into a Cologne Phonetic value.

DaitchMokotoffSoundex

Encodes a string into a Daitch-Mokotoff Soundex value.

DoubleMetaphone

Encodes a string into a double metaphone value. This Implementation is based on the algorithm by Lawrence Philips.

This class is conditionally thread-safe. The instance field Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.maxCodeLen is mutable MaxCodeLen but is not volatile, and accesses are not synchronized. If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronization is used to ensure safe publication of the value between threads, and must not set MaxCodeLen after initial setup.

See Original Article

See http://en.wikipedia.org/wiki/Metaphone

DoubleMetaphone.DoubleMetaphoneResult

Inner class for storing results, since there is the optional alternate encoding.

MatchRatingApproachEncoder

Match Rating Approach Phonetic Algorithm Developed by Western Airlines in 1977.

This class is immutable and thread-safe.

See: Wikipedia - Match Rating Approach

since 1.8

Metaphone

Encodes a string into a Metaphone value.

Initial Java implementation by William B. Brogden. December, 1997. Permission given by wbrogden for code to be used anywhere.

Hanging on the Metaphone by Lawrence Philips in Computer Language of Dec. 1990, p 39.

Note, that this does not match the algorithm that ships with PHP, or the algorithm found in the Perl implementations:

They have had undocumented changes from the originally published algorithm. For more information, see CODEC-57.

This class is conditionally thread-safe. The instance field Lucene.Net.Analysis.Phonetic.Language.Metaphone.maxCodeLen is mutable MaxCodeLen but is not volatile, and accesses are not synchronized. If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronization is used to ensure safe publication of the value between threads, and must not set MaxCodeLen after initial setup.

Nysiis

Encodes a string into a NYSIIS value. NYSIIS is an encoding used to relate similar names, but can also be used as a general purpose scheme to find word with similar phonemes.

RefinedSoundex

Encodes a string into a Refined Soundex value. A refined soundex code is optimized for spell checking words. Soundex method originally developed by Margaret Odell and Robert Russell.

This class is immutable and thread-safe.

Soundex

Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a general purpose scheme to find word with similar phonemes.

This class is thread-safe. Although not strictly immutable, the Lucene.Net.Analysis.Phonetic.Language.Soundex.maxLength field is not actually used.

Interfaces

IStringEncoder

Defines common encoding methods for encoders.