| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Builder<T> |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Builder<T> |
| | 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="core/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.Util.Fst.Builder`1"> |
| |
| |
| <h1 id="Lucene_Net_Util_Fst_Builder_1" data-uid="Lucene.Net.Util.Fst.Builder`1" class="text-break">Class Builder<T> |
| </h1> |
| <div class="markdown level0 summary"><p>Builds a minimal FST (maps an <a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a> term to an arbitrary |
| output) from pre-sorted terms with outputs. The FST |
| becomes an FSA if you use NoOutputs. The FST is written |
| on-the-fly into a compact serialized format byte array, which can |
| be saved to / loaded from a Directory or used directly |
| for traversal. The FST is always finite (no cycles).</p> |
| <p><p>NOTE: The algorithm is described at |
| <a href="http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.24.3698">http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.24.3698</a></p> |
| <p><p>The parameterized type <typeparam name="T"></typeparam> is the output type. See the |
| subclasses of <a class="xref" href="Lucene.Net.Util.Fst.Outputs-1.html">Outputs<T></a>.</p> |
| <p><p>FSTs larger than 2.1GB are now possible (as of Lucene |
| 4.2). FSTs containing more than 2.1B nodes are also now |
| possible, however they cannot be packed. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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"><a class="xref" href="Lucene.Net.Util.Fst.Builder.html">Builder</a></div> |
| <div class="level2"><span class="xref">Builder<T></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.Util.Fst.html">Lucene.Net.Util.Fst</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Util_Fst_Builder_1_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class Builder<T> : Builder</code></pre> |
| </div> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Util_Fst_Builder_1__ctor_Lucene_Net_Util_Fst_FST_INPUT_TYPE_Lucene_Net_Util_Fst_Outputs__0__.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.%23ctor(Lucene.Net.Util.Fst.FST.INPUT_TYPE%2CLucene.Net.Util.Fst.Outputs%7B%600%7D)%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/Util/Fst/Builder.cs/#L100">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1__ctor_" data-uid="Lucene.Net.Util.Fst.Builder`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1__ctor_Lucene_Net_Util_Fst_FST_INPUT_TYPE_Lucene_Net_Util_Fst_Outputs__0__" data-uid="Lucene.Net.Util.Fst.Builder`1.#ctor(Lucene.Net.Util.Fst.FST.INPUT_TYPE,Lucene.Net.Util.Fst.Outputs{`0})">Builder(FST.INPUT_TYPE, Outputs<T>)</h4> |
| <div class="markdown level1 summary"><p>Instantiates an FST/FSA builder without any pruning. A shortcut |
| to <a class="xref" href="Lucene.Net.Util.Fst.Builder-1.html#Lucene_Net_Util_Fst_Builder_1__ctor_Lucene_Net_Util_Fst_FST_INPUT_TYPE_System_Int32_System_Int32_System_Boolean_System_Boolean_System_Int32_Lucene_Net_Util_Fst_Outputs__0__Lucene_Net_Util_Fst_Builder_FreezeTail__0__System_Boolean_System_Single_System_Boolean_System_Int32_">Builder(FST.INPUT_TYPE, Int32, Int32, Boolean, Boolean, Int32, Outputs<T>, Builder.FreezeTail<T>, Boolean, Single, Boolean, Int32)</a> |
| with pruning options turned off.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Builder(FST.INPUT_TYPE inputType, Outputs<T> outputs)</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.Util.Fst.FST.INPUT_TYPE.html">FST.INPUT_TYPE</a></td> |
| <td><span class="parametername">inputType</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Fst.Outputs-1.html">Outputs</a><T></td> |
| <td><span class="parametername">outputs</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_Util_Fst_Builder_1__ctor_Lucene_Net_Util_Fst_FST_INPUT_TYPE_System_Int32_System_Int32_System_Boolean_System_Boolean_System_Int32_Lucene_Net_Util_Fst_Outputs__0__Lucene_Net_Util_Fst_Builder_FreezeTail__0__System_Boolean_System_Single_System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.%23ctor(Lucene.Net.Util.Fst.FST.INPUT_TYPE%2CSystem.Int32%2CSystem.Int32%2CSystem.Boolean%2CSystem.Boolean%2CSystem.Int32%2CLucene.Net.Util.Fst.Outputs%7B%600%7D%2CLucene.Net.Util.Fst.Builder.FreezeTail%7B%600%7D%2CSystem.Boolean%2CSystem.Single%2CSystem.Boolean%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/Util/Fst/Builder.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1__ctor_" data-uid="Lucene.Net.Util.Fst.Builder`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1__ctor_Lucene_Net_Util_Fst_FST_INPUT_TYPE_System_Int32_System_Int32_System_Boolean_System_Boolean_System_Int32_Lucene_Net_Util_Fst_Outputs__0__Lucene_Net_Util_Fst_Builder_FreezeTail__0__System_Boolean_System_Single_System_Boolean_System_Int32_" data-uid="Lucene.Net.Util.Fst.Builder`1.#ctor(Lucene.Net.Util.Fst.FST.INPUT_TYPE,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Int32,Lucene.Net.Util.Fst.Outputs{`0},Lucene.Net.Util.Fst.Builder.FreezeTail{`0},System.Boolean,System.Single,System.Boolean,System.Int32)">Builder(FST.INPUT_TYPE, Int32, Int32, Boolean, Boolean, Int32, Outputs<T>, Builder.FreezeTail<T>, Boolean, Single, Boolean, Int32)</h4> |
| <div class="markdown level1 summary"><p>Instantiates an FST/FSA builder with all the possible tuning and construction |
| tweaks. Read parameter documentation carefully.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Builder(FST.INPUT_TYPE inputType, int minSuffixCount1, int minSuffixCount2, bool doShareSuffix, bool doShareNonSingletonNodes, int shareMaxTailLength, Outputs<T> outputs, Builder.FreezeTail<T> freezeTail, bool doPackFST, float acceptableOverheadRatio, bool allowArrayArcs, int bytesPageBits)</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.Util.Fst.FST.INPUT_TYPE.html">FST.INPUT_TYPE</a></td> |
| <td><span class="parametername">inputType</span></td> |
| <td><p>The input type (transition labels). Can be anything from <a class="xref" href="Lucene.Net.Util.Fst.FST.INPUT_TYPE.html">FST.INPUT_TYPE</a> |
| enumeration. Shorter types will consume less memory. Strings (character sequences) are |
| represented as <a class="xref" href="Lucene.Net.Util.Fst.FST.INPUT_TYPE.html#Lucene_Net_Util_Fst_FST_INPUT_TYPE_BYTE4">BYTE4</a> (full unicode codepoints).</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minSuffixCount1</span></td> |
| <td><p>If pruning the input graph during construction, this threshold is used for telling |
| if a node is kept or pruned. If transition_count(node) >= minSuffixCount1, the node |
| is kept.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minSuffixCount2</span></td> |
| <td><p>(Note: only Mike McCandless knows what this one is really doing...)</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">doShareSuffix</span></td> |
| <td><p>If <code>true</code>, the shared suffixes will be compacted into unique paths. |
| this requires an additional RAM-intensive hash map for lookups in memory. Setting this parameter to |
| <code>false</code> creates a single suffix path for all input sequences. this will result in a larger |
| FST, but requires substantially less memory and CPU during building.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">doShareNonSingletonNodes</span></td> |
| <td><p>Only used if <code data-dev-comment-type="paramref" class="paramref">doShareSuffix</code> is <code>true</code>. Set this to |
| true to ensure FST is fully minimal, at cost of more |
| CPU and more RAM during building.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">shareMaxTailLength</span></td> |
| <td><p>Only used if <code data-dev-comment-type="paramref" class="paramref">doShareSuffix</code> is <code>true</code>. Set this to |
| <span class="xref">System.Int32.MaxValue</span> to ensure FST is fully minimal, at cost of more |
| CPU and more RAM during building.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Fst.Outputs-1.html">Outputs</a><T></td> |
| <td><span class="parametername">outputs</span></td> |
| <td><p>The output type for each input sequence. Applies only if building an FST. For |
| FSA, use <a class="xref" href="Lucene.Net.Util.Fst.NoOutputs.html#Lucene_Net_Util_Fst_NoOutputs_Singleton">Singleton</a> and <a class="xref" href="Lucene.Net.Util.Fst.NoOutputs.html#Lucene_Net_Util_Fst_NoOutputs_NoOutput">NoOutput</a> as the |
| singleton output object.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Fst.Builder.FreezeTail-1.html">Builder.FreezeTail</a><T></td> |
| <td><span class="parametername">freezeTail</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">doPackFST</span></td> |
| <td><p>Pass <code>true</code> to create a packed FST.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">acceptableOverheadRatio</span></td> |
| <td><p>How to trade speed for space when building the FST. this option |
| is only relevant when doPackFST is true. <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_System_Single_">GetMutable(Int32, Int32, Single)</a></p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">allowArrayArcs</span></td> |
| <td><p>Pass false to disable the array arc optimization |
| while building the FST; this will make the resulting |
| FST smaller but slower to traverse.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bytesPageBits</span></td> |
| <td><p>How many bits wide to make each |
| <span class="xref">byte[]</span> block in the <span class="xref">Lucene.Net.Util.Fst.BytesStore</span>; if you know the FST |
| will be large then make this larger. For example 15 |
| bits = 32768 byte pages. </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Builder_1_MappedStateCount.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.MappedStateCount%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/Util/Fst/Builder.cs/#L190">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_MappedStateCount_" data-uid="Lucene.Net.Util.Fst.Builder`1.MappedStateCount*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_MappedStateCount" data-uid="Lucene.Net.Util.Fst.Builder`1.MappedStateCount">MappedStateCount</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 virtual long MappedStateCount { 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.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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Builder_1_TermCount.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.TermCount%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/Util/Fst/Builder.cs/#L188">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_TermCount_" data-uid="Lucene.Net.Util.Fst.Builder`1.TermCount*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_TermCount" data-uid="Lucene.Net.Util.Fst.Builder`1.TermCount">TermCount</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 virtual long TermCount { 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.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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Builder_1_TotStateCount.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.TotStateCount%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/Util/Fst/Builder.cs/#L186">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_TotStateCount_" data-uid="Lucene.Net.Util.Fst.Builder`1.TotStateCount*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_TotStateCount" data-uid="Lucene.Net.Util.Fst.Builder`1.TotStateCount">TotStateCount</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 virtual long TotStateCount { 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.Int64</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Builder_1_Add_Lucene_Net_Util_Int32sRef__0_.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.Add(Lucene.Net.Util.Int32sRef%2C%600)%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/Util/Fst/Builder.cs/#L351">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_Add_" data-uid="Lucene.Net.Util.Fst.Builder`1.Add*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_Add_Lucene_Net_Util_Int32sRef__0_" data-uid="Lucene.Net.Util.Fst.Builder`1.Add(Lucene.Net.Util.Int32sRef,`0)">Add(Int32sRef, T)</h4> |
| <div class="markdown level1 summary"><p>It's OK to add the same input twice in a row with |
| different outputs, as long as outputs impls the merge |
| method. Note that input is fully consumed after this |
| method is returned (so caller is free to reuse), but |
| output is not. So if your outputs are changeable (eg |
| <a class="xref" href="Lucene.Net.Util.Fst.ByteSequenceOutputs.html">ByteSequenceOutputs</a> or |
| <a class="xref" href="Lucene.Net.Util.Fst.Int32SequenceOutputs.html">Int32SequenceOutputs</a>) then you cannot reuse across |
| calls.</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 Add(Int32sRef input, T output)</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.Util.Int32sRef.html">Int32sRef</a></td> |
| <td><span class="parametername">input</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">T</span></td> |
| <td><span class="parametername">output</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_Util_Fst_Builder_1_Finish.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.Finish%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/Util/Fst/Builder.cs/#L499">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_Finish_" data-uid="Lucene.Net.Util.Fst.Builder`1.Finish*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_Finish" data-uid="Lucene.Net.Util.Fst.Builder`1.Finish">Finish()</h4> |
| <div class="markdown level1 summary"><p>Returns final FST. NOTE: this will return null if |
| nothing is accepted by the FST.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FST<T> Finish()</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><a class="xref" href="Lucene.Net.Util.Fst.FST-1.html">FST</a><T></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_Util_Fst_Builder_1_GetFstSizeInBytes.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601.GetFstSizeInBytes%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/Util/Fst/Builder.cs/#L565">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Fst_Builder_1_GetFstSizeInBytes_" data-uid="Lucene.Net.Util.Fst.Builder`1.GetFstSizeInBytes*"></a> |
| <h4 id="Lucene_Net_Util_Fst_Builder_1_GetFstSizeInBytes" data-uid="Lucene.Net.Util.Fst.Builder`1.GetFstSizeInBytes">GetFstSizeInBytes()</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 virtual long GetFstSizeInBytes()</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> |
| </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_Util_Fst_Builder_1.md&value=---%0Auid%3A%20Lucene.Net.Util.Fst.Builder%601%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/Util/Fst/Builder.cs/#L52" 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> |
