org.tinspin.index.qthypercube

Class QuadTreeRKD<T>

java.lang.Object

org.tinspin.index.qthypercube.QuadTreeRKD<T>

Type Parameters:

T -

All Implemented Interfaces:

Index<T>, RectangleIndex<T>

public class QuadTreeRKD<T>
extends Object
implements RectangleIndex<T>

A simple MX-quadtree implementation with configurable maximum depth, maximum nodes size, and (if desired) automatic guessing of root rectangle.

Author:

ztilmann

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all elements from the tree.
boolean	containsExact(double[] keyL, double[] keyU) Check whether a given key exists.
static <T> QuadTreeRKD<T>	create(int dims)
static <T> QuadTreeRKD<T>	create(int dims, int maxNodeSize) Deprecated.
static <T> QuadTreeRKD<T>	create(int dims, int maxNodeSize, double[] center, double radius)
static <T> QuadTreeRKD<T>	create(int dims, int maxNodeSize, double[] min, double[] max)
int	getDepth()
int	getDims()
int	getNodeCount()
protected QRNode<T>	getRoot()
QuadTreeKD.QStats	getStats()
void	insert(double[] keyL, double[] keyU, T value) Insert a key-value pair.
QueryIterator<RectangleEntry<T>>	iterator()
List<QREntryDist<T>>	knnQuery(double[] center, int k)
T	queryExact(double[] keyL, double[] keyU) Get the value associates with the key.
QRIterator<T>	queryIntersect(double[] min, double[] max) Query the tree, returning all points in the axis-aligned rectangle between 'min' and 'max'.
org.tinspin.index.qthypercube.QuadTreeRKD.QRQueryIteratorKNN	queryKNN(double[] center, int k) Finds the nearest neighbor.
T	remove(double[] keyL, double[] keyU) Remove a key.
int	size() Get the number of key-value pairs in the tree.
String	toString()
String	toStringTree() Returns a printable list of the tree.
T	update(double[] oldKeyL, double[] oldKeyU, double[] newKeyL, double[] newKeyU) Reinsert the key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tinspin.index.RectangleIndex

query1NN

Field Detail

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

Method Detail

create

public static <T> QuadTreeRKD<T> create(int dims)

create

@Deprecated
public static <T> QuadTreeRKD<T> create(int dims,
                                                     int maxNodeSize)

Deprecated.

create

public static <T> QuadTreeRKD<T> create(int dims,
                                        int maxNodeSize,
                                        double[] min,
                                        double[] max)

create

public static <T> QuadTreeRKD<T> create(int dims,
                                        int maxNodeSize,
                                        double[] center,
                                        double radius)

insert

public void insert(double[] keyL,
                   double[] keyU,
                   T value)

Insert a key-value pair.

Specified by:

insert in interface RectangleIndex<T>

Parameters:

keyL - the lower part of the key

keyU - the upper part of the key

value - the value

containsExact

public boolean containsExact(double[] keyL,
                             double[] keyU)

Check whether a given key exists.

Parameters:

keyL - the lower key to check

keyU - the upper key to check

Returns:

true iff the key exists

queryExact

public T queryExact(double[] keyL,
                    double[] keyU)

Get the value associates with the key.

Specified by:

queryExact in interface RectangleIndex<T>

Parameters:

keyL - the lower key to look up

keyU - the upper key to look up

Returns:

the value for the key or 'null' if the key was not found

remove

public T remove(double[] keyL,
                double[] keyU)

Remove a key.

Specified by:

remove in interface RectangleIndex<T>

Parameters:

keyL - key to remove

keyU - key to remove

Returns:

the value associated with the key or 'null' if the key was not found

update

public T update(double[] oldKeyL,
                double[] oldKeyU,
                double[] newKeyL,
                double[] newKeyU)

Reinsert the key.

Specified by:

update in interface RectangleIndex<T>

Parameters:

oldKeyL - old key

oldKeyU - old key

newKeyL - new key

newKeyU - new key

Returns:

the value associated with the key or 'null' if the key was not found.

size

public int size()

Get the number of key-value pairs in the tree.

Specified by:

size in interface Index<T>

Returns:

the size

clear

public void clear()

Removes all elements from the tree.

Specified by:

clear in interface Index<T>

queryIntersect

public QRIterator<T> queryIntersect(double[] min,
                                    double[] max)

Query the tree, returning all points in the axis-aligned rectangle between 'min' and 'max'.

Specified by:

queryIntersect in interface RectangleIndex<T>

Parameters:

min - lower left corner of query

max - upper right corner of query

Returns:

all entries in the rectangle

knnQuery

public List<QREntryDist<T>> knnQuery(double[] center,
                                     int k)

toStringTree

public String toStringTree()

Returns a printable list of the tree.

Specified by:

toStringTree in interface Index<T>

Returns:

the tree as String

toString

public String toString()

Overrides:

toString in class Object

getStats

public QuadTreeKD.QStats getStats()

Specified by:

getStats in interface Index<T>

getDims

public int getDims()

Specified by:

getDims in interface Index<T>

Returns:

the number of dimensions

getNodeCount

public int getNodeCount()

Specified by:

getNodeCount in interface Index<T>

iterator

public QueryIterator<RectangleEntry<T>> iterator()

Specified by:

iterator in interface RectangleIndex<T>

Returns:

An iterator over all entries.

queryKNN

public org.tinspin.index.qthypercube.QuadTreeRKD.QRQueryIteratorKNN queryKNN(double[] center,
                                                                             int k)

Description copied from interface: RectangleIndex

Finds the nearest neighbor. This uses euclidean 'edge distance', i.e. the distance to the edge of rectangle. Distance is 0 is the rectangle overlaps with the search point. Other distance types can only be specified directly on the index implementations.

Specified by:

queryKNN in interface RectangleIndex<T>

Parameters:

center - center point

k - number of neighbors

Returns:

list of nearest neighbors

getDepth

public int getDepth()

Specified by:

getDepth in interface Index<T>

getRoot

protected QRNode<T> getRoot()