| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Cell |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Cell |
| | 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.Tree.Cell"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_Prefix_Tree_Cell" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell" class="text-break">Class Cell |
| </h1> |
| <div class="markdown level0 summary"><p>Represents a grid cell. These are not necessarily thread-safe, although new |
| Cell("") (world cell) must be.</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">Cell</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IComparable</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a>></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <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> |
| <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_Cell_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class Cell : IComparable<Cell></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_Tree_Cell__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.%23ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.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_beta00010/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell__ctor_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.#ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.Byte[],System.Int32,System.Int32)">Cell(SpatialPrefixTree, 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">protected Cell(SpatialPrefixTree outerInstance, byte[] bytes, int off, 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><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></td> |
| <td><span class="parametername">outerInstance</span></td> |
| <td></td> |
| </tr> |
| <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">off</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> |
| <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_Tree_Cell__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.%23ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.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_beta00010/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs/#L71">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell__ctor_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.#ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.String)">Cell(SpatialPrefixTree, String)</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 Cell(SpatialPrefixTree outerInstance, 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><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></td> |
| <td><span class="parametername">outerInstance</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">token</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_Tree_Cell_LEAF_BYTE.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.LEAF_BYTE%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/Tree/Cell.cs/#L45">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_LEAF_BYTE" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.LEAF_BYTE">LEAF_BYTE</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 const byte LEAF_BYTE = 43</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.Byte</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_Tree_Cell_m_leaf.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.m_leaf%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/Tree/Cell.cs/#L69">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_m_leaf" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.m_leaf">m_leaf</h4> |
| <div class="markdown level1 summary"><p>Always false for points.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected bool m_leaf</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> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_Cell_m_leaf_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Always false for points. Otherwise, indicate no further sub-cells are going |
| to be provided because shapeRel is WITHIN or maxLevels or a detailLevel is |
| hit.</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_m_outerInstance.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.m_outerInstance%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/Tree/Cell.cs/#L42">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_m_outerInstance" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.m_outerInstance">m_outerInstance</h4> |
| <div class="markdown level1 summary"><p>LUCENENET specific - we need to set the SpatialPrefixTree before calling overridden |
| members of this class, just in case those overridden members require it. This is |
| not possible from the subclass because the constructor of the base class runs first. |
| So we need to move the reference here and also set it before running the normal constructor |
| logic.</p> |
| </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_outerInstance</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_Tree_Cell_m_shapeRel.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.m_shapeRel%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/Tree/Cell.cs/#L61">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_m_shapeRel" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.m_shapeRel">m_shapeRel</h4> |
| <div class="markdown level1 summary"><p>When set via <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_Spatial4n_Core_Shapes_IShape_">GetSubCells(IShape)</a>, it is the relationship between this cell |
| and the given shape filter.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected SpatialRelation m_shapeRel</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.Shapes.SpatialRelation</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_Tree_Cell_Center.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.Center%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/Tree/Cell.cs/#L256">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_Center_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Center*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_Center" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Center">Center</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 IPoint Center { 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.Shapes.IPoint</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_Tree_Cell_IsLeaf.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.IsLeaf%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/Tree/Cell.cs/#L136">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_IsLeaf_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.IsLeaf*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_IsLeaf" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.IsLeaf">IsLeaf</h4> |
| <div class="markdown level1 summary"><p>For points, this is always false.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsLeaf { 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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_Cell_IsLeaf_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>For points, this is always false. Otherwise this is true if there are no |
| further cells with this prefix for the shape (always true at maxLevels).</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_Level.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.Level%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/Tree/Cell.cs/#L177">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_Level_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Level*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_Level" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Level">Level</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 Level { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_Shape.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.Shape%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/Tree/Cell.cs/#L254">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_Shape_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Shape*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_Shape" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Shape">Shape</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 IShape Shape { 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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_ShapeRel.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.ShapeRel%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/Tree/Cell.cs/#L129">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_ShapeRel_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.ShapeRel*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_ShapeRel" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.ShapeRel">ShapeRel</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 SpatialRelation ShapeRel { 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.Shapes.SpatialRelation</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_Tree_Cell_SubCellsSize.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.SubCellsSize%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/Tree/Cell.cs/#L252">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_SubCellsSize_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.SubCellsSize*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_SubCellsSize" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.SubCellsSize">SubCellsSize</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells">GetSubCells()</a>.Count -- usually a constant. Should be >=2</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 SubCellsSize { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_TokenString.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.TokenString%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/Tree/Cell.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_TokenString_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.TokenString*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_TokenString" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.TokenString">TokenString</h4> |
| <div class="markdown level1 summary"><p>Note: doesn't contain a trailing leaf byte.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string TokenString { 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.String</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_CompareTo_Lucene_Net_Spatial_Prefix_Tree_Cell_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.CompareTo(Lucene.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_beta00010/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs/#L260">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_CompareTo_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.CompareTo*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_CompareTo_Lucene_Net_Spatial_Prefix_Tree_Cell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.CompareTo(Lucene.Net.Spatial.Prefix.Tree.Cell)">CompareTo(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 virtual int CompareTo(Cell o)</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.Cell.html">Cell</a></td> |
| <td><span class="parametername">o</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.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_Tree_Cell_Equals_System_Object_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.Equals(System.Object)%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/Tree/Cell.cs/#L269">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_Equals_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Equals*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_Equals_System_Object_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Equals(System.Object)">Equals(Object)</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 bool Equals(object obj)</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.Object</span></td> |
| <td><span class="parametername">obj</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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.Equals(System.Object)</span></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_Tree_Cell_GetHashCode.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.GetHashCode%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/Tree/Cell.cs/#L275">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetHashCode_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetHashCode*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetHashCode" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetHashCode">GetHashCode()</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 int GetHashCode()</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.GetHashCode()</span></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_Tree_Cell_GetSubCell_Spatial4n_Core_Shapes_IPoint_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCell(Spatial4n.Core.Shapes.IPoint)%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/Tree/Cell.cs/#L238">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCell_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCell*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCell_Spatial4n_Core_Shapes_IPoint_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCell(Spatial4n.Core.Shapes.IPoint)">GetSubCell(IPoint)</h4> |
| <div class="markdown level1 summary"><p>Performant implementations are expected to implement this efficiently by |
| considering the current cell's boundary.</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 GetSubCell(IPoint p)</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> |
| </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_Cell_GetSubCell_Spatial4n_Core_Shapes_IPoint__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Performant implementations are expected to implement this efficiently by |
| considering the current cell's boundary. Precondition: Never called when |
| Level == maxLevel. |
| <p> |
| Precondition: this.Shape.Relate(p) != SpatialRelation.DISJOINT.</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells%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/Tree/Cell.cs/#L247">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells">GetSubCells()</h4> |
| <div class="markdown level1 summary"><p>Gets the cells at the next grid cell level that cover this cell.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected abstract ICollection<Cell> GetSubCells()</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.Collections.Generic.ICollection</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a>></td> |
| <td><p>A set of cells (no dups), sorted, modifiable, not empty, not null.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Gets the cells at the next grid cell level that cover this cell. |
| Precondition: Never called when Level == 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_Spatial4n_Core_Shapes_IShape_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells(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/Tree/Cell.cs/#L193">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells_Spatial4n_Core_Shapes_IShape_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetSubCells(Spatial4n.Core.Shapes.IShape)">GetSubCells(IShape)</h4> |
| <div class="markdown level1 summary"><p>Like <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCells">GetSubCells()</a> but with the results filtered by a shape. If |
| that shape is a <span class="xref">Spatial4n.Core.Shapes.IPoint</span> then it must call |
| <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_GetSubCell_Spatial4n_Core_Shapes_IPoint_">GetSubCell(IPoint)</a>. The returned cells |
| should have <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_ShapeRel">ShapeRel</a> set to their relation with |
| <code data-dev-comment-type="paramref" class="paramref">shapeFilter</code>. In addition, <a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html#Lucene_Net_Spatial_Prefix_Tree_Cell_IsLeaf">IsLeaf</a> |
| must be true when that relation is <span class="xref">Spatial4n.Core.Shapes.SpatialRelation.WITHIN</span>. |
| <p> |
| Precondition: Never called when Level == maxLevel.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ICollection<Cell> GetSubCells(IShape shapeFilter)</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">shapeFilter</span></td> |
| <td><p>an optional filter for the returned 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.ICollection</span><<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.Cell.html">Cell</a>></td> |
| <td><p>A set of cells (no dups), sorted. Not Modifiable.</p> |
| </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_Tree_Cell_GetTokenBytes.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.GetTokenBytes%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/Tree/Cell.cs/#L159">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetTokenBytes_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetTokenBytes*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_GetTokenBytes" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.GetTokenBytes">GetTokenBytes()</h4> |
| <div class="markdown level1 summary"><p>Note: doesn't contain a trailing leaf byte.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual byte[] GetTokenBytes()</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.Byte</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_Tree_Cell_Reset_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.Reset(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_beta00010/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs/#L104">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_Reset_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Reset*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_Reset_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.Reset(System.Byte[],System.Int32,System.Int32)">Reset(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 virtual void Reset(byte[] bytes, int off, 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">off</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> |
| <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_Tree_Cell_SetLeaf.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.SetLeaf%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/Tree/Cell.cs/#L139">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_SetLeaf_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.SetLeaf*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_SetLeaf" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.SetLeaf">SetLeaf()</h4> |
| <div class="markdown level1 summary"><p>Note: not supported at level 0.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetLeaf()</code></pre> |
| </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_Tree_Cell_ToString.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.Tree.Cell.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_beta00010/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs/#L280">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Prefix_Tree_Cell_ToString_" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.ToString*"></a> |
| <h4 id="Lucene_Net_Spatial_Prefix_Tree_Cell_ToString" data-uid="Lucene.Net.Spatial.Prefix.Tree.Cell.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> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IComparable<T></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_Tree_Cell.md&value=---%0Auid%3A%20Lucene.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" 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/Tree/Cell.cs/#L33" 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> |