| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SortedSetDocValuesFacetCounts |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SortedSetDocValuesFacetCounts |
| | 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="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"> |
| <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.Facet.SortedSet.SortedSetDocValuesFacetCounts"> |
| |
| |
| <h1 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts" class="text-break">Class SortedSetDocValuesFacetCounts |
| </h1> |
| <div class="markdown level0 summary"><p>Compute facets counts from previously |
| indexed <a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField.html">SortedSetDocValuesFacetField</a>, |
| without require a separate taxonomy index. Faceting is |
| a bit slower (~25%), and there is added cost on every |
| <span class="xref">Lucene.Net.Index.IndexReader</span> open to create a new |
| <a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a>. Furthermore, this does |
| not support hierarchical facets; only flat (dimension + |
| label) facets, but it uses quite a bit less RAM to do |
| so.</p> |
| <p><strong>NOTE</strong>: this class should be instantiated and |
| then used from a single thread, because it holds a |
| thread-private instance of <span class="xref">Lucene.Net.Index.SortedSetDocValues</span>. |
| |
| </p> |
| <p><strong>NOTE:</strong>: tie-break is by unicode sort order |
| |
| @lucene.experimental |
| </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.Facets.html">Facets</a></div> |
| <div class="level2"><span class="xref">SortedSetDocValuesFacetCounts</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Facet.SortedSet.html">Lucene.Net.Facet.SortedSet</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6> |
| <h5 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SortedSetDocValuesFacetCounts : Facets</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts__ctor_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_Lucene_Net_Facet_FacetsCollector_.md&value=---%0Auid%3A%20Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.%23ctor(Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState%2CLucene.Net.Facet.FacetsCollector)%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.Facet/SortedSet/SortedSetDocValuesFacetCounts.cs/#L65">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts__ctor_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts__ctor_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_Lucene_Net_Facet_FacetsCollector_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.#ctor(Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState,Lucene.Net.Facet.FacetsCollector)">SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState, FacetsCollector)</h4> |
| <div class="markdown level1 summary"><p>Sparse faceting: returns any dimension that had any |
| hits, topCount labels per dimension. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState state, FacetsCollector hits)</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.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a></td> |
| <td><span class="parametername">state</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsCollector.html">FacetsCollector</a></td> |
| <td><span class="parametername">hits</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetAllDims_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetAllDims(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/fix/apidocs-layout/src/Lucene.Net.Facet/SortedSet/SortedSetDocValuesFacetCounts.cs/#L289">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetAllDims_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetAllDims*"></a> |
| <h4 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetAllDims_System_Int32_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetAllDims(System.Int32)">GetAllDims(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 override IList<FacetResult> GetAllDims(int topN)</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">topN</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Facet.FacetResult.html">FacetResult</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Facet.Facets.html#Lucene_Net_Facet_Facets_GetAllDims_System_Int32_">Facets.GetAllDims(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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetSpecificValue_System_String_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetSpecificValue(System.String%2CSystem.String%5B%5D)%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.Facet/SortedSet/SortedSetDocValuesFacetCounts.cs/#L274">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetSpecificValue_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetSpecificValue*"></a> |
| <h4 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetSpecificValue_System_String_System_String___" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetSpecificValue(System.String,System.String[])">GetSpecificValue(String, String[])</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 float GetSpecificValue(string dim, params string[] path)</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.String</span></td> |
| <td><span class="parametername">dim</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">path</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Facet.Facets.html#Lucene_Net_Facet_Facets_GetSpecificValue_System_String_System_String___">Facets.GetSpecificValue(String, String[])</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetTopChildren_System_Int32_System_String_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetTopChildren(System.Int32%2CSystem.String%2CSystem.String%5B%5D)%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.Facet/SortedSet/SortedSetDocValuesFacetCounts.cs/#L75">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetTopChildren_" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetTopChildren*"></a> |
| <h4 id="Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetCounts_GetTopChildren_System_Int32_System_String_System_String___" data-uid="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.GetTopChildren(System.Int32,System.String,System.String[])">GetTopChildren(Int32, String, String[])</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 FacetResult GetTopChildren(int topN, string dim, params string[] path)</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">topN</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">dim</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">path</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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Facet.Facets.html#Lucene_Net_Facet_Facets_GetTopChildren_System_Int32_System_String_System_String___">Facets.GetTopChildren(Int32, String, String[])</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_Facet_SortedSet_SortedSetDocValuesFacetCounts.md&value=---%0Auid%3A%20Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts%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.Facet/SortedSet/SortedSetDocValuesFacetCounts.cs/#L54" 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> |
