| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class RandomSamplingFacetsCollector |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class RandomSamplingFacetsCollector |
| | Apache Lucene.NET 4.8.0-beta00010 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="facet/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.Facet.RandomSamplingFacetsCollector"> |
| |
| |
| <h1 id="Lucene_Net_Facet_RandomSamplingFacetsCollector" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector" class="text-break">Class RandomSamplingFacetsCollector |
| </h1> |
| <div class="markdown level0 summary"><p>Collects hits for subsequent faceting, using sampling if needed. Once you've |
| run a search and collect hits into this, instantiate one of the |
| <a class="xref" href="Lucene.Net.Facet.Facets.html">Facets</a> subclasses to do the facet counting. Note that this collector |
| does not collect the scores of matching docs (i.e. |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html#Lucene_Net_Facet_FacetsCollector_MatchingDocs_Scores">Scores</a>) is <code>null</code>. |
| <p> |
| If you require the original set of hits, you can call |
| <a class="xref" href="Lucene.Net.Facet.RandomSamplingFacetsCollector.html#Lucene_Net_Facet_RandomSamplingFacetsCollector_GetOriginalMatchingDocs">GetOriginalMatchingDocs()</a>. Also, since the counts of the top-facets |
| is based on the sampled set, you can amortize the counts by calling |
| <a class="xref" href="Lucene.Net.Facet.RandomSamplingFacetsCollector.html#Lucene_Net_Facet_RandomSamplingFacetsCollector_AmortizeFacetCounts_Lucene_Net_Facet_FacetResult_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Search_IndexSearcher_">AmortizeFacetCounts(FacetResult, FacetsConfig, IndexSearcher)</a>. |
| </p></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.Facet.FacetsCollector.html">FacetsCollector</a></div> |
| <div class="level2"><span class="xref">RandomSamplingFacetsCollector</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">Lucene.Net.Search.ICollector</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_CreateDocs_System_Int32_">FacetsCollector.CreateDocs(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_KeepScores">FacetsCollector.KeepScores</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_AcceptsDocsOutOfOrder">FacetsCollector.AcceptsDocsOutOfOrder</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_Collect_System_Int32_">FacetsCollector.Collect(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SetScorer_Lucene_Net_Search_Scorer_">FacetsCollector.SetScorer(Scorer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SetNextReader_Lucene_Net_Index_AtomicReaderContext_">FacetsCollector.SetNextReader(AtomicReaderContext)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_System_Int32_Lucene_Net_Search_ICollector_">FacetsCollector.Search(IndexSearcher, Query, Int32, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_ICollector_">FacetsCollector.Search(IndexSearcher, Query, Filter, Int32, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_Sort_Lucene_Net_Search_ICollector_">FacetsCollector.Search(IndexSearcher, Query, Filter, Int32, Sort, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_Sort_System_Boolean_System_Boolean_Lucene_Net_Search_ICollector_">FacetsCollector.Search(IndexSearcher, Query, Filter, Int32, Sort, Boolean, Boolean, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SearchAfter_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_ScoreDoc_Lucene_Net_Search_Query_System_Int32_Lucene_Net_Search_ICollector_">FacetsCollector.SearchAfter(IndexSearcher, ScoreDoc, Query, Int32, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SearchAfter_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_ScoreDoc_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_ICollector_">FacetsCollector.SearchAfter(IndexSearcher, ScoreDoc, Query, Filter, Int32, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SearchAfter_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_ScoreDoc_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_Sort_Lucene_Net_Search_ICollector_">FacetsCollector.SearchAfter(IndexSearcher, ScoreDoc, Query, Filter, Int32, Sort, ICollector)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_SearchAfter_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_ScoreDoc_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_Sort_System_Boolean_System_Boolean_Lucene_Net_Search_ICollector_">FacetsCollector.SearchAfter(IndexSearcher, ScoreDoc, Query, Filter, Int32, Sort, Boolean, Boolean, ICollector)</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="package.html">Lucene.Net.Facet</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6> |
| <h5 id="Lucene_Net_Facet_RandomSamplingFacetsCollector_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class RandomSamplingFacetsCollector : FacetsCollector, ICollector</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.%23ctor(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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.#ctor(System.Int32)">RandomSamplingFacetsCollector(Int32)</h4> |
| <div class="markdown level1 summary"><p>Constructor with the given sample size and default seed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RandomSamplingFacetsCollector(int sampleSize)</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">sampleSize</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Facet.RandomSamplingFacetsCollector.html#Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32_System_Int64_">RandomSamplingFacetsCollector(Int32, Int64)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.%23ctor(System.Int32%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L121">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector__ctor_System_Int32_System_Int64_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.#ctor(System.Int32,System.Int64)">RandomSamplingFacetsCollector(Int32, Int64)</h4> |
| <div class="markdown level1 summary"><p>Constructor with the given sample size and seed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RandomSamplingFacetsCollector(int sampleSize, long seed)</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">sampleSize</span></td> |
| <td><p>The preferred sample size. If the number of hits is greater than |
| the size, sampling will be done using a sample ratio of sampling |
| size / totalN. For example: 1000 hits, sample size = 10 results in |
| samplingRatio of 0.01. If the number of hits is lower, no sampling |
| is done at all </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">seed</span></td> |
| <td><p>The random seed. If <code>0</code> then a seed will be chosen for you. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector_SamplingRate.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.SamplingRate%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L310">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector_SamplingRate_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.SamplingRate*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector_SamplingRate" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.SamplingRate">SamplingRate</h4> |
| <div class="markdown level1 summary"><p>Returns the sampling rate that was used.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double SamplingRate { 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.Double</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector_AmortizeFacetCounts_Lucene_Net_Facet_FacetResult_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Search_IndexSearcher_.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.AmortizeFacetCounts(Lucene.Net.Facet.FacetResult%2CLucene.Net.Facet.FacetsConfig%2CLucene.Net.Search.IndexSearcher)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L270">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector_AmortizeFacetCounts_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.AmortizeFacetCounts*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector_AmortizeFacetCounts_Lucene_Net_Facet_FacetResult_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.AmortizeFacetCounts(Lucene.Net.Facet.FacetResult,Lucene.Net.Facet.FacetsConfig,Lucene.Net.Search.IndexSearcher)">AmortizeFacetCounts(FacetResult, FacetsConfig, IndexSearcher)</h4> |
| <div class="markdown level1 summary"><p>Note: if you use a counting <a class="xref" href="Lucene.Net.Facet.Facets.html">Facets</a> implementation, you can amortize the |
| sampled counts by calling this method. Uses the <a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a> and |
| the <span class="xref">Lucene.Net.Search.IndexSearcher</span> to determine the upper bound for each facet value.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FacetResult AmortizeFacetCounts(FacetResult res, FacetsConfig config, IndexSearcher searcher)</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.Facet.FacetResult.html">FacetResult</a></td> |
| <td><span class="parametername">res</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></td> |
| <td><span class="parametername">config</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</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.Facet.FacetResult.html">FacetResult</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector_GetMatchingDocs.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.GetMatchingDocs%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector_GetMatchingDocs_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.GetMatchingDocs*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector_GetMatchingDocs" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.GetMatchingDocs">GetMatchingDocs()</h4> |
| <div class="markdown level1 summary"><p>Returns the sampled list of the matching documents. Note that a |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html">FacetsCollector.MatchingDocs</a> instance is returned per segment, even |
| if no hits from that segment are included in the sampled set. |
| <p> |
| Note: One or more of the <a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html">FacetsCollector.MatchingDocs</a> might be empty (not containing any |
| hits) as result of sampling. |
| </p> |
| <p> |
| Note: <a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html#Lucene_Net_Facet_FacetsCollector_MatchingDocs_TotalHits">TotalHits</a> is copied from the original |
| <a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html">FacetsCollector.MatchingDocs</a>, scores is set to <code>null</code> |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override IList<FacetsCollector.MatchingDocs> GetMatchingDocs()</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.IList</span><<a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html">FacetsCollector.MatchingDocs</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Facet.FacetsCollector.html#Lucene_Net_Facet_FacetsCollector_GetMatchingDocs">FacetsCollector.GetMatchingDocs()</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector_GetOriginalMatchingDocs.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector.GetOriginalMatchingDocs%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L171">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_RandomSamplingFacetsCollector_GetOriginalMatchingDocs_" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.GetOriginalMatchingDocs*"></a> |
| <h4 id="Lucene_Net_Facet_RandomSamplingFacetsCollector_GetOriginalMatchingDocs" data-uid="Lucene.Net.Facet.RandomSamplingFacetsCollector.GetOriginalMatchingDocs">GetOriginalMatchingDocs()</h4> |
| <div class="markdown level1 summary"><p>Returns the original matching documents.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<FacetsCollector.MatchingDocs> GetOriginalMatchingDocs()</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.IList</span><<a class="xref" href="Lucene.Net.Facet.FacetsCollector.MatchingDocs.html">FacetsCollector.MatchingDocs</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">Lucene.Net.Search.ICollector</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_RandomSamplingFacetsCollector.md&value=---%0Auid%3A%20Lucene.Net.Facet.RandomSamplingFacetsCollector%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/RandomSamplingFacetsCollector.cs/#L44" 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> |
