Package org.tinspin.index.qthypercube

Class QuadTreeRKD<T>

java.lang.Object

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

Type Parameters:

T - Value type.

All Implemented Interfaces:

Index<T>, RectangleIndex<T>, RectangleIndexMM<T>

public class QuadTreeRKD<T>
extends Object
implements RectangleIndex<T>, RectangleIndexMM<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	Description
static boolean	DEBUG

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all elements from the tree.
boolean	contains(double[] lower, double[] upper, T value)	Lookup an entry, using exact match.
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)	Deprecated.
RectangleEntryDist<T>	query1NN(double[] center)	Finds the nearest neighbor.
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'.
QueryIteratorKNN<RectangleEntryDist<T>>	queryKNN(double[] center, int k)	Finds the nearest neighbor.
QueryIteratorKNN<RectangleEntryDist<T>>	queryKNN(double[] center, int k, RectangleDistanceFunction distFn)	Finds the nearest neighbor.
QueryIterator<RectangleEntry<T>>	queryRectangle(double[] lower, double[] upper)	Lookup an entry, using exact match.
T	remove(double[] keyL, double[] keyU)	Remove a key.
boolean	remove(double[] lower, double[] upper, T value)	Remove *one*n entry with the given value.
boolean	removeIf(double[] lower, double[] upper, Predicate<RectangleEntry<T>> condition)	Remove *one* entry with the given condition.
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.
boolean	update(double[] oldKeyL, double[] oldKeyU, double[] newKeyL, double[] newKeyU, T value)	Update the position of an entry.

Methods inherited from class java.lang.Object

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

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>

Specified by:

insert in interface RectangleIndexMM<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

contains

public boolean contains(double[] lower,
                        double[] upper,
                        T value)

Description copied from interface: RectangleIndexMM

Lookup an entry, using exact match.

Specified by:

contains in interface RectangleIndexMM<T>

Parameters:

lower - minimum corner

upper - maximum corner

value - the value

Returns:

`true` if an entry was found, otherwise `false`.

queryRectangle

public QueryIterator<RectangleEntry<T>> queryRectangle(double[] lower,
                                                       double[] upper)

Description copied from interface: RectangleIndexMM

Lookup an entry, using exact match.

Specified by:

queryRectangle in interface RectangleIndexMM<T>

Parameters:

lower - minimum corner

upper - maximum corner

Returns:

an iterator over all entries at with the exact given rectangle

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

remove

public boolean remove(double[] lower,
                      double[] upper,
                      T value)

Description copied from interface: RectangleIndexMM

Remove *one*n entry with the given value.

Specified by:

remove in interface RectangleIndexMM<T>

Parameters:

lower - minimum corner

upper - maximum corner

value - value

Returns:

the value of the entry or null if the entry was not found

removeIf

public boolean removeIf(double[] lower,
                        double[] upper,
                        Predicate<RectangleEntry<T>> condition)

Description copied from interface: RectangleIndexMM

Remove *one* entry with the given condition.

Specified by:

removeIf in interface RectangleIndexMM<T>

Parameters:

lower - minimum corner

upper - maximum corner

condition - the condition required for removing an entry

Returns:

the value of the entry or null if the entry was not found

update

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

Description copied from interface: RectangleIndexMM

Update the position of an entry.

Specified by:

update in interface RectangleIndexMM<T>

Parameters:

oldKeyL - old min

oldKeyU - old max

newKeyL - new min

newKeyU - new max

value - only entries with this value are updated

Returns:

the value, or null if the entries 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>

Specified by:

queryIntersect in interface RectangleIndexMM<T>

Parameters:

min - lower left corner of query

max - upper right corner of query

Returns:

all entries in the rectangle

query1NN

public RectangleEntryDist<T> query1NN(double[] center)

Description copied from interface: RectangleIndex

Finds the nearest neighbor. This uses euclidean 'edge distance'. Other distance types can only be specified directly on the index implementations.

Specified by:

query1NN in interface RectangleIndex<T>

Specified by:

query1NN in interface RectangleIndexMM<T>

Parameters:

center - center point

Returns:

the nearest neighbor

knnQuery

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

Deprecated.

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>

Returns:

Collect and return some index statistics. Note that indexes are not required to fill all fields. Also, individual indexes may use subclasses with additional fields.

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>

Specified by:

iterator in interface RectangleIndexMM<T>

Returns:

An iterator over all entries.

queryKNN

public QueryIteratorKNN<RectangleEntryDist<T>> 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>

Specified by:

queryKNN in interface RectangleIndexMM<T>

Parameters:

center - center point

k - number of neighbors

Returns:

list of nearest neighbors

queryKNN

public QueryIteratorKNN<RectangleEntryDist<T>> queryKNN(double[] center,
                                                        int k,
                                                        RectangleDistanceFunction distFn)

Description copied from interface: RectangleIndexMM

Finds the nearest neighbor. This uses a custom distance function for distances to rectangles.

Specified by:

queryKNN in interface RectangleIndexMM<T>

Parameters:

center - center point

k - number of neighbors

distFn - distance function

Returns:

list of nearest neighbors

getDepth

public int getDepth()

Specified by:

getDepth in interface Index<T>

getRoot

protected QRNode<T> getRoot()