| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class NumericRangeFilter |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class NumericRangeFilter |
| | 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="core/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.Search.NumericRangeFilter"> |
| |
| |
| <h1 id="Lucene_Net_Search_NumericRangeFilter" data-uid="Lucene.Net.Search.NumericRangeFilter" class="text-break">Class NumericRangeFilter |
| </h1> |
| <div class="markdown level0 summary"><p>LUCENENET specific static class to provide access to static methods without referring to the |
| <a class="xref" href="Lucene.Net.Search.NumericRangeFilter-1.html">NumericRangeFilter<T></a>'s generic closing type.</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">NumericRangeFilter</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.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_NumericRangeFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static class NumericRangeFilter</code></pre> |
| </div> |
| <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_Search_NumericRangeFilter_NewDoubleRange_System_String_System_Int32_System_Nullable_System_Double__System_Nullable_System_Double__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewDoubleRange(System.String%2CSystem.Int32%2CSystem.Nullable%7BSystem.Double%7D%2CSystem.Nullable%7BSystem.Double%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L146">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewDoubleRange_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewDoubleRange*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewDoubleRange_System_String_System_Int32_System_Nullable_System_Double__System_Nullable_System_Double__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewDoubleRange(System.String,System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean,System.Boolean)">NewDoubleRange(String, Int32, Nullable<Double>, Nullable<Double>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that filters a <span class="xref">System.Double</span> |
| range using the given <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a>. |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. |
| <span class="xref">System.Double.NaN</span> will never match a half-open range, to hit <code>NaN</code> use a query |
| with <code>min == max == System.Double.NaN</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<double> NewDoubleRange(string field, int precisionStep, double? min, double? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">precisionStep</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewDoubleRange_System_String_System_Nullable_System_Double__System_Nullable_System_Double__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewDoubleRange(System.String%2CSystem.Nullable%7BSystem.Double%7D%2CSystem.Nullable%7BSystem.Double%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L160">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewDoubleRange_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewDoubleRange*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewDoubleRange_System_String_System_Nullable_System_Double__System_Nullable_System_Double__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewDoubleRange(System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean,System.Boolean)">NewDoubleRange(String, Nullable<Double>, Nullable<Double>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that queries a <span class="xref">System.Double</span> |
| range using the default <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a> <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. |
| <span class="xref">System.Double.NaN</span> will never match a half-open range, to hit <code>NaN</code> use a query |
| with <code>min == max == System.Double.NaN</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<double> NewDoubleRange(string field, double? min, double? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewInt32Range_System_String_System_Int32_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewInt32Range(System.String%2CSystem.Int32%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L118">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewInt32Range_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt32Range*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewInt32Range_System_String_System_Int32_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt32Range(System.String,System.Int32,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean)">NewInt32Range(String, Int32, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that filters a <span class="xref">System.Int32</span> |
| range using the given <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a>. |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newIntRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<int> NewInt32Range(string field, int precisionStep, int? min, int? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">precisionStep</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewInt32Range_System_String_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewInt32Range(System.String%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewInt32Range_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt32Range*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewInt32Range_System_String_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt32Range(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean)">NewInt32Range(String, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that queries a <span class="xref">System.Int32</span> |
| range using the default <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a> <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newIntRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<int> NewInt32Range(string field, int? min, int? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewInt64Range_System_String_System_Int32_System_Nullable_System_Int64__System_Nullable_System_Int64__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewInt64Range(System.String%2CSystem.Int32%2CSystem.Nullable%7BSystem.Int64%7D%2CSystem.Nullable%7BSystem.Int64%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L90">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewInt64Range_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt64Range*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewInt64Range_System_String_System_Int32_System_Nullable_System_Int64__System_Nullable_System_Int64__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt64Range(System.String,System.Int32,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Boolean,System.Boolean)">NewInt64Range(String, Int32, Nullable<Int64>, Nullable<Int64>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that filters a <span class="xref">System.Int64</span> |
| range using the given <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a>. |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newLongRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<long> NewInt64Range(string field, int precisionStep, long? min, long? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">precisionStep</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<span class="xref">System.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewInt64Range_System_String_System_Nullable_System_Int64__System_Nullable_System_Int64__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewInt64Range(System.String%2CSystem.Nullable%7BSystem.Int64%7D%2CSystem.Nullable%7BSystem.Int64%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L104">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewInt64Range_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt64Range*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewInt64Range_System_String_System_Nullable_System_Int64__System_Nullable_System_Int64__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewInt64Range(System.String,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Boolean,System.Boolean)">NewInt64Range(String, Nullable<Int64>, Nullable<Int64>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that queries a <span class="xref">System.Int64</span> |
| range using the default <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a> <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newLongRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<long> NewInt64Range(string field, long? min, long? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<span class="xref">System.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewSingleRange_System_String_System_Int32_System_Nullable_System_Single__System_Nullable_System_Single__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewSingleRange(System.String%2CSystem.Int32%2CSystem.Nullable%7BSystem.Single%7D%2CSystem.Nullable%7BSystem.Single%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L176">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewSingleRange_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewSingleRange*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewSingleRange_System_String_System_Int32_System_Nullable_System_Single__System_Nullable_System_Single__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewSingleRange(System.String,System.Int32,System.Nullable{System.Single},System.Nullable{System.Single},System.Boolean,System.Boolean)">NewSingleRange(String, Int32, Nullable<Single>, Nullable<Single>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that filters a <span class="xref">System.Single</span> |
| range using the given <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a>. |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. |
| <span class="xref">System.Single.NaN</span> will never match a half-open range, to hit <code>NaN</code> use a query |
| with <code>min == max == System.Single.NaN</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newFloatRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<float> NewSingleRange(string field, int precisionStep, float? min, float? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">precisionStep</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Single</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Single</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_NumericRangeFilter_NewSingleRange_System_String_System_Nullable_System_Single__System_Nullable_System_Single__System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter.NewSingleRange(System.String%2CSystem.Nullable%7BSystem.Single%7D%2CSystem.Nullable%7BSystem.Single%7D%2CSystem.Boolean%2CSystem.Boolean)%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/Search/NumericRangeFilter.cs/#L192">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_NumericRangeFilter_NewSingleRange_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewSingleRange*"></a> |
| <h4 id="Lucene_Net_Search_NumericRangeFilter_NewSingleRange_System_String_System_Nullable_System_Single__System_Nullable_System_Single__System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.NumericRangeFilter.NewSingleRange(System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Boolean,System.Boolean)">NewSingleRange(String, Nullable<Single>, Nullable<Single>, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Factory that creates a <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>, that queries a <span class="xref">System.Single</span> |
| range using the default <a class="xref" href="Lucene.Net.Search.NumericRangeQuery-1.html#Lucene_Net_Search_NumericRangeQuery_1_PrecisionStep">PrecisionStep</a> <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). |
| You can have half-open ranges (which are in fact </<= or >/>= queries) |
| by setting the min or max value to <code>null</code>. |
| <span class="xref">System.Single.NaN</span> will never match a half-open range, to hit <code>NaN</code> use a query |
| with <code>min == max == System.Single.NaN</code>. By setting inclusive to <code>false</code>, it will |
| match all documents excluding the bounds, with inclusive on, the boundaries are hits, too. |
| <p> |
| NOTE: This was newFloatRange() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericRangeFilter<float> NewSingleRange(string field, float? min, float? max, bool minInclusive, bool maxInclusive)</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Single</span>></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Single</span>></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">minInclusive</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">maxInclusive</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.Search.NumericRangeFilter-1.html">NumericRangeFilter</a><<span class="xref">System.Single</span>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </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_Search_NumericRangeFilter.md&value=---%0Auid%3A%20Lucene.Net.Search.NumericRangeFilter%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/Search/NumericRangeFilter.cs/#L79" 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> |
