| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Nysiis |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Nysiis |
| | 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.Nysiis"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis" class="text-break">Class Nysiis |
| </h1> |
| <div class="markdown level0 summary"><p>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.</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">Nysiis</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_Nysiis_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class Nysiis : IStringEncoder</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>NYSIIS features an accuracy increase of 2.7% over the traditional Soundex algorithm. |
| <p> |
| Algorithm description: |
| <ol><li>Transcode first characters of name |
| <ol><li>MAC -> MCC</li><li>KN -> NN</li><li>K -> C</li><li>PH -> FF</li><li>PF -> FF</li><li>SCH -> SSS</li></ol> |
| </li><li>Transcode last characters of name |
| <ol><li>EE, IE -> Y</li><li>DT,RT,RD,NT,ND -> D</li></ol> |
| </li><li>First character of key = first character of name</li><li>Transcode remaining characters by following these rules, incrementing by one character each time |
| <ol><li>EV -> AF else A,E,I,O,U -> A</li><li>Q -> G</li><li>Z -> S</li><li>M -> N</li><li>KN -> N else K -> C</li><li>SCH -> SSS</li><li>PH -> FF</li><li>H -> If previous or next is nonvowel, previous</li><li>W -> If previous is vowel, previous</li><li>Add current to key if current != last key character</li></ol> |
| </li><li>If last character is S, remove it</li><li>If last characters are AY, replace with Y</li><li>If last character is A, remove it</li><li>Collapse all strings of repeated characters</li><li>Add original first character of name as first character of key</li></ol> |
| <p> |
| This class is immutable and thread-safe. |
| <p> |
| See: <a href="http://en.wikipedia.org/wiki/NYSIIS">NYSIIS on Wikipedia</a> |
| <p> |
| See: <a href="http://www.dropby.com/NYSIIS.html">NYSIIS on dropby.com</a> |
| <p> |
| since 1.7</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_Nysiis__ctor.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis.%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/Nysiis.cs/#L219">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Nysiis__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis__ctor" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.#ctor">Nysiis()</h4> |
| <div class="markdown level1 summary"><p>Creates an instance of the <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Nysiis.html">Nysiis</a> encoder with strict mode (original form), |
| i.e. encoded strings have a maximum length of 6.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Nysiis()</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_Nysiis__ctor_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis.%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/Nysiis.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Nysiis__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis__ctor_System_Boolean_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.#ctor(System.Boolean)">Nysiis(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Create an instance of the <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Nysiis.html">Nysiis</a> encoder with the specified strict mode: |
| <ul><li><code>true</code>:encoded strings have a maximum length of 6</li><li><code>false</code>:encoded strings may have arbitrary length</li></ul></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Nysiis(bool strict)</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">strict</span></td> |
| <td><p>The strict mode.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </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_Nysiis_IsStrict.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis.IsStrict%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/Nysiis.cs/#L275">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_IsStrict_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.IsStrict*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_IsStrict" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.IsStrict">IsStrict</h4> |
| <div class="markdown level1 summary"><p>Indicates the strict mode for this <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Nysiis.html">Nysiis</a> encoder. |
| <code>true</code> if the encoder is configured for strict mode, <code>false</code> otherwise.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsStrict { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.Boolean</span></td> |
| <td></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_Nysiis_Encode_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis.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/Nysiis.cs/#L266">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_Encode_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.Encode(System.String)">Encode(String)</h4> |
| <div class="markdown level1 summary"><p>Encodes a string using the NYSIIS algorithm.</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 str)</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">str</span></td> |
| <td><p>A string object 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 <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Nysiis.html">Nysiis</a> 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> |
| <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_Nysiis_GetNysiis_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis.GetNysiis(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/Nysiis.cs/#L282">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_GetNysiis_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.GetNysiis*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Nysiis_GetNysiis_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Nysiis.GetNysiis(System.String)">GetNysiis(String)</h4> |
| <div class="markdown level1 summary"><p>Retrieves the NYSIIS code for a given string.</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 GetNysiis(string str)</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">str</span></td> |
| <td><p>String to encode using the NYSIIS algorithm.</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 NYSIIS code for the string supplied.</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_Nysiis.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Nysiis%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/Nysiis.cs/#L102" 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> |