| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SpatialPrefixTree |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SpatialPrefixTree |
| | Apache Lucene.NET 4.8.0-beta00011 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.Tree.SpatialPrefixTree"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree" class="text-break">Class SpatialPrefixTree |
| </h1> |
| <div class="markdown level0 summary"><p>A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings |
| at variable lengths corresponding to variable precision.</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">SpatialPrefixTree</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.html">GeohashPrefixTree</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.QuadPrefixTree.html">QuadPrefixTree</a></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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.html">Lucene.Net.Spatial.Prefix.Tree</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class SpatialPrefixTree</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings |
| at variable lengths corresponding to variable precision. Each string |
| corresponds to a rectangular spatial region. This approach is |
| also referred to "Grids", "Tiles", and "Spatial Tiers". |
| <p> |
| Implementations of this class should be thread-safe and immutable once |
| initialized.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree__ctor_Spatial4n_Core_Context_SpatialContext_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.%23ctor(Spatial4n.Core.Context.SpatialContext%2CSystem.Int32)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L48">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree__ctor_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree__ctor_Spatial4n_Core_Context_SpatialContext_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.#ctor(Spatial4n.Core.Context.SpatialContext,System.Int32)">SpatialPrefixTree(SpatialContext, Int32)</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 SpatialPrefixTree(SpatialContext ctx, int maxLevels)</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.Context.SpatialContext</span></td> |
| <td><span class="parametername">ctx</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxLevels</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_m_ctx.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.m_ctx%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L46">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_m_ctx" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.m_ctx">m_ctx</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 SpatialContext m_ctx</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">Spatial4n.Core.Context.SpatialContext</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_m_maxLevels.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.m_maxLevels%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L44">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_m_maxLevels" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.m_maxLevels">m_maxLevels</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 int m_maxLevels</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> |
| <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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_MaxLevels.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.MaxLevels%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L57">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_MaxLevels_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.MaxLevels*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_MaxLevels" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.MaxLevels">MaxLevels</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 int MaxLevels { 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><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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_SpatialContext.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.SpatialContext%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L55">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_SpatialContext_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.SpatialContext*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_SpatialContext" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.SpatialContext">SpatialContext</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 SpatialContext SpatialContext { 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><span class="xref">Spatial4n.Core.Context.SpatialContext</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_WorldCell.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.WorldCell%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_WorldCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.WorldCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_WorldCell" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.WorldCell">WorldCell</h4> |
| <div class="markdown level1 summary"><p>Returns the level 0 cell which encompasses all spatial data.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Cell WorldCell { 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.Cell.html">Cell</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_WorldCell_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Returns the level 0 cell which encompasses all spatial data. Equivalent to |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_String_">GetCell(String)</a> with <span class="xref">System.String.Empty</span>. |
| This cell is threadsafe, just like a spatial prefix grid is, although cells aren't |
| generally threadsafe.</p> |
| </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_CellsToTokenStrings_System_Collections_Generic_ICollection_Lucene_Net_Spatial_Prefix_Tree_Cell__.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.CellsToTokenStrings(System.Collections.Generic.ICollection%7BLucene.Net.Spatial.Prefix.Tree.Cell%7D)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L282">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_CellsToTokenStrings_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.CellsToTokenStrings*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_CellsToTokenStrings_System_Collections_Generic_ICollection_Lucene_Net_Spatial_Prefix_Tree_Cell__" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.CellsToTokenStrings(System.Collections.Generic.ICollection{Lucene.Net.Spatial.Prefix.Tree.Cell})">CellsToTokenStrings(ICollection<Cell>)</h4> |
| <div class="markdown level1 summary"><p>Will add the trailing leaf byte for leaves. This isn't particularly efficient.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Obsolete("TODO remove; not used and not interesting, don't need collection in & out")] |
| public static IList<string> CellsToTokenStrings(ICollection<Cell> cells)</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.Collections.Generic.ICollection</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a>></td> |
| <td><span class="parametername">cells</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">System.Collections.Generic.IList</span><<span class="xref">System.String</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_Spatial4n_Core_Shapes_IPoint_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(Spatial4n.Core.Shapes.IPoint%2CSystem.Int32)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L154">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_Spatial4n_Core_Shapes_IPoint_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(Spatial4n.Core.Shapes.IPoint,System.Int32)">GetCell(IPoint, Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the cell containing point <code data-dev-comment-type="paramref" class="paramref">p</code> at the specified <code data-dev-comment-type="paramref" class="paramref">level</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual Cell GetCell(IPoint p, int level)</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">p</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">level</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.Spatial.Prefix.Tree.Cell.html">Cell</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L139">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.Byte[],System.Int32,System.Int32)">GetCell(Byte[], Int32, Int32)</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 abstract Cell GetCell(byte[] bytes, int offset, int len)</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.Byte</span>[]</td> |
| <td><span class="parametername">bytes</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</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.Spatial.Prefix.Tree.Cell.html">Cell</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_Byte___System_Int32_System_Int32_Lucene_Net_Spatial_Prefix_Tree_Cell_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Spatial.Prefix.Tree.Cell)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L141">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_Byte___System_Int32_System_Int32_Lucene_Net_Spatial_Prefix_Tree_Cell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.Byte[],System.Int32,System.Int32,Lucene.Net.Spatial.Prefix.Tree.Cell)">GetCell(Byte[], Int32, Int32, Cell)</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 Cell GetCell(byte[] bytes, int offset, int len, Cell target)</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.Byte</span>[]</td> |
| <td><span class="parametername">bytes</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a></td> |
| <td><span class="parametername">target</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.Spatial.Prefix.Tree.Cell.html">Cell</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.String)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L137">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_String_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCell(System.String)">GetCell(String)</h4> |
| <div class="markdown level1 summary"><p>The cell for the specified token.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract Cell GetCell(string token)</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">token</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.Spatial.Prefix.Tree.Cell.html">Cell</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The cell for the specified token. The empty string should be equal to |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_WorldCell">WorldCell</a>. |
| Precondition: Never called when token length > maxLevel.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IPoint_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells(Spatial4n.Core.Shapes.IPoint%2CSystem.Int32%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L263">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IPoint_System_Int32_System_Boolean_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells(Spatial4n.Core.Shapes.IPoint,System.Int32,System.Boolean)">GetCells(IPoint, Int32, Boolean)</h4> |
| <div class="markdown level1 summary"><p>A Point-optimized implementation of |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IShape_System_Int32_System_Boolean_System_Boolean_">GetCells(IShape, Int32, Boolean, Boolean)</a>. That |
| method in facts calls this for points. |
| <p> |
| This implementation depends on <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCell_System_String_">GetCell(String)</a> being fast, as its |
| called repeatedly when incPlarents is true.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<Cell> GetCells(IPoint p, int detailLevel, bool inclParents)</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">p</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.Boolean</span></td> |
| <td><span class="parametername">inclParents</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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IShape_System_Int32_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells(Spatial4n.Core.Shapes.IShape%2CSystem.Int32%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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L183">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IShape_System_Int32_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetCells(Spatial4n.Core.Shapes.IShape,System.Int32,System.Boolean,System.Boolean)">GetCells(IShape, Int32, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Gets the intersecting cells for the specified shape, without exceeding |
| detail level.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<Cell> GetCells(IShape shape, int detailLevel, bool inclParents, bool simplify)</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><p>the shape; non-null</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">detailLevel</span></td> |
| <td><p>the maximum detail level to get cells for</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">inclParents</span></td> |
| <td><p>if true then all parent cells of leaves are returned |
| too. The top world cell is never returned.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">simplify</span></td> |
| <td><p>for non-point shapes, this will simply/aggregate sets of |
| complete leaves in a cell to its parent, resulting in |
| ~20-25% fewer cells.</p> |
| </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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a>></td> |
| <td><p>a set of cells (no dups), sorted, immutable, non-null</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IShape_System_Int32_System_Boolean_System_Boolean__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Gets the intersecting cells for the specified shape, without exceeding |
| detail level. If a cell is within the query shape then it's marked as a |
| leaf and none of its children are added. |
| <p> |
| This implementation checks if shape is a <span class="xref">Spatial4n.Core.Shapes.IPoint</span> and if so returns |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IPoint_System_Int32_System_Boolean_">GetCells(IPoint, Int32, Boolean)</a>.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetDistanceForLevel_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetDistanceForLevel(System.Int32)%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L90">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetDistanceForLevel_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetDistanceForLevel*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetDistanceForLevel_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetDistanceForLevel(System.Int32)">GetDistanceForLevel(Int32)</h4> |
| <div class="markdown level1 summary"><p>Given a cell having the specified level, returns the distance from opposite |
| corners.</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 GetDistanceForLevel(int level)</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.Int32</span></td> |
| <td><span class="parametername">level</span></td> |
| <td><p>[1 to maxLevels]</p> |
| </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">System.Double</span></td> |
| <td><blockquote><p>0</p> |
| </blockquote> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetDistanceForLevel_System_Int32__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Given a cell having the specified level, returns the distance from opposite |
| corners. Since this might very depending on where the cell is, this method |
| may over-estimate.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetLevelForDistance_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetLevelForDistance(System.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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L77">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetLevelForDistance_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetLevelForDistance*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetLevelForDistance_System_Double_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetLevelForDistance(System.Double)">GetLevelForDistance(Double)</h4> |
| <div class="markdown level1 summary"><p>Returns the level of the largest grid in which its longest side is less |
| than or equal to the provided distance (in degrees).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract int GetLevelForDistance(double dist)</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.Double</span></td> |
| <td><span class="parametername">dist</span></td> |
| <td><blockquote><p>= 0</p> |
| </blockquote> |
| </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">System.Int32</span></td> |
| <td><p>level [1 to maxLevels]</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetLevelForDistance_System_Double__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Returns the level of the largest grid in which its longest side is less |
| than or equal to the provided distance (in degrees). Consequently |
| <code data-dev-comment-type="paramref" class="paramref">dist</code> acts as an error epsilon declaring the amount of detail needed in the |
| grid, such that you can get a grid with just the right amount of |
| precision.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_ToString.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.ToString%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L59">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_ToString_" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.ToString*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_ToString" data-uid="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.ToString">ToString()</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 string ToString()</code></pre> |
| </div> |
| <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">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</span></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%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_beta00011/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs/#L42" 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> |