| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PrefixTreeStrategy |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PrefixTreeStrategy |
| | 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="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.PrefixTreeStrategy"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy" class="text-break">Class PrefixTreeStrategy |
| </h1> |
| <div class="markdown level0 summary"><p>An abstract SpatialStrategy based on <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a>. The two |
| subclasses are <a class="xref" href="Lucene.Net.Spatial.Prefix.RecursivePrefixTreeStrategy.html">RecursivePrefixTreeStrategy</a> and |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.html">TermQueryPrefixTreeStrategy</a>. This strategy is most effective as a fast |
| approximate spatial search filter.</p> |
| <p><h4>Characteristics:</h4> |
| <ul><li>Can index any shape; however only |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.RecursivePrefixTreeStrategy.html">RecursivePrefixTreeStrategy</a> |
| can effectively search non-point shapes.</li><li>Can index a variable number of shapes per field value. This strategy |
| can do it via multiple calls to <a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_">CreateIndexableFields(IShape)</a> |
| for a document or by giving it some sort of Shape aggregate (e.g. NTS |
| WKT MultiPoint). The shape's boundary is approximated to a grid precision. |
| </li><li>Can query with any shape. The shape's boundary is approximated to a grid |
| precision.</li><li>Only <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html#Lucene_Net_Spatial_Queries_SpatialOperation_Intersects">Intersects</a> |
| is supported. If only points are indexed then this is effectively equivalent |
| to IsWithin.</li><li>The strategy supports <a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_">MakeDistanceValueSource(IPoint, Double)</a> |
| even for multi-valued data, so long as the indexed data is all points; the |
| behavior is undefined otherwise. However, <code>it will likely be removed in |
| the future</code> in lieu of using another strategy with a more scalable |
| implementation. Use of this call is the only |
| circumstance in which a cache is used. The cache is simple but as such |
| it doesn't scale to large numbers of points nor is it real-time-search |
| friendly.</li></ul></p> |
| <p><h4>Implementation:</h4> |
| The <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a> |
| does most of the work, for example returning |
| a list of terms representing grids of various sizes for a supplied shape. |
| An important |
| configuration item is <a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct">DistErrPct</a> which balances |
| shape precision against scalability. See those docs.</p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL 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"><a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html">SpatialStrategy</a></div> |
| <div class="level2"><span class="xref">PrefixTreeStrategy</span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Spatial.Prefix.RecursivePrefixTreeStrategy.html">RecursivePrefixTreeStrategy</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.html">TermQueryPrefixTreeStrategy</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_m_ctx">SpatialStrategy.m_ctx</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_SpatialContext">SpatialStrategy.SpatialContext</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_FieldName">SpatialStrategy.FieldName</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_">SpatialStrategy.MakeDistanceValueSource(IPoint)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeQuery_Lucene_Net_Spatial_Queries_SpatialArgs_">SpatialStrategy.MakeQuery(SpatialArgs)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_">SpatialStrategy.MakeFilter(SpatialArgs)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeRecipDistanceValueSource_Spatial4n_Core_Shapes_IShape_">SpatialStrategy.MakeRecipDistanceValueSource(IShape)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_ToString">SpatialStrategy.ToString()</a> |
| </div> |
| <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> |
| <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_PrefixTreeStrategy_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class PrefixTreeStrategy : SpatialStrategy</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.%23ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.String%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L84">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy__ctor_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_System_Boolean_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.#ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.String,System.Boolean)">PrefixTreeStrategy(SpatialPrefixTree, String, Boolean)</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 PrefixTreeStrategy(SpatialPrefixTree grid, string fieldName, bool simplifyIndexedCells)</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.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></td> |
| <td><span class="parametername">grid</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><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">simplifyIndexedCells</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_FIELD_TYPE.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.FIELD_TYPE%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L144">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_FIELD_TYPE" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.FIELD_TYPE">FIELD_TYPE</h4> |
| <div class="markdown level1 summary"><p>Indexed, tokenized, not stored.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly FieldType FIELD_TYPE</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Documents.FieldType</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_defaultFieldValuesArrayLen.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_defaultFieldValuesArrayLen%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L81">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_defaultFieldValuesArrayLen" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_defaultFieldValuesArrayLen">m_defaultFieldValuesArrayLen</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">protected int m_defaultFieldValuesArrayLen</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_distErrPct.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_distErrPct%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L82">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_distErrPct" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_distErrPct">m_distErrPct</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">protected double m_distErrPct</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_grid.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_grid%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L75">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_grid" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_grid">m_grid</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">protected readonly SpatialPrefixTree m_grid</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_simplifyIndexedCells.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_simplifyIndexedCells%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L80">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_simplifyIndexedCells" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.m_simplifyIndexedCells">m_simplifyIndexedCells</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">protected readonly bool m_simplifyIndexedCells</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DefaultFieldValuesArrayLen.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DefaultFieldValuesArrayLen%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DefaultFieldValuesArrayLen_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DefaultFieldValuesArrayLen*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DefaultFieldValuesArrayLen" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DefaultFieldValuesArrayLen">DefaultFieldValuesArrayLen</h4> |
| <div class="markdown level1 summary"><p>A memory hint used by <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_">MakeDistanceValueSource(IPoint)</a> |
| for how big the initial size of each Document's array should be. The |
| default is 2. Set this to slightly more than the default expected number |
| of points per document.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int DefaultFieldValuesArrayLen { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DistErrPct%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L117">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DistErrPct*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.DistErrPct">DistErrPct</h4> |
| <div class="markdown level1 summary"><p>The default measure of shape precision affecting shapes at index and query |
| times.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double DistErrPct { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.Double</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The default measure of shape precision affecting shapes at index and query |
| times. Points don't use this as they are always indexed at the configured |
| maximum precision (<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_MaxLevels">MaxLevels</a>); |
| this applies to all other shapes. Specific shapes at index and query time |
| can use something different than this default value. If you don't set a |
| default then the default is <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialArgs.html#Lucene_Net_Spatial_Queries_SpatialArgs_DEFAULT_DISTERRPCT">DEFAULT_DISTERRPCT</a> -- |
| 2.5%.</p> |
| </div> |
| <h5 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Spatial.Queries.SpatialArgs.html#Lucene_Net_Spatial_Queries_SpatialArgs_DistErrPct">DistErrPct</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_Grid.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.Grid%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L205">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_Grid_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.Grid*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_Grid" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.Grid">Grid</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 virtual SpatialPrefixTree Grid { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields(Spatial4n.Core.Shapes.IShape)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L123">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields(Spatial4n.Core.Shapes.IShape)">CreateIndexableFields(IShape)</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 Field[] CreateIndexableFields(IShape shape)</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> |
| </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="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html">Field</a>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_">SpatialStrategy.CreateIndexableFields(IShape)</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields(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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L129">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_System_Double_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.CreateIndexableFields(Spatial4n.Core.Shapes.IShape,System.Double)">CreateIndexableFields(IShape, Double)</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 virtual Field[] CreateIndexableFields(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><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html">Field</a>[]</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L199">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_MakeDistanceValueSource_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.MakeDistanceValueSource*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_" data-uid="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint,System.Double)">MakeDistanceValueSource(IPoint, Double)</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 ValueSource MakeDistanceValueSource(IPoint queryPoint, double multiplier)</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.IPoint</span></td> |
| <td><span class="parametername">queryPoint</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">multiplier</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.Queries.Function.ValueSource</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_">SpatialStrategy.MakeDistanceValueSource(IPoint, Double)</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_PrefixTreeStrategy.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.PrefixTreeStrategy%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs/#L73" 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> |
