blob: 936c9daecb1a2650c881396860c9e450a44e78a2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Rule
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Rule
| 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.Bm.Rule">
<h1 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule" class="text-break">Class Rule
</h1>
<div class="markdown level0 summary"><p>A phoneme rule.</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">Rule</span></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.Bm.html">Lucene.Net.Analysis.Phonetic.Language.Bm</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Phonetic.dll</h6>
<h5 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Rule</code></pre>
</div>
<h5 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Rules have a pattern, left context, right context, output phoneme, set of languages for which they apply
and a logical flag indicating if all languages must be in play. A rule matches if:
<ul><li>the pattern matches at the current position</li><li>the string up until the beginning of the pattern matches the left context</li><li>the string from the end of the pattern matches the right context</li><li>logical is ALL and all languages are in scope; or</li><li>logical is any other value and at least one language is in scope</li></ul>
<p>
Rules are typically generated by parsing rules resources. In normal use, there will be no need for the user
to explicitly construct their own.
<p>
Rules are immutable and thread-safe.
<p>
<strong>Rules resources</strong>
<p>
Rules are typically loaded from resource files. These are UTF-8 encoded text files. They are systematically
named following the pattern:
<code>Lucene.Net.Analysis.Phonetic.Language.Bm.<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a><em><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></em>[language].txt</code>
<p>
The format of these resources is the following:
<table><tbody><tr><td>Rules:</td><td>
whitespace separated, double-quoted strings. There should be 4 columns to each row, and these
will be interpreted as:
<ol><li>pattern</li><li>left context</li><li>right context</li><li>phoneme</li></ol>
</td></tr><tr><td>End-of-line comments:</td><td>Any occurrence of &apos;//&apos; will cause all text following on that line to be discarded as a comment.</td></tr><tr><td>Multi-line comments:</td><td>Any line starting with &apos;/<em>&apos; will start multi-line commenting mode. This will skip all content until a line ending in &apos;</em>&apos; and &apos;/&apos; is found.</td></tr><tr><td>Blank lines:</td><td>All blank lines will be skipped.</td></tr></tbody></table>
<p>
since 1.6</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_Rule__ctor_System_String_System_String_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_IPhonemeExpr_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.%23ctor(System.String%2CSystem.String%2CSystem.String%2CLucene.Net.Analysis.Phonetic.Language.Bm.IPhonemeExpr)%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/Bm/Rule.cs/#L798">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule__ctor_System_String_System_String_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_IPhonemeExpr_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.#ctor(System.String,System.String,System.String,Lucene.Net.Analysis.Phonetic.Language.Bm.IPhonemeExpr)">Rule(String, String, String, IPhonemeExpr)</h4>
<div class="markdown level1 summary"><p>Creates a new rule.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Rule(string pattern, string lContext, string rContext, IPhonemeExpr phoneme)</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">pattern</span></td>
<td><p>The pattern.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">lContext</span></td>
<td><p>The left context.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">rContext</span></td>
<td><p>The right context.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.IPhonemeExpr.html">IPhonemeExpr</a></td>
<td><span class="parametername">phoneme</span></td>
<td><p>The resulting phoneme.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</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_Bm_Rule_ALL.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.ALL%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/Bm/Rule.cs/#L116">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_ALL" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.ALL">ALL</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string ALL = &quot;ALL&quot;</code></pre>
</div>
<h5 class="fieldValue">Field 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.String</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_Bm_Rule_ALL_STRINGS_RMATCHER.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.ALL_STRINGS_RMATCHER%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/Bm/Rule.cs/#L113">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_ALL_STRINGS_RMATCHER" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.ALL_STRINGS_RMATCHER">ALL_STRINGS_RMATCHER</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly IRPattern ALL_STRINGS_RMATCHER</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.IRPattern.html">IRPattern</a></td>
<td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.LContext%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/Bm/Rule.cs/#L809">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.LContext*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.LContext">LContext</h4>
<div class="markdown level1 summary"><p>Gets the left context pattern. This is a regular expression that must match to the left of the pattern.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IRPattern LContext { 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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.IRPattern.html">IRPattern</a></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_Bm_Rule_Pattern.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Pattern%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/Bm/Rule.cs/#L814">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Pattern*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Pattern">Pattern</h4>
<div class="markdown level1 summary"><p>Gets the pattern. This is a string-literal that must exactly match.</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 Pattern { 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.String</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_Bm_Rule_Phoneme.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Phoneme%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/Bm/Rule.cs/#L819">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Phoneme_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Phoneme*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Phoneme" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.Phoneme">Phoneme</h4>
<div class="markdown level1 summary"><p>Gets the phoneme. If the rule matches, this is the phoneme associated with the pattern match.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IPhonemeExpr Phoneme { 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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.IPhonemeExpr.html">IPhonemeExpr</a></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_Bm_Rule_RContext.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.RContext%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/Bm/Rule.cs/#L824">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_RContext_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.RContext*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_RContext" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.RContext">RContext</h4>
<div class="markdown level1 summary"><p>Gets the right context pattern. This is a regular expression that must match to the right of the pattern.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IRPattern RContext { 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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.IRPattern.html">IRPattern</a></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_Bm_Rule_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%2CLucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)%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/Bm/Rule.cs/#L286">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstance_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)">GetInstance(NameType, RuleType, LanguageSet)</h4>
<div class="markdown level1 summary"><p>Gets rules for a combination of name type, rule type and languages.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IList&lt;Rule&gt; GetInstance(NameType nameType, RuleType rt, LanguageSet langs)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td>
<td><span class="parametername">nameType</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td>
<td><span class="parametername">rt</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet.html">LanguageSet</a></td>
<td><span class="parametername">langs</span></td>
<td><p>The set of languages to consider.</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.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>&gt;</td>
<td><p>A list of <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>s that apply.</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_Bm_Rule_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%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/Bm/Rule.cs/#L305">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstance_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,System.String)">GetInstance(NameType, RuleType, String)</h4>
<div class="markdown level1 summary"><p>Gets rules for a combination of name type, rule type and a single language.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IList&lt;Rule&gt; GetInstance(NameType nameType, RuleType rt, string lang)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td>
<td><span class="parametername">nameType</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td>
<td><span class="parametername">rt</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a> to consider.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">lang</span></td>
<td><p>The language to consider.</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.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>&gt;</td>
<td><p>A list of <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>s that apply.</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_Bm_Rule_GetInstanceMap_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%2CLucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)%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/Bm/Rule.cs/#L319">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstanceMap_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstanceMap_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)">GetInstanceMap(NameType, RuleType, LanguageSet)</h4>
<div class="markdown level1 summary"><p>Gets rules for a combination of name type, rule type and languages.
<p>
since 1.9</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IDictionary&lt;string, IList&lt;Rule&gt;&gt; GetInstanceMap(NameType nameType, RuleType rt, LanguageSet langs)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td>
<td><span class="parametername">nameType</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td>
<td><span class="parametername">rt</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet.html">LanguageSet</a></td>
<td><span class="parametername">langs</span></td>
<td><p>The set of languages to consider.</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.Collections.Generic.IDictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>&gt;&gt;</td>
<td><p>A map containing all <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>s that apply, grouped by the first character of the rule pattern.</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_Bm_Rule_GetInstanceMap_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%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/Bm/Rule.cs/#L335">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstanceMap_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_GetInstanceMap_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.GetInstanceMap(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,System.String)">GetInstanceMap(NameType, RuleType, String)</h4>
<div class="markdown level1 summary"><p>Gets rules for a combination of name type, rule type and a single language.
<p>
since 1.9</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IDictionary&lt;string, IList&lt;Rule&gt;&gt; GetInstanceMap(NameType nameType, RuleType rt, string lang)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td>
<td><span class="parametername">nameType</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> to consider.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td>
<td><span class="parametername">rt</span></td>
<td><p>The <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a> to consider.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">lang</span></td>
<td><p>The language to consider.</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.Collections.Generic.IDictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>&gt;&gt;</td>
<td><p>A map containing all <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html">Rule</a>s that apply, grouped by the first character of the rule pattern.</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_Bm_Rule_PatternAndContextMatches_J2N_Text_ICharSequence_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(J2N.Text.ICharSequence%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/Bm/Rule.cs/#L834">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_J2N_Text_ICharSequence_System_Int32_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(J2N.Text.ICharSequence,System.Int32)">PatternAndContextMatches(ICharSequence, Int32)</h4>
<div class="markdown level1 summary"><p>Decides if the pattern and context match the input starting at a position. It is a match if the
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext">LContext</a> matches <code data-dev-comment-type="paramref" class="paramref">input</code> up to <code data-dev-comment-type="paramref" class="paramref">i</code>, <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> matches at <code data-dev-comment-type="paramref" class="paramref">i</code> and
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_RContext">RContext</a> matches from the end of the match of <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> to the end of <code data-dev-comment-type="paramref" class="paramref">input</code>.</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 PatternAndContextMatches(ICharSequence input, int i)</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">J2N.Text.ICharSequence</span></td>
<td><span class="parametername">input</span></td>
<td><p>The input <span class="xref">J2N.Text.ICharSequence</span>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">i</span></td>
<td><p>The int position within the input.</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 pattern and left/right context match, <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_Bm_Rule_PatternAndContextMatches_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(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/Bm/Rule.cs/#L872">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_System_String_System_Int32_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(System.String,System.Int32)">PatternAndContextMatches(String, Int32)</h4>
<div class="markdown level1 summary"><p>Decides if the pattern and context match the input starting at a position. It is a match if the
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext">LContext</a> matches <code data-dev-comment-type="paramref" class="paramref">input</code> up to <code data-dev-comment-type="paramref" class="paramref">i</code>, <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> matches at <code data-dev-comment-type="paramref" class="paramref">i</code> and
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_RContext">RContext</a> matches from the end of the match of <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> to the end of <code data-dev-comment-type="paramref" class="paramref">input</code>.</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 PatternAndContextMatches(string input, int i)</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">input</span></td>
<td><p>The input <span class="xref">System.String</span>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">i</span></td>
<td><p>The int position within the input.</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 pattern and left/right context match, <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_Bm_Rule_PatternAndContextMatches_System_Text_StringBuilder_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(System.Text.StringBuilder%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/Bm/Rule.cs/#L910">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches*"></a>
<h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_PatternAndContextMatches_System_Text_StringBuilder_System_Int32_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.PatternAndContextMatches(System.Text.StringBuilder,System.Int32)">PatternAndContextMatches(StringBuilder, Int32)</h4>
<div class="markdown level1 summary"><p>Decides if the pattern and context match the input starting at a position. It is a match if the
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_LContext">LContext</a> matches <code data-dev-comment-type="paramref" class="paramref">input</code> up to <code data-dev-comment-type="paramref" class="paramref">i</code>, <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> matches at <code data-dev-comment-type="paramref" class="paramref">i</code> and
<a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_RContext">RContext</a> matches from the end of the match of <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Rule.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Rule_Pattern">Pattern</a> to the end of <code data-dev-comment-type="paramref" class="paramref">input</code>.</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 PatternAndContextMatches(StringBuilder input, int i)</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.Text.StringBuilder</span></td>
<td><span class="parametername">input</span></td>
<td><p>The input <span class="xref">System.Text.StringBuilder</span>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">i</span></td>
<td><p>The int position within the input.</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 pattern and left/right context match, <code>false</code> otherwise.</p>
</td>
</tr>
</tbody>
</table>
</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_Bm_Rule.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Rule%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/Bm/Rule.cs/#L89" 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>