| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class TopGroups<TGroupValue> |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class TopGroups<TGroupValue> |
| | 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="grouping/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.Grouping.TopGroups`1"> |
| |
| |
| <h1 id="Lucene_Net_Search_Grouping_TopGroups_1" data-uid="Lucene.Net.Search.Grouping.TopGroups`1" class="text-break">Class TopGroups<TGroupValue> |
| </h1> |
| <div class="markdown level0 summary"><p>Represents result returned by a grouping search.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><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"><span class="xref">TopGroups<TGroupValue></span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups</a><TGroupValue></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.Grouping.html">Lucene.Net.Search.Grouping</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Grouping.dll</h6> |
| <h5 id="Lucene_Net_Search_Grouping_TopGroups_1_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class TopGroups<TGroupValue> : ITopGroups<TGroupValue></code></pre> |
| </div> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">TGroupValue</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_TopGroups_1__ctor_Lucene_Net_Search_Grouping_ITopGroups__0__System_Nullable_System_Int32__.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.%23ctor(Lucene.Net.Search.Grouping.ITopGroups%7B%600%7D%2CSystem.Nullable%7BSystem.Int32%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.Grouping/TopGroups.cs/#L80">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1__ctor_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1__ctor_Lucene_Net_Search_Grouping_ITopGroups__0__System_Nullable_System_Int32__" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.#ctor(Lucene.Net.Search.Grouping.ITopGroups{`0},System.Nullable{System.Int32})">TopGroups(ITopGroups<TGroupValue>, Nullable<Int32>)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TopGroups(ITopGroups<TGroupValue> oldTopGroups, int? totalGroupCount)</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.Grouping.ITopGroups-1.html">ITopGroups</a><TGroupValue></td> |
| <td><span class="parametername">oldTopGroups</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><span class="parametername">totalGroupCount</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_Grouping_TopGroups_1__ctor_Lucene_Net_Search_SortField___Lucene_Net_Search_SortField___System_Int32_System_Int32_Lucene_Net_Search_Grouping_IGroupDocs__0____System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.%23ctor(Lucene.Net.Search.SortField%5B%5D%2CLucene.Net.Search.SortField%5B%5D%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Search.Grouping.IGroupDocs%7B%600%7D%5B%5D%2CSystem.Single)%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.Grouping/TopGroups.cs/#L69">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1__ctor_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1__ctor_Lucene_Net_Search_SortField___Lucene_Net_Search_SortField___System_Int32_System_Int32_Lucene_Net_Search_Grouping_IGroupDocs__0____System_Single_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.#ctor(Lucene.Net.Search.SortField[],Lucene.Net.Search.SortField[],System.Int32,System.Int32,Lucene.Net.Search.Grouping.IGroupDocs{`0}[],System.Single)">TopGroups(SortField[], SortField[], Int32, Int32, IGroupDocs<TGroupValue>[], Single)</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 TopGroups(SortField[] groupSort, SortField[] withinGroupSort, int totalHitCount, int totalGroupedHitCount, IGroupDocs<TGroupValue>[] groups, float maxScore)</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="https://lucenenet.apache.org/docs/4.8.0-beta00009/api/core/Lucene.Net.Search.SortField.html">SortField</a>[]</td> |
| <td><span class="parametername">groupSort</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/api/core/Lucene.Net.Search.SortField.html">SortField</a>[]</td> |
| <td><span class="parametername">withinGroupSort</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">totalHitCount</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">totalGroupedHitCount</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Grouping.IGroupDocs-1.html">IGroupDocs</a><TGroupValue>[]</td> |
| <td><span class="parametername">groups</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">maxScore</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_Grouping_TopGroups_1_Groups.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.Groups%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.Grouping/TopGroups.cs/#L47">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_Groups_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.Groups*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_Groups" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.Groups">Groups</h4> |
| <div class="markdown level1 summary"><p>Group results in groupSort order </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IGroupDocs<TGroupValue>[] Groups { 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.Grouping.IGroupDocs-1.html">IGroupDocs</a><TGroupValue>[]</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_Grouping_TopGroups_1_GroupSort.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.GroupSort%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.Grouping/TopGroups.cs/#L53">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_GroupSort_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.GroupSort*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_GroupSort" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.GroupSort">GroupSort</h4> |
| <div class="markdown level1 summary"><p>How groups are sorted against each other </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField[] GroupSort { 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="https://lucenenet.apache.org/docs/4.8.0-beta00009/api/core/Lucene.Net.Search.SortField.html">SortField</a>[]</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_Grouping_TopGroups_1_MaxScore.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.MaxScore%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.Grouping/TopGroups.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_MaxScore_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.MaxScore*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_MaxScore" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.MaxScore">MaxScore</h4> |
| <div class="markdown level1 summary"><p>Highest score across all hits, or |
| <span class="xref">System.Single.NaN</span> if scores were not computed. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public float MaxScore { 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.Single</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_Grouping_TopGroups_1_TotalGroupCount.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.TotalGroupCount%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.Grouping/TopGroups.cs/#L43">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_TotalGroupCount_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalGroupCount*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_TotalGroupCount" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalGroupCount">TotalGroupCount</h4> |
| <div class="markdown level1 summary"><p>The total number of unique groups. If <code>null</code> this value is not computed. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int? TotalGroupCount { 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.Nullable</span><<span class="xref">System.Int32</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_Grouping_TopGroups_1_TotalGroupedHitCount.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.TotalGroupedHitCount%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.Grouping/TopGroups.cs/#L39">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_TotalGroupedHitCount_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalGroupedHitCount*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_TotalGroupedHitCount" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalGroupedHitCount">TotalGroupedHitCount</h4> |
| <div class="markdown level1 summary"><p>Number of documents grouped into the topN groups </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int TotalGroupedHitCount { 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> |
| <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_Grouping_TopGroups_1_TotalHitCount.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.TotalHitCount%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.Grouping/TopGroups.cs/#L35">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_TotalHitCount_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalHitCount*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_TotalHitCount" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.TotalHitCount">TotalHitCount</h4> |
| <div class="markdown level1 summary"><p>Number of documents matching the search </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int TotalHitCount { 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> |
| <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_Grouping_TopGroups_1_WithinGroupSort.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601.WithinGroupSort%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.Grouping/TopGroups.cs/#L59">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Grouping_TopGroups_1_WithinGroupSort_" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.WithinGroupSort*"></a> |
| <h4 id="Lucene_Net_Search_Grouping_TopGroups_1_WithinGroupSort" data-uid="Lucene.Net.Search.Grouping.TopGroups`1.WithinGroupSort">WithinGroupSort</h4> |
| <div class="markdown level1 summary"><p>How docs are sorted within each group </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortField[] WithinGroupSort { 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="https://lucenenet.apache.org/docs/4.8.0-beta00009/api/core/Lucene.Net.Search.SortField.html">SortField</a>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Grouping.ITopGroups-1.html">ITopGroups<TGroupValue></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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Grouping_TopGroups_1.md&value=---%0Auid%3A%20Lucene.Net.Search.Grouping.TopGroups%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/docs-poc/src/Lucene.Net.Grouping/TopGroups.cs/#L31" 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> |