blob: df0ccb3943923454eab0b264eb6f49e68ba78f6f [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.Range
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Facet.Range
| 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.Range">
<h1 id="Lucene_Net_Facet_Range" data-uid="Lucene.Net.Facet.Range" class="text-break">Namespace Lucene.Net.Facet.Range
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>Provides range faceting capabilities. </p>
</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.Range.DoubleRange.html">DoubleRange</a></h4>
<section><p>Represents a range over double values.</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.Range.DoubleRangeFacetCounts.html">DoubleRangeFacetCounts</a></h4>
<section><p><a class="xref" href="Lucene.Net.Facet.Facets.html">Facets</a> implementation that computes counts for
dynamic double ranges from a provided <span class="xref">Lucene.Net.Queries.Function.ValueSource</span>,
using <span class="xref">Lucene.Net.Queries.Function.FunctionValues.DoubleVal(System.Int32)</span> or <span class="xref">Lucene.Net.Queries.Function.FunctionValues.DoubleVal(System.Int32,System.Double[])</span>. Use
this for dimensions that change in real-time (e.g. a
relative time based dimension like &quot;Past day&quot;, &quot;Past 2
days&quot;, etc.) or that change for each request (e.g.
distance from the user&apos;s location, &quot;&lt; 1 km&quot;, &quot;&lt; 2 km&quot;,
etc.).</p>
<p> If you had indexed your field using <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.SingleDocValuesField.html">SingleDocValuesField</a>
then pass <span class="xref">Lucene.Net.Queries.Function.ValueSources.SingleFieldSource</span>
as the <span class="xref">Lucene.Net.Queries.Function.ValueSource</span>; if you used
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.DoubleDocValuesField.html">DoubleDocValuesField</a> then pass
<span class="xref">Lucene.Net.Queries.Function.ValueSources.DoubleFieldSource</span> (this is the default used when you
pass just a the field name).
@lucene.experimental
</p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.Range.Int64Range.html">Int64Range</a></h4>
<section><p>Represents a range over <span class="xref">System.Int64</span> values.
<p>
NOTE: This was LongRange in Lucene</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.Range.Int64RangeFacetCounts.html">Int64RangeFacetCounts</a></h4>
<section><p><a class="xref" href="Lucene.Net.Facet.Facets.html">Facets</a> implementation that computes counts for
dynamic long ranges from a provided <span class="xref">Lucene.Net.Queries.Function.ValueSource</span>,
using <span class="xref">Lucene.Net.Queries.Function.FunctionValues.Int64Val(System.Int32)</span> or <span class="xref">Lucene.Net.Queries.Function.FunctionValues.Int64Val(System.Int32,System.Int64[])</span>. Use
this for dimensions that change in real-time (e.g. a
relative time based dimension like &quot;Past day&quot;, &quot;Past 2
days&quot;, etc.) or that change for each request (e.g.
distance from the user&apos;s location, &quot;&lt; 1 km&quot;, &quot;&lt; 2 km&quot;,
etc.).
<p>
NOTE: This was LongRangeFacetCounts in Lucene</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.Range.Range.html">Range</a></h4>
<section><p>Base class for a single labeled range.</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>
</section>
<h4><a class="xref" href="Lucene.Net.Facet.Range.RangeFacetCounts.html">RangeFacetCounts</a></h4>
<section><p>Base class for range faceting.</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>
</section>
</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/blob/docs/4.8.0-beta00010/src/Lucene.Net.Facet/Range/package.md/#L2" class="contribution-link">Improve this Doc</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>