| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class TopFieldCollector |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class TopFieldCollector |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Search.TopFieldCollector"> |
| |
| |
| <h1 id="Lucene_Net_Search_TopFieldCollector" data-uid="Lucene.Net.Search.TopFieldCollector" class="text-break">Class TopFieldCollector |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Search.ICollector.html">ICollector</a> that sorts by <a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a> using |
| <a class="xref" href="Lucene.Net.Search.FieldComparer.html">FieldComparer</a>s. |
| <p> |
| See the <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html#Lucene_Net_Search_TopFieldCollector_Create_Lucene_Net_Search_Sort_System_Int32_System_Boolean_System_Boolean_System_Boolean_System_Boolean_">Create(Sort, Int32, Boolean, Boolean, Boolean, Boolean)</a> method |
| for instantiating a <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a>. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html">TopDocsCollector</a><<a class="xref" href="Lucene.Net.Search.FieldValueHitQueue.Entry.html">FieldValueHitQueue.Entry</a>></div> |
| <div class="level2"><span class="xref">TopFieldCollector</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Search.ITopDocsCollector.html">ITopDocsCollector</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.ICollector.html">ICollector</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_EMPTY_TOPDOCS">TopDocsCollector<FieldValueHitQueue.Entry>.EMPTY_TOPDOCS</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_m_pq">TopDocsCollector<FieldValueHitQueue.Entry>.m_pq</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_m_totalHits">TopDocsCollector<FieldValueHitQueue.Entry>.m_totalHits</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_TotalHits">TopDocsCollector<FieldValueHitQueue.Entry>.TotalHits</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_TopDocsCount">TopDocsCollector<FieldValueHitQueue.Entry>.TopDocsCount</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_GetTopDocs">TopDocsCollector<FieldValueHitQueue.Entry>.GetTopDocs()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_GetTopDocs_System_Int32_">TopDocsCollector<FieldValueHitQueue.Entry>.GetTopDocs(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_GetTopDocs_System_Int32_System_Int32_">TopDocsCollector<FieldValueHitQueue.Entry>.GetTopDocs(Int32, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_SetScorer_Lucene_Net_Search_Scorer_">TopDocsCollector<FieldValueHitQueue.Entry>.SetScorer(Scorer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_Collect_System_Int32_">TopDocsCollector<FieldValueHitQueue.Entry>.Collect(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopDocsCollector-1.html#Lucene_Net_Search_TopDocsCollector_1_SetNextReader_Lucene_Net_Index_AtomicReaderContext_">TopDocsCollector<FieldValueHitQueue.Entry>.SetNextReader(AtomicReaderContext)</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.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_TopFieldCollector_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class TopFieldCollector : TopDocsCollector<FieldValueHitQueue.Entry>, ITopDocsCollector, ICollector</code></pre> |
| </div> |
| <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_TopFieldCollector_AcceptsDocsOutOfOrder.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector.AcceptsDocsOutOfOrder%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/Search/TopFieldCollector.cs/#L1379">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_TopFieldCollector_AcceptsDocsOutOfOrder_" data-uid="Lucene.Net.Search.TopFieldCollector.AcceptsDocsOutOfOrder*"></a> |
| <h4 id="Lucene_Net_Search_TopFieldCollector_AcceptsDocsOutOfOrder" data-uid="Lucene.Net.Search.TopFieldCollector.AcceptsDocsOutOfOrder">AcceptsDocsOutOfOrder</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 AcceptsDocsOutOfOrder { 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><span class="xref">Lucene.Net.Search.TopDocsCollector<Lucene.Net.Search.FieldValueHitQueue.Entry>.AcceptsDocsOutOfOrder</span></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_TopFieldCollector_Create_Lucene_Net_Search_Sort_System_Int32_Lucene_Net_Search_FieldDoc_System_Boolean_System_Boolean_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector.Create(Lucene.Net.Search.Sort%2CSystem.Int32%2CLucene.Net.Search.FieldDoc%2CSystem.Boolean%2CSystem.Boolean%2CSystem.Boolean%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/fix/apidocs-layout/src/Lucene.Net/Search/TopFieldCollector.cs/#L1236">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_TopFieldCollector_Create_" data-uid="Lucene.Net.Search.TopFieldCollector.Create*"></a> |
| <h4 id="Lucene_Net_Search_TopFieldCollector_Create_Lucene_Net_Search_Sort_System_Int32_Lucene_Net_Search_FieldDoc_System_Boolean_System_Boolean_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.TopFieldCollector.Create(Lucene.Net.Search.Sort,System.Int32,Lucene.Net.Search.FieldDoc,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">Create(Sort, Int32, FieldDoc, Boolean, Boolean, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a> from the given |
| arguments.</p> |
| <p><p><strong>NOTE</strong>: The instances returned by this method |
| pre-allocate a full array of length |
| <code data-dev-comment-type="paramref" class="paramref">numHits</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TopFieldCollector Create(Sort sort, int numHits, FieldDoc after, bool fillFields, bool trackDocScores, bool trackMaxScore, bool docsScoredInOrder)</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.Sort.html">Sort</a></td> |
| <td><span class="parametername">sort</span></td> |
| <td><p>The sort criteria (<a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a>s). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numHits</span></td> |
| <td><p>The number of results to collect. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.FieldDoc.html">FieldDoc</a></td> |
| <td><span class="parametername">after</span></td> |
| <td><p>Only hits after this <a class="xref" href="Lucene.Net.Search.FieldDoc.html">FieldDoc</a> will be collected </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">fillFields</span></td> |
| <td><p>Specifies whether the actual field values should be returned on |
| the results (<a class="xref" href="Lucene.Net.Search.FieldDoc.html">FieldDoc</a>). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">trackDocScores</span></td> |
| <td><p>Specifies whether document scores should be tracked and set on the |
| results. Note that if set to <code>false</code>, then the results' scores will |
| be set to <span class="xref">System.Single.NaN</span>. Setting this to <code>true</code> affects performance, as |
| it incurs the score computation on each competitive result. |
| Therefore if document scores are not required by the application, |
| it is recommended to set it to <code>false</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">trackMaxScore</span></td> |
| <td><p>Specifies whether the query's maxScore should be tracked and set |
| on the resulting <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a>. Note that if set to <code>false</code>, |
| <a class="xref" href="Lucene.Net.Search.TopDocs.html#Lucene_Net_Search_TopDocs_MaxScore">MaxScore</a> returns <span class="xref">System.Single.NaN</span>. Setting this to |
| <code>true</code> affects performance as it incurs the score computation on |
| each result. Also, setting this <code>true</code> automatically sets |
| <code data-dev-comment-type="paramref" class="paramref">trackDocScores</code> to <code>true</code> as well. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">docsScoredInOrder</span></td> |
| <td><p>Specifies whether documents are scored in doc Id order or not by |
| the given <a class="xref" href="Lucene.Net.Search.Scorer.html">Scorer</a> in <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_SetScorer_Lucene_Net_Search_Scorer_">SetScorer(Scorer)</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a> instance which will sort the results by |
| the sort criteria. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_TopFieldCollector_Create_Lucene_Net_Search_Sort_System_Int32_System_Boolean_System_Boolean_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector.Create(Lucene.Net.Search.Sort%2CSystem.Int32%2CSystem.Boolean%2CSystem.Boolean%2CSystem.Boolean%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/fix/apidocs-layout/src/Lucene.Net/Search/TopFieldCollector.cs/#L1194">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_TopFieldCollector_Create_" data-uid="Lucene.Net.Search.TopFieldCollector.Create*"></a> |
| <h4 id="Lucene_Net_Search_TopFieldCollector_Create_Lucene_Net_Search_Sort_System_Int32_System_Boolean_System_Boolean_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.TopFieldCollector.Create(Lucene.Net.Search.Sort,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">Create(Sort, Int32, Boolean, Boolean, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a> from the given |
| arguments.</p> |
| <p><p><strong>NOTE</strong>: The instances returned by this method |
| pre-allocate a full array of length |
| <code data-dev-comment-type="paramref" class="paramref">numHits</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TopFieldCollector Create(Sort sort, int numHits, bool fillFields, bool trackDocScores, bool trackMaxScore, bool docsScoredInOrder)</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.Sort.html">Sort</a></td> |
| <td><span class="parametername">sort</span></td> |
| <td><p>The sort criteria (<a class="xref" href="Lucene.Net.Search.SortField.html">SortField</a>s). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numHits</span></td> |
| <td><p>The number of results to collect. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">fillFields</span></td> |
| <td><p>Specifies whether the actual field values should be returned on |
| the results (<a class="xref" href="Lucene.Net.Search.FieldDoc.html">FieldDoc</a>). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">trackDocScores</span></td> |
| <td><p>Specifies whether document scores should be tracked and set on the |
| results. Note that if set to <code>false</code>, then the results' scores will |
| be set to <span class="xref">System.Single.NaN</span>. Setting this to <code>true</code> affects performance, as |
| it incurs the score computation on each competitive result. |
| Therefore if document scores are not required by the application, |
| it is recommended to set it to <code>false</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">trackMaxScore</span></td> |
| <td><p>Specifies whether the query's <span class="xref">Lucene.Net.Search.TopFieldCollector.maxScore</span> should be tracked and set |
| on the resulting <a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a>. Note that if set to <code>false</code>, |
| <a class="xref" href="Lucene.Net.Search.TopDocs.html#Lucene_Net_Search_TopDocs_MaxScore">MaxScore</a> returns <span class="xref">System.Single.NaN</span>. Setting this to |
| <code>true</code> affects performance as it incurs the score computation on |
| each result. Also, setting this <code>true</code> automatically sets |
| <code data-dev-comment-type="paramref" class="paramref">trackDocScores</code> to <code>true</code> as well. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">docsScoredInOrder</span></td> |
| <td><p>Specifies whether documents are scored in doc Id order or not by |
| the given <a class="xref" href="Lucene.Net.Search.Scorer.html">Scorer</a> in <a class="xref" href="Lucene.Net.Search.ICollector.html#Lucene_Net_Search_ICollector_SetScorer_Lucene_Net_Search_Scorer_">SetScorer(Scorer)</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Search.TopFieldCollector.html">TopFieldCollector</a> instance which will sort the results by |
| the sort criteria. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_TopFieldCollector_NewTopDocs_Lucene_Net_Search_ScoreDoc___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector.NewTopDocs(Lucene.Net.Search.ScoreDoc%5B%5D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Search/TopFieldCollector.cs/#L1366">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_TopFieldCollector_NewTopDocs_" data-uid="Lucene.Net.Search.TopFieldCollector.NewTopDocs*"></a> |
| <h4 id="Lucene_Net_Search_TopFieldCollector_NewTopDocs_Lucene_Net_Search_ScoreDoc___System_Int32_" data-uid="Lucene.Net.Search.TopFieldCollector.NewTopDocs(Lucene.Net.Search.ScoreDoc[],System.Int32)">NewTopDocs(ScoreDoc[], 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">protected override TopDocs NewTopDocs(ScoreDoc[] results, int start)</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.ScoreDoc.html">ScoreDoc</a>[]</td> |
| <td><span class="parametername">results</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">start</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><a class="xref" href="Lucene.Net.Search.TopDocs.html">TopDocs</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.TopDocsCollector<Lucene.Net.Search.FieldValueHitQueue.Entry>.NewTopDocs(Lucene.Net.Search.ScoreDoc[], System.Int32)</span></div> |
| <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_TopFieldCollector_PopulateResults_Lucene_Net_Search_ScoreDoc___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector.PopulateResults(Lucene.Net.Search.ScoreDoc%5B%5D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Search/TopFieldCollector.cs/#L1345">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_TopFieldCollector_PopulateResults_" data-uid="Lucene.Net.Search.TopFieldCollector.PopulateResults*"></a> |
| <h4 id="Lucene_Net_Search_TopFieldCollector_PopulateResults_Lucene_Net_Search_ScoreDoc___System_Int32_" data-uid="Lucene.Net.Search.TopFieldCollector.PopulateResults(Lucene.Net.Search.ScoreDoc[],System.Int32)">PopulateResults(ScoreDoc[], 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">protected override void PopulateResults(ScoreDoc[] results, int howMany)</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.ScoreDoc.html">ScoreDoc</a>[]</td> |
| <td><span class="parametername">results</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">howMany</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.TopDocsCollector<Lucene.Net.Search.FieldValueHitQueue.Entry>.PopulateResults(Lucene.Net.Search.ScoreDoc[], System.Int32)</span></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ITopDocsCollector.html">ITopDocsCollector</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.ICollector.html">ICollector</a> |
| </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_TopFieldCollector.md&value=---%0Auid%3A%20Lucene.Net.Search.TopFieldCollector%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/Search/TopFieldCollector.cs/#L37" 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> |
