Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree Class Referenceabstract

A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings at variable lengths corresponding to variable precision. Each string corresponds to a spatial region. More...

Inherited by Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree, and Lucene.Net.Spatial.Prefix.Tree.QuadPrefixTree.

Public Member Functions

SpatialContext GetSpatialContext ()
 
int GetMaxLevels ()
 
override String ToString ()
 
abstract int GetLevelForDistance (double dist)
 Returns the level of the largest grid in which its longest side is less than or equal to the provided distance (in degrees). Consequently dist 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.
 
Node GetWorldNode ()
 
abstract Node GetNode (String token)
 
abstract Node GetNode (byte[] bytes, int offset, int len)
 
Node GetNode (string token, Node target)
 
virtual IList< NodeGetNodes (Shape shape, int detailLevel, bool inclParents)
 

Static Public Member Functions

static List< String > NodesToTokenStrings (Collection< Node > nodes)
 

Protected Member Functions

 SpatialPrefixTree (SpatialContext ctx, int maxLevels)
 
virtual Node GetNode (Point p, int level)
 
virtual IList< NodeGetNodesAltPoint (Point p, int detailLevel, bool inclParents)
 

Protected Attributes

readonly int maxLevels
 

Detailed Description

A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings at variable lengths corresponding to variable precision. Each string corresponds to a spatial region.

Implementations of this class should be thread-safe and immutable once initialized.

Definition at line 35 of file SpatialPrefixTree.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.SpatialPrefixTree ( SpatialContext  ctx,
int  maxLevels 
)
protected

Definition at line 40 of file SpatialPrefixTree.cs.

Member Function Documentation

abstract int Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetLevelForDistance ( double  dist)
pure virtual

Returns the level of the largest grid in which its longest side is less than or equal to the provided distance (in degrees). Consequently dist 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.

Parameters
dist>= 0
Returns
level [1 to maxLevels]

Implemented in Lucene.Net.Spatial.Prefix.Tree.QuadPrefixTree, and Lucene.Net.Spatial.Prefix.Tree.GeohashPrefixTree.

int Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetMaxLevels ( )

Definition at line 52 of file SpatialPrefixTree.cs.

abstract Node Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNode ( String  token)
pure virtual
abstract Node Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNode ( byte[]  bytes,
int  offset,
int  len 
)
pure virtual
Node Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNode ( string  token,
Node  target 
)

Definition at line 112 of file SpatialPrefixTree.cs.

virtual Node Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNode ( Point  p,
int  level 
)
protectedvirtual
virtual IList<Node> Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNodes ( Shape  shape,
int  detailLevel,
bool  inclParents 
)
virtual
virtual IList<Node> Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetNodesAltPoint ( Point  p,
int  detailLevel,
bool  inclParents 
)
protectedvirtual

Definition at line 231 of file SpatialPrefixTree.cs.

SpatialContext Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetSpatialContext ( )

Definition at line 47 of file SpatialPrefixTree.cs.

Node Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.GetWorldNode ( )

Definition at line 84 of file SpatialPrefixTree.cs.

static List<String> Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.NodesToTokenStrings ( Collection< Node nodes)
static

Definition at line 257 of file SpatialPrefixTree.cs.

override String Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.ToString ( )

Definition at line 57 of file SpatialPrefixTree.cs.

Member Data Documentation

readonly int Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.maxLevels
protected

Definition at line 37 of file SpatialPrefixTree.cs.


The documentation for this class was generated from the following file: