| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class NearSpansOrdered |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class NearSpansOrdered |
| | Apache Lucene.NET 4.8.0-beta00009 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="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"> |
| <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.Spans.NearSpansOrdered"> |
| |
| |
| <h1 id="Lucene_Net_Search_Spans_NearSpansOrdered" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered" class="text-break">Class NearSpansOrdered |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Search.Spans.Spans.html">Spans</a> that is formed from the ordered subspans of a <a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html">SpanNearQuery</a> |
| where the subspans do not overlap and have a maximum slop between them. |
| <p> |
| The formed spans only contains minimum slop matches. |
| <p> |
| The matching slop is computed from the distance(s) between |
| the non overlapping matching <a class="xref" href="Lucene.Net.Search.Spans.Spans.html">Spans</a>. |
| <p> |
| Successive matches are always formed from the successive <a class="xref" href="Lucene.Net.Search.Spans.Spans.html">Spans</a> |
| of the <a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html">SpanNearQuery</a>. |
| <p> |
| The formed spans may contain overlaps when the slop is at least 1. |
| For example, when querying using |
| <code>t1 t2 t3</code> |
| with slop at least 1, the fragment: |
| <code>t1 t2 t1 t3 t2 t3</code> |
| matches twice: |
| <code>t1 t2 .. t3 </code> |
| <code> t1 .. t2 t3</code></p> |
| <p><p> |
| Expert: |
| Only public for subclassing. Most implementations should not need this class</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.Spans.Spans.html">Spans</a></div> |
| <div class="level2"><span class="xref">NearSpansOrdered</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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Spans.html">Lucene.Net.Search.Spans</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_Spans_NearSpansOrdered_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class NearSpansOrdered : Spans</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered__ctor_Lucene_Net_Search_Spans_SpanNearQuery_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_System_Collections_Generic_IDictionary_Lucene_Net_Index_Term_Lucene_Net_Index_TermContext__.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.%23ctor(Lucene.Net.Search.Spans.SpanNearQuery%2CLucene.Net.Index.AtomicReaderContext%2CLucene.Net.Util.IBits%2CSystem.Collections.Generic.IDictionary%7BLucene.Net.Index.Term%2CLucene.Net.Index.TermContext%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered__ctor_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered__ctor_Lucene_Net_Search_Spans_SpanNearQuery_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_System_Collections_Generic_IDictionary_Lucene_Net_Index_Term_Lucene_Net_Index_TermContext__" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.#ctor(Lucene.Net.Search.Spans.SpanNearQuery,Lucene.Net.Index.AtomicReaderContext,Lucene.Net.Util.IBits,System.Collections.Generic.IDictionary{Lucene.Net.Index.Term,Lucene.Net.Index.TermContext})">NearSpansOrdered(SpanNearQuery, AtomicReaderContext, IBits, IDictionary<Term, TermContext>)</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 NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, IBits acceptDocs, IDictionary<Term, TermContext> termContexts)</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.Spans.SpanNearQuery.html">SpanNearQuery</a></td> |
| <td><span class="parametername">spanNearQuery</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.AtomicReaderContext.html">AtomicReaderContext</a></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a></td> |
| <td><span class="parametername">acceptDocs</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<a class="xref" href="Lucene.Net.Index.Term.html">Term</a>, <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a>></td> |
| <td><span class="parametername">termContexts</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered__ctor_Lucene_Net_Search_Spans_SpanNearQuery_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_System_Collections_Generic_IDictionary_Lucene_Net_Index_Term_Lucene_Net_Index_TermContext__System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.%23ctor(Lucene.Net.Search.Spans.SpanNearQuery%2CLucene.Net.Index.AtomicReaderContext%2CLucene.Net.Util.IBits%2CSystem.Collections.Generic.IDictionary%7BLucene.Net.Index.Term%2CLucene.Net.Index.TermContext%7D%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L112">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered__ctor_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered__ctor_Lucene_Net_Search_Spans_SpanNearQuery_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_System_Collections_Generic_IDictionary_Lucene_Net_Index_Term_Lucene_Net_Index_TermContext__System_Boolean_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.#ctor(Lucene.Net.Search.Spans.SpanNearQuery,Lucene.Net.Index.AtomicReaderContext,Lucene.Net.Util.IBits,System.Collections.Generic.IDictionary{Lucene.Net.Index.Term,Lucene.Net.Index.TermContext},System.Boolean)">NearSpansOrdered(SpanNearQuery, AtomicReaderContext, IBits, IDictionary<Term, TermContext>, Boolean)</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 NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, IBits acceptDocs, IDictionary<Term, TermContext> termContexts, bool collectPayloads)</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.Spans.SpanNearQuery.html">SpanNearQuery</a></td> |
| <td><span class="parametername">spanNearQuery</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.AtomicReaderContext.html">AtomicReaderContext</a></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a></td> |
| <td><span class="parametername">acceptDocs</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<a class="xref" href="Lucene.Net.Index.Term.html">Term</a>, <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a>></td> |
| <td><span class="parametername">termContexts</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">collectPayloads</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_Doc.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.Doc%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L135">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_Doc_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Doc*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_Doc" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Doc">Doc</h4> |
| <div class="markdown level1 summary"><p>Returns the document number of the current match. Initially invalid. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int Doc { 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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_Doc">Spans.Doc</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_End.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.End%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L149">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_End_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.End*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_End" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.End">End</h4> |
| <div class="markdown level1 summary"><p>Returns the end position of the current match. Initially invalid. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int End { 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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_End">Spans.End</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_IsPayloadAvailable.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.IsPayloadAvailable%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L169">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_IsPayloadAvailable_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.IsPayloadAvailable*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_IsPayloadAvailable" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.IsPayloadAvailable">IsPayloadAvailable</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 IsPayloadAvailable { 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_IsPayloadAvailable">Spans.IsPayloadAvailable</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_Start.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.Start%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_Start_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Start*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_Start" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Start">Start</h4> |
| <div class="markdown level1 summary"><p>Returns the start position of the current match. Initially invalid. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int Start { 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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_Start">Spans.Start</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_SubSpans.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.SubSpans%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L154">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_SubSpans_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.SubSpans*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_SubSpans" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.SubSpans">SubSpans</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 Spans[] SubSpans { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Spans.Spans.html">Spans</a>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_GetCost.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.GetCost%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L177">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_GetCost_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.GetCost*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_GetCost" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.GetCost">GetCost()</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 GetCost()</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.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_GetCost">Spans.GetCost()</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_GetPayload.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.GetPayload%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L163">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_GetPayload_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.GetPayload*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_GetPayload" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.GetPayload">GetPayload()</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 ICollection<byte[]> GetPayload()</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.Collections.Generic.ICollection</span><<span class="xref">System.Byte</span>[]></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_GetPayload">Spans.GetPayload()</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_Next.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.Next%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L189">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_Next_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Next*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_Next" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.Next">Next()</h4> |
| <div class="markdown level1 summary"><p>Move to the next match, returning true iff any such exists. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool Next()</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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_Next">Spans.Next()</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_SkipTo_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.SkipTo(System.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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L233">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_SkipTo_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.SkipTo*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_SkipTo_System_Int32_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.SkipTo(System.Int32)">SkipTo(Int32)</h4> |
| <div class="markdown level1 summary"><p>Skips to the first match beyond the current, whose document number is |
| greater than or equal to <em>target</em>. |
| <p>The behavior of this method is <strong>undefined</strong> when called with |
| <code> target <= current</code>, or after the iterator has exhausted. |
| Both cases may result in unpredicted behavior. |
| <p>Returns <code>true</code> if there is such |
| a match.<br><p>Behaves as if written: </p> |
| <pre><code> bool SkipTo(int target) |
| { |
| do |
| { |
| if (!Next()) |
| return false; |
| } while (target > Doc); |
| return true; |
| }</code></pre> |
| <p>Most implementations are considerably more efficient than that.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool SkipTo(int target)</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">target</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.Spans.Spans.html#Lucene_Net_Search_Spans_Spans_SkipTo_System_Int32_">Spans.SkipTo(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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered_ToString.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered.ToString%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L454">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spans_NearSpansOrdered_ToString_" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.ToString*"></a> |
| <h4 id="Lucene_Net_Search_Spans_NearSpansOrdered_ToString" data-uid="Lucene.Net.Search.Spans.NearSpansOrdered.ToString">ToString()</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 string ToString()</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.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spans_NearSpansOrdered.md&value=---%0Auid%3A%20Lucene.Net.Search.Spans.NearSpansOrdered%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/docs-poc/src/Lucene.Net/Search/Spans/NearSpansOrdered.cs/#L59" 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> |