Package org.tinspin.index.phtree

Class PHTreeP<T>

java.lang.Object

org.tinspin.index.phtree.PHTreeP<T>

All Implemented Interfaces:

Index, PointMap<T>

public class PHTreeP<T>
extends Object
implements PointMap<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.tinspin.index.Index

Index.BEComparator, Index.BoxEntry<T>, Index.BoxEntryKnn<T>, Index.BoxFilterKnn<T>, Index.BoxIterator<T>, Index.BoxIteratorKnn<T>, Index.PEComparator, Index.PointEntry<T>, Index.PointEntryKnn<T>, Index.PointFilterKnn<T>, Index.PointIterator<T>, Index.PointIteratorKnn<T>, Index.QueryIterator<T>, Index.QueryIteratorKnn<T>

Nested classes/interfaces inherited from interface org.tinspin.index.PointMap

PointMap.Factory

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all entries.
boolean	contains(double[] key)	Lookup an entry, using exact match.
static <T> PHTreeP<T>	create(int dims)
int	getDepth()
int	getDims()
int	getNodeCount()
Stats	getStats()
void	insert(double[] key, T value)	Insert a point.
Index.PointIterator<T>	iterator()
Index.PointIterator<T>	query(double[] min, double[] max)
T	queryExact(double[] point)	Lookup an entry, using exact match.
Index.PointIteratorKnn<T>	queryKnn(double[] center, int k)	Finds the nearest neighbor.
T	remove(double[] point)	Remove a point entry.
int	size()
String	toStringTree()
T	update(double[] oldPoint, double[] newPoint)	Update the position of an entry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tinspin.index.PointMap

query1nn

Method Detail

create

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

getDims

public int getDims()

Specified by:

getDims in interface Index

Returns:

the number of dimensions

size

public int size()

Specified by:

size in interface Index

Returns:

the number of entries

clear

public void clear()

Description copied from interface: Index

Clear all entries.

Specified by:

clear in interface Index

getStats

public Stats getStats()

Specified by:

getStats in interface Index

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.

getNodeCount

public int getNodeCount()

Specified by:

getNodeCount in interface Index

getDepth

public int getDepth()

Specified by:

getDepth in interface Index

toStringTree

public String toStringTree()

Specified by:

toStringTree in interface Index

Returns:

a full string output of the tree structure with all entries

insert

public void insert(double[] key,
                   T value)

Description copied from interface: PointMap

Insert a point.

Specified by:

insert in interface PointMap<T>

Parameters:

key - point

value - value

remove

public T remove(double[] point)

Description copied from interface: PointMap

Remove a point entry.

Specified by:

remove in interface PointMap<T>

Parameters:

point - the point

Returns:

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

update

public T update(double[] oldPoint,
                double[] newPoint)

Description copied from interface: PointMap

Update the position of an entry.

Specified by:

update in interface PointMap<T>

Parameters:

oldPoint - old position

newPoint - new position

Returns:

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

contains

public boolean contains(double[] key)

Description copied from interface: PointMap

Lookup an entry, using exact match.

Specified by:

contains in interface PointMap<T>

Parameters:

key - the point

Returns:

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

queryExact

public T queryExact(double[] point)

Description copied from interface: PointMap

Lookup an entry, using exact match.

Specified by:

queryExact in interface PointMap<T>

Parameters:

point - the point

Returns:

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

query

public Index.PointIterator<T> query(double[] min,
                                    double[] max)

Specified by:

query in interface PointMap<T>

Parameters:

min - Lower left corner of the query window

max - Upper right corner of the query window

Returns:

All points that lie inside the query rectangle.

iterator

public Index.PointIterator<T> iterator()

Specified by:

iterator in interface PointMap<T>

Returns:

An iterator over all entries.

queryKnn

public Index.PointIteratorKnn<T> queryKnn(double[] center,
                                          int k)

Description copied from interface: PointMap

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

Specified by:

queryKnn in interface PointMap<T>

Parameters:

center - center point

k - number of neighbors

Returns:

list of nearest neighbors