blob: 3f510bb2da99312d8166b55c6d88a56e9620f6a7 [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 SortedInputEnumerator
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SortedInputEnumerator
| 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="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">
<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.Search.Suggest.SortedInputEnumerator">
<h1 id="Lucene_Net_Search_Suggest_SortedInputEnumerator" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator" class="text-break">Class SortedInputEnumerator
</h1>
<div class="markdown level0 summary"><p>This wrapper buffers incoming elements and makes sure they are sorted based on given comparer.
<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"><span class="xref">SortedInputEnumerator</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Lucene.Net.Search.Suggest.IInputEnumerator.html">IInputEnumerator</a></div>
<div><span class="xref">Lucene.Net.Util.IBytesRefEnumerator</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.html">Lucene.Net.Search.Suggest</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6>
<h5 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SortedInputEnumerator : IInputEnumerator, IBytesRefEnumerator</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_SortedInputEnumerator__ctor_Lucene_Net_Search_Suggest_IInputEnumerator_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.%23ctor(Lucene.Net.Search.Suggest.IInputEnumerator)%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.Suggest/Suggest/SortedInputIterator.cs/#L56">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator__ctor_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator__ctor_Lucene_Net_Search_Suggest_IInputEnumerator_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.#ctor(Lucene.Net.Search.Suggest.IInputEnumerator)">SortedInputEnumerator(IInputEnumerator)</h4>
<div class="markdown level1 summary"><p>Creates a new sorted wrapper, using <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Util.BytesRef.html#Lucene_Net_Util_BytesRef_UTF8SortedAsUnicodeComparer">UTF8SortedAsUnicodeComparer</a>
for sorting. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedInputEnumerator(IInputEnumerator source)</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.IInputEnumerator.html">IInputEnumerator</a></td>
<td><span class="parametername">source</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_Search_Suggest_SortedInputEnumerator__ctor_Lucene_Net_Search_Suggest_IInputEnumerator_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.%23ctor(Lucene.Net.Search.Suggest.IInputEnumerator%2CSystem.Collections.Generic.IComparer%7BLucene.Net.Util.BytesRef%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.Suggest/Suggest/SortedInputIterator.cs/#L65">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator__ctor_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator__ctor_Lucene_Net_Search_Suggest_IInputEnumerator_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.#ctor(Lucene.Net.Search.Suggest.IInputEnumerator,System.Collections.Generic.IComparer{Lucene.Net.Util.BytesRef})">SortedInputEnumerator(IInputEnumerator, IComparer&lt;BytesRef&gt;)</h4>
<div class="markdown level1 summary"><p>Creates a new sorted wrapper, sorting by BytesRef
(ascending) then cost (ascending).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedInputEnumerator(IInputEnumerator source, IComparer&lt;BytesRef&gt; comparer)</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.IInputEnumerator.html">IInputEnumerator</a></td>
<td><span class="parametername">source</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IComparer</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td><span class="parametername">comparer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_SortedInputEnumerator_Comparer.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Comparer%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.Suggest/Suggest/SortedInputIterator.cs/#L177">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Comparer_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Comparer*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Comparer" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Comparer">Comparer</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 IComparer&lt;BytesRef&gt; Comparer { 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.Collections.Generic.IComparer</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</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_Search_Suggest_SortedInputEnumerator_Contexts.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Contexts%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.Suggest/Suggest/SortedInputIterator.cs/#L175">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Contexts_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Contexts*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Contexts" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Contexts">Contexts</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 ICollection&lt;BytesRef&gt; Contexts { 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.Collections.Generic.ICollection</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</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_Search_Suggest_SortedInputEnumerator_Current.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Current%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.Suggest/Suggest/SortedInputIterator.cs/#L118">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Current_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Current*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Current" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Current">Current</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 BytesRef Current { 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">Lucene.Net.Util.BytesRef</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_Search_Suggest_SortedInputEnumerator_HasContexts.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.HasContexts%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.Suggest/Suggest/SortedInputIterator.cs/#L179">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_HasContexts_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.HasContexts*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_HasContexts" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.HasContexts">HasContexts</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 bool HasContexts { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_SortedInputEnumerator_HasPayloads.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.HasPayloads%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.Suggest/Suggest/SortedInputIterator.cs/#L173">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_HasPayloads_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.HasPayloads*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_HasPayloads" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.HasPayloads">HasPayloads</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 bool HasPayloads { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_SortedInputEnumerator_Payload.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Payload%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.Suggest/Suggest/SortedInputIterator.cs/#L161">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Payload_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Payload*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Payload" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Payload">Payload</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 BytesRef Payload { 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">Lucene.Net.Util.BytesRef</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_Search_Suggest_SortedInputEnumerator_Weight.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Weight%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.Suggest/Suggest/SortedInputIterator.cs/#L159">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Weight_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Weight*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Weight" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Weight">Weight</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 Weight { 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_Search_Suggest_SortedInputEnumerator_Decode_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Decode(Lucene.Net.Util.BytesRef%2CLucene.Net.Store.ByteArrayDataInput)%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.Suggest/Suggest/SortedInputIterator.cs/#L284">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Decode_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Decode*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Decode_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Decode(Lucene.Net.Util.BytesRef,Lucene.Net.Store.ByteArrayDataInput)">Decode(BytesRef, ByteArrayDataInput)</h4>
<div class="markdown level1 summary"><p>decodes the weight at the current position </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual long Decode(BytesRef scratch, ByteArrayDataInput tmpInput)</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.Util.BytesRef</span></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Store.ByteArrayDataInput</span></td>
<td><span class="parametername">tmpInput</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.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_Search_Suggest_SortedInputEnumerator_DecodeContexts_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodeContexts(Lucene.Net.Util.BytesRef%2CLucene.Net.Store.ByteArrayDataInput)%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.Suggest/Suggest/SortedInputIterator.cs/#L294">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_DecodeContexts_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodeContexts*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_DecodeContexts_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodeContexts(Lucene.Net.Util.BytesRef,Lucene.Net.Store.ByteArrayDataInput)">DecodeContexts(BytesRef, ByteArrayDataInput)</h4>
<div class="markdown level1 summary"><p>decodes the contexts at the current position </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual ISet&lt;BytesRef&gt; DecodeContexts(BytesRef scratch, ByteArrayDataInput tmpInput)</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.Util.BytesRef</span></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Store.ByteArrayDataInput</span></td>
<td><span class="parametername">tmpInput</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.ISet</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</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_Search_Suggest_SortedInputEnumerator_DecodePayload_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodePayload(Lucene.Net.Util.BytesRef%2CLucene.Net.Store.ByteArrayDataInput)%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.Suggest/Suggest/SortedInputIterator.cs/#L326">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_DecodePayload_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodePayload*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_DecodePayload_Lucene_Net_Util_BytesRef_Lucene_Net_Store_ByteArrayDataInput_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.DecodePayload(Lucene.Net.Util.BytesRef,Lucene.Net.Store.ByteArrayDataInput)">DecodePayload(BytesRef, ByteArrayDataInput)</h4>
<div class="markdown level1 summary"><p>decodes the payload at the current position</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual BytesRef DecodePayload(BytesRef scratch, ByteArrayDataInput tmpInput)</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.Util.BytesRef</span></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Store.ByteArrayDataInput</span></td>
<td><span class="parametername">tmpInput</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">Lucene.Net.Util.BytesRef</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_Search_Suggest_SortedInputEnumerator_Encode_Lucene_Net_Util_OfflineSorter_ByteSequencesWriter_Lucene_Net_Store_ByteArrayDataOutput_System_Byte___Lucene_Net_Util_BytesRef_Lucene_Net_Util_BytesRef_System_Collections_Generic_ICollection_Lucene_Net_Util_BytesRef__System_Int64_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.Encode(Lucene.Net.Util.OfflineSorter.ByteSequencesWriter%2CLucene.Net.Store.ByteArrayDataOutput%2CSystem.Byte%5B%5D%2CLucene.Net.Util.BytesRef%2CLucene.Net.Util.BytesRef%2CSystem.Collections.Generic.ICollection%7BLucene.Net.Util.BytesRef%7D%2CSystem.Int64)%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.Suggest/Suggest/SortedInputIterator.cs/#L245">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Encode_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Encode*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_Encode_Lucene_Net_Util_OfflineSorter_ByteSequencesWriter_Lucene_Net_Store_ByteArrayDataOutput_System_Byte___Lucene_Net_Util_BytesRef_Lucene_Net_Util_BytesRef_System_Collections_Generic_ICollection_Lucene_Net_Util_BytesRef__System_Int64_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.Encode(Lucene.Net.Util.OfflineSorter.ByteSequencesWriter,Lucene.Net.Store.ByteArrayDataOutput,System.Byte[],Lucene.Net.Util.BytesRef,Lucene.Net.Util.BytesRef,System.Collections.Generic.ICollection{Lucene.Net.Util.BytesRef},System.Int64)">Encode(OfflineSorter.ByteSequencesWriter, ByteArrayDataOutput, Byte[], BytesRef, BytesRef, ICollection&lt;BytesRef&gt;, Int64)</h4>
<div class="markdown level1 summary"><p>encodes an entry (bytes+(contexts)+(payload)+weight) to the provided writer</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual void Encode(OfflineSorter.ByteSequencesWriter writer, ByteArrayDataOutput output, byte[] buffer, BytesRef spare, BytesRef payload, ICollection&lt;BytesRef&gt; contexts, long weight)</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.Util.OfflineSorter.ByteSequencesWriter</span></td>
<td><span class="parametername">writer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Store.ByteArrayDataOutput</span></td>
<td><span class="parametername">output</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">spare</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">payload</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.ICollection</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td><span class="parametername">contexts</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">weight</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_Search_Suggest_SortedInputEnumerator_MoveNext.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator.MoveNext%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.Suggest/Suggest/SortedInputIterator.cs/#L120">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_SortedInputEnumerator_MoveNext_" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.MoveNext*"></a>
<h4 id="Lucene_Net_Search_Suggest_SortedInputEnumerator_MoveNext" data-uid="Lucene.Net.Search.Suggest.SortedInputEnumerator.MoveNext">MoveNext()</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 bool MoveNext()</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Lucene.Net.Search.Suggest.IInputEnumerator.html">IInputEnumerator</a>
</div>
<div>
<span class="xref">Lucene.Net.Util.IBytesRefEnumerator</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_SortedInputEnumerator.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.SortedInputEnumerator%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.Suggest/Suggest/SortedInputIterator.cs/#L35" 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>