blob: 495b5b045d01d974513f4c386c9d6d9d9f09f78a [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace Lucene.Net.Facet.SortedSet
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Facet.SortedSet
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</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="../../index.html">
<img id="logo" class="svg" src="../../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" id="breadcrumb">
<ul class="breadcrumb">
<li></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">
<h1 id="Lucene_Net_Facet_SortedSet" data-uid="Lucene.Net.Facet.SortedSet" class="text-break">Namespace Lucene.Net.Facet.SortedSet
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Facet.SortedSet.DefaultSortedSetDocValuesReaderState.html">DefaultSortedSetDocValuesReaderState</a></h4>
<section><p>Default implementation of <a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.html">SortedSetDocValuesFacetCounts</a></p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts.html">SortedSetDocValuesFacetCounts</a></h4>
<section><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
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.IndexReader.html">IndexReader</a> 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 <a class="xref" href="../Lucene.Net/Lucene.Net.Index.SortedSetDocValues.html">SortedSetDocValues</a>.
</p>
<p><strong>NOTE:</strong>: tie-break is by unicode sort order
@lucene.experimental
</p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField.html">SortedSetDocValuesFacetField</a></h4>
<section><p>Add an instance of this to your <a class="xref" href="../Lucene.Net/Lucene.Net.Documents.Document.html">Document</a> for every facet
label to be indexed via <a class="xref" href="../Lucene.Net/Lucene.Net.Index.SortedSetDocValues.html">SortedSetDocValues</a>. </p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a></h4>
<section><p>Wraps a <a class="xref" href="../Lucene.Net/Lucene.Net.Index.IndexReader.html">IndexReader</a> and resolves ords
using existing <a class="xref" href="../Lucene.Net/Lucene.Net.Index.SortedSetDocValues.html">SortedSetDocValues</a> APIs without a
separate taxonomy index. This only supports flat facets
(dimension + label), and it makes faceting a bit
slower, adds some cost at reopen time, but avoids
managing the separate taxonomy index. It also requires
less RAM than the taxonomy index, as it manages the flat
(2-level) hierarchy more efficiently. In addition, the
tie-break during faceting is now meaningful (in label
sorted order).</p>
<p><strong>NOTE</strong>: creating an instance of this class is
somewhat costly, as it computes per-segment ordinal maps,
so you should create it once and re-use that one instance
for a given <a class="xref" href="../Lucene.Net/Lucene.Net.Index.IndexReader.html">IndexReader</a>.
</p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.OrdRange.html">SortedSetDocValuesReaderState.OrdRange</a></h4>
<section><p>Holds start/end range of ords, which maps to one
dimension (someday we may generalize it to map to
hierarchies within one dimension). </p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</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 © 2019 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>