| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DoubleMetaphone |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DoubleMetaphone |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.DoubleMetaphone"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone" class="text-break">Class DoubleMetaphone |
| </h1> |
| <div class="markdown level0 summary"><p>Encodes a string into a double metaphone value. This Implementation is based on the algorithm by <code>Lawrence |
| Philips</code>. |
| <p> |
| This class is conditionally thread-safe. The instance field <span class="xref">Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.maxCodeLen</span> is mutable |
| <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.html#Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_MaxCodeLen">MaxCodeLen</a> 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 <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.html#Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_MaxCodeLen">MaxCodeLen</a> after initial setup. |
| <p> |
| See <a href="http://drdobbs.com/184401251?pgno=2">Original Article</a> |
| <p> |
| See <a href="http://en.wikipedia.org/wiki/Metaphone">http://en.wikipedia.org/wiki/Metaphone</a></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">DoubleMetaphone</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_DoubleMetaphone_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class DoubleMetaphone : IStringEncoder</code></pre> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone__ctor.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L66">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone__ctor" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.#ctor">DoubleMetaphone()</h4> |
| <div class="markdown level1 summary"><p>Creates an instance of this <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.html">DoubleMetaphone</a> encoder</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DoubleMetaphone()</code></pre> |
| </div> |
| <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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_MaxCodeLen.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.MaxCodeLen%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L242">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_MaxCodeLen_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.MaxCodeLen*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_MaxCodeLen" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.MaxCodeLen">MaxCodeLen</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the maxCodeLen.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxCodeLen { get; set; }</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.Int32</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_CharAt_System_String_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.CharAt(System.String%2CSystem.Int32)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L1137">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_CharAt_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.CharAt*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_CharAt_System_String_System_Int32_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.CharAt(System.String,System.Int32)">CharAt(String, Int32)</h4> |
| <div class="markdown level1 summary"><p>Gets the character at index <code data-dev-comment-type="paramref" class="paramref">index</code> if available, otherwise |
| it returns <span class="xref">System.Char.MinValue</span> so that there is some sort |
| of a default.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual char CharAt(string value, int index)</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">value</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">index</span></td> |
| <td></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.Char</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Contains_System_String_System_Int32_System_Int32_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.Contains(System.String%2CSystem.Int32%2CSystem.Int32%2CSystem.String%5B%5D)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L1150">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Contains_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.Contains*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Contains_System_String_System_Int32_System_Int32_System_String___" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.Contains(System.String,System.Int32,System.Int32,System.String[])">Contains(String, Int32, Int32, String[])</h4> |
| <div class="markdown level1 summary"><p>Determines whether <code data-dev-comment-type="paramref" class="paramref">value</code> contains any of the criteria starting at index <code data-dev-comment-type="paramref" class="paramref">start</code> and |
| matching up to length <code data-dev-comment-type="paramref" class="paramref">length</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected static bool Contains(string value, int start, int length, params string[] criteria)</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">value</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">start</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">criteria</span></td> |
| <td></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.Boolean</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Encode_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L206">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_Encode_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.Encode(System.String)">Encode(String)</h4> |
| <div class="markdown level1 summary"><p>Encode the value using DoubleMetaphone.</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 value)</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">value</span></td> |
| <td><p>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>An encoded string.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone(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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L76">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone(System.String)">GetDoubleMetaphone(String)</h4> |
| <div class="markdown level1 summary"><p>Encode a value with Double Metaphone.</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 GetDoubleMetaphone(string value)</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">value</span></td> |
| <td><p>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>An encoded string.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone(System.String%2CSystem.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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L88">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_GetDoubleMetaphone_System_String_System_Boolean_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.GetDoubleMetaphone(System.String,System.Boolean)">GetDoubleMetaphone(String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Encode a value with Double Metaphone, optionally using the alternate encoding.</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 GetDoubleMetaphone(string value, bool alternate)</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">value</span></td> |
| <td><p>String to encode.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">alternate</span></td> |
| <td><p>Use alternate 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>An encoded string.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual(System.String%2CSystem.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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L219">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_System_String_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual(System.String,System.String)">IsDoubleMetaphoneEqual(String, String)</h4> |
| <div class="markdown level1 summary"><p>Check if the Double Metaphone values of two <span class="xref">System.String</span> values |
| are equal.</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 IsDoubleMetaphoneEqual(string value1, string value2)</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">value1</span></td> |
| <td><p>The left-hand side of the encoded <span class="xref">System.String.Equals(System.Object)</span>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value2</span></td> |
| <td><p>The right-hand side of the encoded <span class="xref">System.String.Equals(System.Object)</span>.</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.Boolean</span></td> |
| <td><p><code>true</code> if the encoded <span class="xref">System.String</span>s are equal; <code>false</code> otherwise.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_System_String_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual(System.String%2CSystem.String%2CSystem.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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L233">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone_IsDoubleMetaphoneEqual_System_String_System_String_System_Boolean_" data-uid="Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone.IsDoubleMetaphoneEqual(System.String,System.String,System.Boolean)">IsDoubleMetaphoneEqual(String, String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Check if the Double Metaphone values of two <span class="xref">System.String</span> values |
| are equal, optionally using the alternate value.</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 IsDoubleMetaphoneEqual(string value1, string value2, bool alternate)</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">value1</span></td> |
| <td><p>The left-hand side of the encoded <span class="xref">System.String.Equals(System.Object)</span>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value2</span></td> |
| <td><p>The right-hand side of the encoded <span class="xref">System.String.Equals(System.Object)</span>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">alternate</span></td> |
| <td><p>Use the alternate value if <code>true</code>.</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.Boolean</span></td> |
| <td><p><code>true</code> if the encoded <span class="xref">System.String</span>s are equal; <code>false</code> otherwise.</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> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_DoubleMetaphone.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.DoubleMetaphone%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Phonetic/Language/DoubleMetaphone.cs/#L39" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
