| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DaitchMokotoffSoundex |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DaitchMokotoffSoundex |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="analysis-phonetic/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex" class="text-break">Class DaitchMokotoffSoundex |
| </h1> |
| <div class="markdown level0 summary"><p>Encodes a string into a Daitch-Mokotoff Soundex value.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">DaitchMokotoffSoundex</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.IStringEncoder.html">IStringEncoder</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.html">Lucene.Net.Analysis.Phonetic.Language</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Phonetic.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class DaitchMokotoffSoundex : IStringEncoder</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>The Daitch-Mokotoff Soundex algorithm is a refinement of the Russel and American Soundex algorithms, yielding greater |
| accuracy in matching especially Slavish and Yiddish surnames with similar pronunciation but differences in spelling. |
| <p> |
| The main differences compared to the other soundex variants are: |
| <ul><li>coded names are 6 digits long</li><li>the initial character of the name is coded</li><li>rules to encoded multi-character n-grams</li><li>multiple possible encodings for the same name (branching)</li></ul> |
| <p> |
| This implementation supports branching, depending on the used method: |
| <ul><li><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.html#Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_Encode_System_String_">Encode(String)</a>branching disabled, only the first code will be returned</li><li><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.html#Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_GetSoundex_System_String_">GetSoundex(String)</a>branching enabled, all codes will be returned, separated by '|'</li></ul> |
| <p> |
| Note: this implementation has additional branching rules compared to the original description of the algorithm. The |
| rules can be customized by overriding the default rules contained in the resource file |
| <code>Lucene.Net.Analysis.Phonetic.Language.dmrules.txt</code>. |
| <p> |
| This class is thread-safe. |
| <p> |
| See: <a href="http://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex"> Wikipedia - Daitch-Mokotoff Soundex</a> |
| <p> |
| See: <a href="http://www.avotaynu.com/soundex.htm">Avotaynu - Soundexing and Genealogy</a> |
| <p> |
| since 1.10</p> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/DaitchMokotoffSoundex.cs/#L395">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.#ctor">DaitchMokotoffSoundex()</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance with ASCII-folding enabled.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DaitchMokotoffSoundex()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.%23ctor(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/DaitchMokotoffSoundex.cs/#L407">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex__ctor_System_Boolean_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.#ctor(System.Boolean)">DaitchMokotoffSoundex(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance. |
| <p> |
| With ASCII-folding enabled, certain accented characters will be transformed to equivalent ASCII characters, e.g. |
| è -> e.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DaitchMokotoffSoundex(bool folding)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">folding</span></td> |
| <td><p>If ASCII-folding shall be performed before encoding.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_Encode_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.Encode(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/DaitchMokotoffSoundex.cs/#L476">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_Encode_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.Encode(System.String)">Encode(String)</h4> |
| <div class="markdown level1 summary"><p>Encodes a string using the Daitch-Mokotoff soundex algorithm without branching.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Encode(string source)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">source</span></td> |
| <td><p>A string to encode.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>A DM Soundex code corresponding to the string supplied.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>If a character is not mapped.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_Encode_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.html#Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_GetSoundex_System_String_">GetSoundex(String)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_GetSoundex_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.GetSoundex(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/DaitchMokotoffSoundex.cs/#L502">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_GetSoundex_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.GetSoundex*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex_GetSoundex_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex.GetSoundex(System.String)">GetSoundex(String)</h4> |
| <div class="markdown level1 summary"><p>Encodes a string using the Daitch-Mokotoff soundex algorithm with branching. |
| <p> |
| In case a string is encoded into multiple codes (see branching rules), the result will contain all codes, |
| separated by '|'. |
| <p> |
| Example: the name "AUERBACH" is encoded as both |
| <ul><li>097400</li><li>097500</li></ul> |
| <p> |
| Thus the result will be "097400|097500".</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string GetSoundex(string source)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">source</span></td> |
| <td><p>A string to encode.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>A string containing a set of DM Soundex codes corresponding to the string supplied.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>If a character is not mapped.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.IStringEncoder.html">IStringEncoder</a> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Soundex.html">Soundex</a></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DaitchMokotoffSoundex.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DaitchMokotoffSoundex%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/DaitchMokotoffSoundex.cs/#L65" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
