| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FSTCompletionLookup |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FSTCompletionLookup |
| | Apache Lucene.NET 4.8.0-beta00011 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.Fst.FSTCompletionLookup"> |
| |
| |
| <h1 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup" class="text-break">Class FSTCompletionLookup |
| </h1> |
| <div class="markdown level0 summary"><p>An adapter from <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html">Lookup</a> API to <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a>.</p> |
| <p>This adapter differs from <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a> in that it attempts |
| to discretize any "weights" as passed from in <a class="xref" href="Lucene.Net.Search.Suggest.IInputIterator.html#Lucene_Net_Search_Suggest_IInputIterator_Weight">Weight</a> |
| to match the number of buckets. For the rationale for bucketing, see |
| <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a>. |
| |
| </p> |
| <p><strong>Note:</strong>Discretization requires an additional sorting pass. |
| |
| </p> |
| <p>The range of weights for bucketing/ discretization is determined |
| by sorting the input by weight and then dividing into |
| equal ranges. Then, scores within each range are assigned to that bucket. |
| |
| </p> |
| <p>Note that this means that even large differences in weights may be lost |
| during automaton construction, but the overall distinction between "classes" |
| of weights will be preserved regardless of the distribution of weights. |
| |
| </p> |
| <p>For fine-grained control over which weights are assigned to which buckets, |
| use <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a> directly or <a class="xref" href="Lucene.Net.Search.Suggest.Tst.TSTLookup.html">TSTLookup</a>, for example. |
| |
| </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"><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html">Lookup</a></div> |
| <div class="level2"><span class="xref">FSTCompletionLookup</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_CHARSEQUENCE_COMPARER">Lookup.CHARSEQUENCE_COMPARER</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Spell_IDictionary_">Lookup.Build(IDictionary)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Load_System_IO_Stream_">Lookup.Load(Stream)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Store_System_IO_Stream_">Lookup.Store(Stream)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Boolean_System_Int32_">Lookup.DoLookup(String, Boolean, Int32)</a> |
| </div> |
| <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.Fst.html">Lucene.Net.Search.Suggest.Fst</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6> |
| <h5 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class FSTCompletionLookup : Lookup</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L101">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor">FSTCompletionLookup()</h4> |
| <div class="markdown level1 summary"><p>This constructor prepares for creating a suggested FST using the |
| <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.html#Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Build_Lucene_Net_Search_Suggest_IInputIterator_">Build(IInputIterator)</a> method. The number of weight |
| discretization buckets is set to <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html#Lucene_Net_Search_Suggest_Fst_FSTCompletion_DEFAULT_BUCKETS">DEFAULT_BUCKETS</a> and |
| exact matches are promoted to the top of the suggestions list.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FSTCompletionLookup()</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_Lucene_Net_Search_Suggest_Fst_FSTCompletion_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.%23ctor(Lucene.Net.Search.Suggest.Fst.FSTCompletion%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L133">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_Lucene_Net_Search_Suggest_Fst_FSTCompletion_System_Boolean_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor(Lucene.Net.Search.Suggest.Fst.FSTCompletion,System.Boolean)">FSTCompletionLookup(FSTCompletion, Boolean)</h4> |
| <div class="markdown level1 summary"><p>This constructor takes a pre-built automaton.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FSTCompletionLookup(FSTCompletion completion, bool exactMatchFirst)</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.Fst.FSTCompletion.html">FSTCompletion</a></td> |
| <td><span class="parametername">completion</span></td> |
| <td><p>An instance of <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">exactMatchFirst</span></td> |
| <td><p>If <pre><code>true</code></pre> exact matches are promoted to the top of the |
| suggestions list. Otherwise they appear in the order of |
| discretized weight and alphabetical within the bucket. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.%23ctor(System.Int32%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L118">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup__ctor_System_Int32_System_Boolean_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.#ctor(System.Int32,System.Boolean)">FSTCompletionLookup(Int32, Boolean)</h4> |
| <div class="markdown level1 summary"><p>This constructor prepares for creating a suggested FST using the |
| <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.html#Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Build_Lucene_Net_Search_Suggest_IInputIterator_">Build(IInputIterator)</a> method.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FSTCompletionLookup(int buckets, bool exactMatchFirst)</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.Int32</span></td> |
| <td><span class="parametername">buckets</span></td> |
| <td><p>The number of weight discretization buckets (see |
| <a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a> for details).</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">exactMatchFirst</span></td> |
| <td><p>If <code>true</code> exact matches are promoted to the top of the |
| suggestions list. Otherwise they appear in the order of |
| discretized weight and alphabetical within the bucket. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Count.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Count%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L331">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Count_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Count*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Count" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Count">Count</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 override long Count { 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Count">Lookup.Count</a></div> |
| <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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Build_Lucene_Net_Search_Suggest_IInputIterator_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Build(Lucene.Net.Search.Suggest.IInputIterator)%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L140">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Build_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Build*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Build_Lucene_Net_Search_Suggest_IInputIterator_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Build(Lucene.Net.Search.Suggest.IInputIterator)">Build(IInputIterator)</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 override void Build(IInputIterator iterator)</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.IInputIterator.html">IInputIterator</a></td> |
| <td><span class="parametername">iterator</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Suggest_IInputIterator_">Lookup.Build(IInputIterator)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.DoLookup(System.String%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D%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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L254">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.DoLookup(System.String,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef},System.Boolean,System.Int32)">DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</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 override IList<Lookup.LookupResult> DoLookup(string key, IEnumerable<BytesRef> contexts, bool higherWeightsFirst, int num)</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></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Lucene.Net.Util.BytesRef</span>></td> |
| <td><span class="parametername">contexts</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">higherWeightsFirst</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_">Lookup.DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Get_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L285">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Get_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Get*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Get_System_String_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Get(System.String)">Get(String)</h4> |
| <div class="markdown level1 summary"><p>Returns the bucket (weight) as a Long for the provided key if it exists, |
| otherwise null if it does not.</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></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></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_GetSizeInBytes.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L316">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_GetSizeInBytes_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.GetSizeInBytes*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_GetSizeInBytes" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.GetSizeInBytes">GetSizeInBytes()</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 override 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_GetSizeInBytes">Lookup.GetSizeInBytes()</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Load_Lucene_Net_Store_DataInput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Load(Lucene.Net.Store.DataInput)%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L305">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Load_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Load*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Load_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Load(Lucene.Net.Store.DataInput)">Load(DataInput)</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 override bool Load(DataInput input)</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">Lucene.Net.Store.DataInput</span></td> |
| <td><span class="parametername">input</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Load_Lucene_Net_Store_DataInput_">Lookup.Load(DataInput)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Store_Lucene_Net_Store_DataOutput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Store(Lucene.Net.Store.DataOutput)%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L291">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Store_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Store*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup_Store_Lucene_Net_Store_DataOutput_" data-uid="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.Store(Lucene.Net.Store.DataOutput)">Store(DataOutput)</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 override bool Store(DataOutput 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><span class="xref">Lucene.Net.Store.DataOutput</span></td> |
| <td><span class="parametername">output</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Store_Lucene_Net_Store_DataOutput_">Lookup.Store(DataOutput)</a></div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletion.html">FSTCompletion</a></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Fst_FSTCompletionLookup.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup%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_beta00011/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs/#L58" 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> |
