| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class WithinPrefixTreeFilter |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class WithinPrefixTreeFilter |
| | Apache Lucene.NET 4.8.0-beta00009 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="spatial/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.Spatial.Prefix.WithinPrefixTreeFilter"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter" class="text-break">Class WithinPrefixTreeFilter |
| </h1> |
| <div class="markdown level0 summary"><p>Finds docs where its indexed shape is |
| <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html#Lucene_Net_Spatial_Queries_SpatialOperation_IsWithin">IsWithin</a> |
| the query shape. It works by looking at cells outside of the query |
| shape to ensure documents there are excluded. By default, it will |
| examine all cells, and it's fairly slow. If you know that the indexed shapes |
| are never comprised of multiple disjoint parts (which also means it is not multi-valued), |
| then you can pass <code>SpatialPrefixTree.GetDistanceForLevel(maxLevels)</code> as |
| the <code>queryBuffer</code> constructor parameter to minimally look this distance |
| beyond the query shape's edge. Even if the indexed shapes are sometimes |
| comprised of multiple disjoint parts, you might want to use this option with |
| a large buffer as a faster approximation with minimal false-positives.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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">Lucene.Net.Search.Filter</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html">AbstractPrefixTreeFilter</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractVisitingPrefixTreeFilter.html">AbstractVisitingPrefixTreeFilter</a></div> |
| <div class="level4"><span class="xref">WithinPrefixTreeFilter</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractVisitingPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractVisitingPrefixTreeFilter_m_prefixGridScanLevel">AbstractVisitingPrefixTreeFilter.m_prefixGridScanLevel</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractVisitingPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractVisitingPrefixTreeFilter_Equals_System_Object_">AbstractVisitingPrefixTreeFilter.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractVisitingPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractVisitingPrefixTreeFilter_GetHashCode">AbstractVisitingPrefixTreeFilter.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_queryShape">AbstractPrefixTreeFilter.m_queryShape</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_fieldName">AbstractPrefixTreeFilter.m_fieldName</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_grid">AbstractPrefixTreeFilter.m_grid</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_detailLevel">AbstractPrefixTreeFilter.m_detailLevel</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/api/core/Lucene.Net.Search.Filter.html#Lucene_Net_Search_Filter_NewAnonymous_System_Func_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_Lucene_Net_Search_DocIdSet__">Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</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.Spatial.Prefix.html">Lucene.Net.Spatial.Prefix</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6> |
| <h5 id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class WithinPrefixTreeFilter : AbstractVisitingPrefixTreeFilter</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter__ctor_Spatial4n_Core_Shapes_IShape_System_String_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Int32_System_Int32_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.%23ctor(Spatial4n.Core.Shapes.IShape%2CSystem.String%2CLucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.Int32%2CSystem.Int32%2CSystem.Double)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Spatial/Prefix/WithinPrefixTreeFilter.cs/#L60">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter__ctor_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter__ctor_Spatial4n_Core_Shapes_IShape_System_String_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Int32_System_Int32_System_Double_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.#ctor(Spatial4n.Core.Shapes.IShape,System.String,Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.Int32,System.Int32,System.Double)">WithinPrefixTreeFilter(IShape, String, SpatialPrefixTree, Int32, Int32, Double)</h4> |
| <div class="markdown level1 summary"><p>See <a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractVisitingPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractVisitingPrefixTreeFilter__ctor_Spatial4n_Core_Shapes_IShape_System_String_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Int32_System_Int32_">AbstractVisitingPrefixTreeFilter(IShape, String, SpatialPrefixTree, Int32, Int32)</a>. |
| <code>queryBuffer</code> is the (minimum) distance beyond the query shape edge |
| where non-matching documents are looked for so they can be excluded. If |
| -1 is used then the whole world is examined (a good default for correctness).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public WithinPrefixTreeFilter(IShape queryShape, string fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel, double queryBuffer)</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">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">queryShape</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></td> |
| <td><span class="parametername">grid</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">detailLevel</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">prefixGridScanLevel</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">queryBuffer</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_BufferShape_Spatial4n_Core_Shapes_IShape_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.BufferShape(Spatial4n.Core.Shapes.IShape%2CSystem.Double)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Spatial/Prefix/WithinPrefixTreeFilter.cs/#L77">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_BufferShape_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.BufferShape*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_BufferShape_Spatial4n_Core_Shapes_IShape_System_Double_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.BufferShape(Spatial4n.Core.Shapes.IShape,System.Double)">BufferShape(IShape, Double)</h4> |
| <div class="markdown level1 summary"><p>Returns a new shape that is larger than shape by at distErr.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual IShape BufferShape(IShape shape, double distErr)</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">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">shape</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">distErr</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">Spatial4n.Core.Shapes.IShape</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_GetDocIdSet_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext%2CLucene.Net.Util.IBits)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Spatial/Prefix/WithinPrefixTreeFilter.cs/#L140">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_GetDocIdSet_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.GetDocIdSet*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter_GetDocIdSet_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_" data-uid="Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext,Lucene.Net.Util.IBits)">GetDocIdSet(AtomicReaderContext, IBits)</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 DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)</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">Lucene.Net.Index.AtomicReaderContext</span></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.IBits</span></td> |
| <td><span class="parametername">acceptDocs</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">Lucene.Net.Search.DocIdSet</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.Filter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)</span></div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_WithinPrefixTreeFilter.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter%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/docs-poc/src/Lucene.Net.Spatial/Prefix/WithinPrefixTreeFilter.cs/#L46" 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> |