Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class QuadPrefixTree

    A SpatialPrefixTree which uses a quad tree in which an indexed term will be generated for each cell, 'A', 'B', 'C', 'D'.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    System.Object
    SpatialPrefixTree
    QuadPrefixTree
    Inherited Members
    SpatialPrefixTree.m_maxLevels
    SpatialPrefixTree.m_ctx
    SpatialPrefixTree.SpatialContext
    SpatialPrefixTree.MaxLevels
    SpatialPrefixTree.ToString()
    SpatialPrefixTree.GetDistanceForLevel(Int32)
    SpatialPrefixTree.WorldCell
    SpatialPrefixTree.GetCell(Byte[], Int32, Int32, Cell)
    SpatialPrefixTree.GetCells(IShape, Int32, Boolean, Boolean)
    SpatialPrefixTree.GetCells(IPoint, Int32, Boolean)
    SpatialPrefixTree.CellsToTokenStrings(ICollection<Cell>)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Lucene.Net.Spatial.Prefix.Tree
    Assembly: Lucene.Net.Spatial.dll
    Syntax
    public class QuadPrefixTree : SpatialPrefixTree

    Constructors

    | Improve this Doc View Source

    QuadPrefixTree(SpatialContext)

    Initializes a new instance of QuadPrefixTree with the specified spatial context (ctx).

    Declaration
    public QuadPrefixTree(SpatialContext ctx)
    Parameters
    Type Name Description
    Spatial4n.Context.SpatialContext ctx

    The spatial context.

    Exceptions
    Type Condition
    System.ArgumentNullException

    ctx is null.

    | Improve this Doc View Source

    QuadPrefixTree(SpatialContext, IRectangle, Int32)

    Initializes a new instance of QuadPrefixTree with the specified spatial context (ctx), bounds and maxLevels.

    Declaration
    public QuadPrefixTree(SpatialContext ctx, IRectangle bounds, int maxLevels)
    Parameters
    Type Name Description
    Spatial4n.Context.SpatialContext ctx

    The spatial context.

    Spatial4n.Shapes.IRectangle bounds

    The bounded rectangle.

    System.Int32 maxLevels

    The maximum number of levels in the tree.

    Exceptions
    Type Condition
    System.ArgumentNullException

    ctx or bounds is null.

    System.ArgumentOutOfRangeException

    maxLevels is less than or equal to 0.

    | Improve this Doc View Source

    QuadPrefixTree(SpatialContext, Int32)

    Initializes a new instance of QuadPrefixTree with the specified spatial context (ctx) and maxLevels.

    Declaration
    public QuadPrefixTree(SpatialContext ctx, int maxLevels)
    Parameters
    Type Name Description
    Spatial4n.Context.SpatialContext ctx

    The spatial context.

    System.Int32 maxLevels

    The maximum number of levels in the tree.

    Exceptions
    Type Condition
    System.ArgumentNullException

    ctx is null.

    System.ArgumentOutOfRangeException

    maxLevels is less than or equal to 0.

    Fields

    | Improve this Doc View Source

    DEFAULT_MAX_LEVELS

    Declaration
    public const int DEFAULT_MAX_LEVELS = 12
    Field Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    MAX_LEVELS_POSSIBLE

    Declaration
    public const int MAX_LEVELS_POSSIBLE = 50
    Field Value
    Type Description
    System.Int32

    Properties

    | Improve this Doc View Source

    GridH

    Declaration
    public double GridH { get; }
    Property Value
    Type Description
    System.Double

    Methods

    | Improve this Doc View Source

    GetCell(IPoint, Int32)

    Declaration
    protected override Cell GetCell(IPoint p, int level)
    Parameters
    Type Name Description
    Spatial4n.Shapes.IPoint p
    System.Int32 level
    Returns
    Type Description
    Cell
    Overrides
    SpatialPrefixTree.GetCell(IPoint, Int32)
    | Improve this Doc View Source

    GetCell(Byte[], Int32, Int32)

    Declaration
    public override Cell GetCell(byte[] bytes, int offset, int length)
    Parameters
    Type Name Description
    System.Byte[] bytes
    System.Int32 offset
    System.Int32 length
    Returns
    Type Description
    Cell
    Overrides
    SpatialPrefixTree.GetCell(Byte[], Int32, Int32)
    | Improve this Doc View Source

    GetCell(String)

    Declaration
    public override Cell GetCell(string token)
    Parameters
    Type Name Description
    System.String token
    Returns
    Type Description
    Cell
    Overrides
    SpatialPrefixTree.GetCell(String)
    | Improve this Doc View Source

    GetLevelForDistance(Double)

    Declaration
    public override int GetLevelForDistance(double dist)
    Parameters
    Type Name Description
    System.Double dist
    Returns
    Type Description
    System.Int32
    Overrides
    SpatialPrefixTree.GetLevelForDistance(Double)
    | Improve this Doc View Source

    PrintInfo(TextWriter)

    Declaration
    public virtual void PrintInfo(TextWriter output)
    Parameters
    Type Name Description
    System.IO.TextWriter output
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.