blob: b3f00834244aa8b236bfb1f8a5cf81f3827251b9 [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 JaspellTernarySearchTrie
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class JaspellTernarySearchTrie
| 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="suggest/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.Search.Suggest.Jaspell.JaspellTernarySearchTrie">
<h1 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie" class="text-break">Class JaspellTernarySearchTrie
</h1>
<div class="markdown level0 summary"><p>Implementation of a Ternary Search Trie, a data structure for storing
<span class="xref">System.String</span>s that combines the compact size of a binary search
tree with the speed of a digital search trie, and is therefore ideal for
practical use in sorting and searching data.
<p>
<p>This data structure is faster than hashing for many typical search problems,
and supports a broader range of useful problems and operations. Ternary
searches are faster than hashing and more powerful, too.
</p>
<p>
<p>The theory of ternary search trees was described at a symposium in 1997 (see
&quot;Fast Algorithms for Sorting and Searching Strings,&quot; by J.L. Bentley and R.
Sedgewick, Proceedings of the 8th Annual ACM-SIAM Symposium on Discrete
Algorithms, January 1997). Algorithms in C, Third Edition, by Robert
Sedgewick (Addison-Wesley, 1998) provides yet another view of ternary search
trees.
</p></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">JaspellTernarySearchTrie</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.Search.Suggest.Jaspell.html">Lucene.Net.Search.Suggest.Jaspell</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6>
<h5 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class JaspellTernarySearchTrie</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L192">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor">JaspellTernarySearchTrie()</h4>
<div class="markdown level1 summary"><p>Constructs an empty Ternary Search Trie.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie()</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_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_Globalization_CultureInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%23ctor(System.Globalization.CultureInfo)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L201">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_Globalization_CultureInfo_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor(System.Globalization.CultureInfo)">JaspellTernarySearchTrie(CultureInfo)</h4>
<div class="markdown level1 summary"><p>Constructs an empty Ternary Search Trie,
specifying the <span class="xref">System.Globalization.CultureInfo</span> used for lowercasing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie(CultureInfo culture)</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.Globalization.CultureInfo</span></td>
<td><span class="parametername">culture</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%23ctor(System.IO.FileInfo)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L225">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor(System.IO.FileInfo)">JaspellTernarySearchTrie(FileInfo)</h4>
<div class="markdown level1 summary"><p>Constructs a Ternary Search Trie and loads data from a <span class="xref">System.IO.FileInfo</span>
into the Trie. The file is a normal text document, where each line is of
the form word TAB float.</p>
<p>Uses the culture of the current thread to lowercase words before comparing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie(FileInfo file)</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.IO.FileInfo</span></td>
<td><span class="parametername">file</span></td>
<td><p>The <span class="xref">System.IO.FileInfo</span> with the data to load into the Trie. </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.IO.IOException</span></td>
<td><p>A problem occured while reading the data. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%23ctor(System.IO.FileInfo%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L261">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Boolean_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor(System.IO.FileInfo,System.Boolean)">JaspellTernarySearchTrie(FileInfo, Boolean)</h4>
<div class="markdown level1 summary"><p>Constructs a Ternary Search Trie and loads data from a <span class="xref">System.IO.FileInfo</span>
into the Trie. The file is a normal text document, where each line is of
the form &quot;word TAB float&quot;.</p>
<p>Uses the culture of the current thread to lowercase words before comparing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie(FileInfo file, bool compression)</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.IO.FileInfo</span></td>
<td><span class="parametername">file</span></td>
<td><p>The <span class="xref">System.IO.FileInfo</span> with the data to load into the Trie. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">compression</span></td>
<td><p>If true, the file is compressed with the GZIP algorithm, and if
false, the file is a normal text document. </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.IO.IOException</span></td>
<td><p>A problem occured while reading the data. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Boolean_System_Globalization_CultureInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%23ctor(System.IO.FileInfo%2CSystem.Boolean%2CSystem.Globalization.CultureInfo)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L280">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Boolean_System_Globalization_CultureInfo_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor(System.IO.FileInfo,System.Boolean,System.Globalization.CultureInfo)">JaspellTernarySearchTrie(FileInfo, Boolean, CultureInfo)</h4>
<div class="markdown level1 summary"><p>Constructs a Ternary Search Trie and loads data from a <span class="xref">System.IO.FileInfo</span>
into the Trie. The file is a normal text document, where each line is of
the form &quot;word TAB float&quot;.</p>
<p>Uses the supplied culture to lowercase words before comparing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie(FileInfo file, bool compression, CultureInfo culture)</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.IO.FileInfo</span></td>
<td><span class="parametername">file</span></td>
<td><p>The <span class="xref">System.IO.FileInfo</span> with the data to load into the Trie. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">compression</span></td>
<td><p>If true, the file is compressed with the GZIP algorithm, and if
false, the file is a normal text document. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Globalization.CultureInfo</span></td>
<td><span class="parametername">culture</span></td>
<td><p>The culture used for lowercasing.</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.IO.IOException</span></td>
<td><p>A problem occured while reading the data. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Globalization_CultureInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.%23ctor(System.IO.FileInfo%2CSystem.Globalization.CultureInfo)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L242">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie__ctor_System_IO_FileInfo_System_Globalization_CultureInfo_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.#ctor(System.IO.FileInfo,System.Globalization.CultureInfo)">JaspellTernarySearchTrie(FileInfo, CultureInfo)</h4>
<div class="markdown level1 summary"><p>Constructs a Ternary Search Trie and loads data from a <span class="xref">System.IO.FileInfo</span>
into the Trie. The file is a normal text document, where each line is of
the form word TAB float.</p>
<p>Uses the supplied culture to lowercase words before comparing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JaspellTernarySearchTrie(FileInfo file, CultureInfo culture)</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.IO.FileInfo</span></td>
<td><span class="parametername">file</span></td>
<td><p>The <span class="xref">System.IO.FileInfo</span> with the data to load into the Trie. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Globalization.CultureInfo</span></td>
<td><span class="parametername">culture</span></td>
<td><p>The culture used for lowercasing.</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.IO.IOException</span></td>
<td><p>A problem occured while reading the data. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmostDiff%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L903">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmostDiff*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmostDiff">MatchAlmostDiff</h4>
<div class="markdown level1 summary"><p>Sets the number of characters by which words can differ from target word
when calling the <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_">MatchAlmost(String, Int32)</a> method.
<p>
Arguments less than 0 will set the char difference to 0, and arguments
greater than 3 will set the char difference to 3.</p>
<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 MatchAlmostDiff { 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>
<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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumReturnValues.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumReturnValues%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L927">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumReturnValues_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumReturnValues*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumReturnValues" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumReturnValues">NumReturnValues</h4>
<div class="markdown level1 summary"><p>Sets the default maximum number of values returned from the
<a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_System_String_System_Int32_">MatchPrefix(String, Int32)</a> and <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_">MatchAlmost(String, Int32)</a> methods.
<p>
The value should be set this to -1 to get an unlimited number of return
values. note that the methods mentioned above provide overloaded versions
that allow you to specify the maximum number of return values, in which
case this value is temporarily overridden.
</p></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 NumReturnValues { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Get_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Get(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L484">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Get_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Get*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Get_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Get(System.String)">Get(String)</h4>
<div class="markdown level1 summary"><p>Retrieve the object indexed by a key.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual object Get(string key)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> index. </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.Object</span></td>
<td><p>The object retrieved from the Ternary Search Trie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetAndIncrement_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetAndIncrement(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L500">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetAndIncrement_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetAndIncrement*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetAndIncrement_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetAndIncrement(System.String)">GetAndIncrement(String)</h4>
<div class="markdown level1 summary"><p>Retrieve the <see cref="T:float?"></see> indexed by key, increment it by one unit
and store the new <see cref="T:float?"></see>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual float? GetAndIncrement(string key)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> index. </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.Nullable</span>&lt;<span class="xref">System.Single</span>&gt;</td>
<td><p>The <see cref="T:float?"></see> retrieved from the Ternary Search Trie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetKey_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetKey(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L527">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetKey_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetKey*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetKey_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetKey(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)">GetKey(JaspellTernarySearchTrie.TSTNode)</h4>
<div class="markdown level1 summary"><p>Returns the key that indexes the node argument.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual string GetKey(JaspellTernarySearchTrie.TSTNode node)</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.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><span class="parametername">node</span></td>
<td><p>The node whose index is to be calculated. </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>The <span class="xref">System.String</span> that indexes the node argument. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L558">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode(System.String)">GetNode(String)</h4>
<div class="markdown level1 summary"><p>Returns the node indexed by key, or <code>null</code> if that node doesn&apos;t
exist. Search begins at root node.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual JaspellTernarySearchTrie.TSTNode GetNode(string key)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> that indexes the node that is returned. </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><a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><p>The node object indexed by key. This object is an instance of an
inner class named <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a>. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_System_String_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode(System.String%2CLucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L573">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetNode_System_String_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetNode(System.String,Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)">GetNode(String, JaspellTernarySearchTrie.TSTNode)</h4>
<div class="markdown level1 summary"><p>Returns the node indexed by key, or <code>null</code> if that node doesn&apos;t
exist. The search begins at root node.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual JaspellTernarySearchTrie.TSTNode GetNode(string key, JaspellTernarySearchTrie.TSTNode startNode)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> that indexes the node that is returned. </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><span class="parametername">startNode</span></td>
<td><p>The top node defining the subtrie to be searched. </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><a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><p>The node object indexed by key. This object is an instance of an
inner class named <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a>. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetOrCreateNode_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetOrCreateNode(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L620">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetOrCreateNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetOrCreateNode*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetOrCreateNode_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetOrCreateNode(System.String)">GetOrCreateNode(String)</h4>
<div class="markdown level1 summary"><p>Returns the node indexed by key, creating that node if it doesn&apos;t exist,
and creating any required intermediate nodes if they don&apos;t exist.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual JaspellTernarySearchTrie.TSTNode GetOrCreateNode(string key)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> that indexes the node that is returned. </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><a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><p>The node object indexed by key. This object is an instance of an
inner class named <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a>. </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.NullReferenceException</span></td>
<td><p>If the key is <code>null</code>. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.ArgumentException</span></td>
<td><p>If the key is an empty <span class="xref">System.String</span>. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetSizeInBytes.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetSizeInBytes%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L991">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetSizeInBytes_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetSizeInBytes*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_GetSizeInBytes" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.GetSizeInBytes">GetSizeInBytes()</h4>
<div class="markdown level1 summary"><p>Return an approximate memory usage for this trie.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual long GetSizeInBytes()</code></pre>
</div>
<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.Int64</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L686">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost(System.String)">MatchAlmost(String)</h4>
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> of keys that almost match the argument key.
Keys returned will have exactly diff characters that do not match the
target key, where diff is equal to the last value set
to the <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff">MatchAlmostDiff</a> property.
<p>
If the <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_">MatchAlmost(String, Int32)</a> method is called before the
<a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff">MatchAlmostDiff</a> property has been called for the first time,
then diff = 0.</p>
<p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IList&lt;string&gt; MatchAlmost(string key)</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">key</span></td>
<td><p>The target key. </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;<span class="xref">System.String</span>&gt;</td>
<td><p>A <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> with the results. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost(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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L706">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchAlmost(System.String,System.Int32)">MatchAlmost(String, Int32)</h4>
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> of keys that almost match the argument key.
Keys returned will have exactly diff characters that do not match the
target key, where diff is equal to the last value set
to the <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff">MatchAlmostDiff</a> property.
<p>
If the <a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmost_System_String_System_Int32_">MatchAlmost(String, Int32)</a> method is called before the
<a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.html#Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchAlmostDiff">MatchAlmostDiff</a> property has been called for the first time,
then diff = 0.</p>
<p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IList&lt;string&gt; MatchAlmost(string key, int numReturnValues)</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">key</span></td>
<td><p>The target key. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">numReturnValues</span></td>
<td><p>The maximum number of values returned by this method. </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;<span class="xref">System.String</span>&gt;</td>
<td><p>A <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> with the results </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L768">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix(System.String)">MatchPrefix(String)</h4>
<div class="markdown level1 summary"><p>Returns an alphabetical <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> of all keys in the trie that
begin with a given prefix. Only keys for nodes having non-null data are
included in the <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IList&lt;string&gt; MatchPrefix(string prefix)</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">prefix</span></td>
<td><p>Each key returned from this method will begin with the characters
in prefix. </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;<span class="xref">System.String</span>&gt;</td>
<td><p>A <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> with the results. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix(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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L782">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_MatchPrefix_System_String_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.MatchPrefix(System.String,System.Int32)">MatchPrefix(String, Int32)</h4>
<div class="markdown level1 summary"><p>Returns an alphabetical <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> of all keys in the trie that
begin with a given prefix. Only keys for nodes having non-null data are
included in the <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IList&lt;string&gt; MatchPrefix(string prefix, int numReturnValues)</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">prefix</span></td>
<td><p>Each key returned from this method will begin with the characters
in prefix. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">numReturnValues</span></td>
<td><p>The maximum number of values returned from this method. </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;<span class="xref">System.String</span>&gt;</td>
<td><p>A <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> with the results </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L801">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes">NumDataNodes()</h4>
<div class="markdown level1 summary"><p>Returns the number of nodes in the trie that have non-null data.</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 NumDataNodes()</code></pre>
</div>
<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.Int32</span></td>
<td><p>The number of nodes in the trie that have non-null data. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L813">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumDataNodes_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumDataNodes(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)">NumDataNodes(JaspellTernarySearchTrie.TSTNode)</h4>
<div class="markdown level1 summary"><p>Returns the number of nodes in the subtrie below and including the starting
node. The method counts only nodes that have non-null data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual int NumDataNodes(JaspellTernarySearchTrie.TSTNode startingNode)</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.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><span class="parametername">startingNode</span></td>
<td><p>The top node of the subtrie. the node that defines the subtrie. </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.Int32</span></td>
<td><p>The total number of nodes in the subtrie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L823">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes">NumNodes()</h4>
<div class="markdown level1 summary"><p>Returns the total number of nodes in the trie. The method counts nodes
whether or not they have data.</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 NumNodes()</code></pre>
</div>
<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.Int32</span></td>
<td><p>The total number of nodes in the trie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L835">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_NumNodes_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.NumNodes(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode)">NumNodes(JaspellTernarySearchTrie.TSTNode)</h4>
<div class="markdown level1 summary"><p>Returns the total number of nodes in the subtrie below and including the
starting Node. The method counts nodes whether or not they have data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual int NumNodes(JaspellTernarySearchTrie.TSTNode startingNode)</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.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><span class="parametername">startingNode</span></td>
<td><p>The top node of the subtrie. The node that defines the subtrie. </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.Int32</span></td>
<td><p>The total number of nodes in the subtrie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Put_System_String_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Put(System.String%2CSystem.Object)%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L845">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Put_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Put*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Put_System_String_System_Object_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Put(System.String,System.Object)">Put(String, Object)</h4>
<div class="markdown level1 summary"><p>Stores a value in the trie. The value may be retrieved using the key.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Put(string key, object 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">key</span></td>
<td><p>A <span class="xref">System.String</span> that indexes the object to be stored. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">value</span></td>
<td><p>The object to be stored in the Trie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Remove_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Remove(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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L889">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Remove_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Remove*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_Remove_System_String_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.Remove(System.String)">Remove(String)</h4>
<div class="markdown level1 summary"><p>Removes the value indexed by key. Also removes all nodes that are rendered
unnecessary by the removal of this data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Remove(string key)</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">key</span></td>
<td><p>A <span class="xref">System.String</span> that indexes the object to be removed from
the Trie. </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_Search_Suggest_Jaspell_JaspellTernarySearchTrie_SortKeys_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.SortKeys(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L947">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_SortKeys_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.SortKeys*"></a>
<h4 id="Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_SortKeys_Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie_TSTNode_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.SortKeys(Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode,System.Int32)">SortKeys(JaspellTernarySearchTrie.TSTNode, Int32)</h4>
<div class="markdown level1 summary"><p>Returns keys sorted in alphabetical order. This includes the start Node and
all nodes connected to the start Node.
<p>
The number of keys returned is limited to numReturnValues. To get a list
that isn&apos;t limited in size, set numReturnValues to -1.</p>
<p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual IList&lt;string&gt; SortKeys(JaspellTernarySearchTrie.TSTNode startNode, int numReturnValues)</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.Search.Suggest.Jaspell.JaspellTernarySearchTrie.TSTNode.html">JaspellTernarySearchTrie.TSTNode</a></td>
<td><span class="parametername">startNode</span></td>
<td><p>The top node defining the subtrie to be searched. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">numReturnValues</span></td>
<td><p>The maximum number of values returned from this method. </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;<span class="xref">System.String</span>&gt;</td>
<td><p>A <span class="xref">System.Collections.Generic.IList&lt;T&gt;</span> with the results. </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Jaspell_JaspellTernarySearchTrie.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Jaspell.JaspellTernarySearchTrie%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.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs/#L60" 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>