Package org.tinspin.index.phtree

Class PHTreeMMP<T>

java.lang.Object

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

Type Parameters:

T - The value type associated with each entry.

All Implemented Interfaces:

Index<T>, PointIndexMM<T>

public class PHTreeMMP<T>
extends Object
implements PointIndexMM<T>

Multimap version of the PH-Tree.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all entries.
boolean	contains(double[] point, T value)	Lookup an entry, using exact match.
static <T> PHTreeMMP<T>	create(int dims)
int	getDepth()
int	getDims()
int	getNodeCount()
Stats	getStats()
void	insert(double[] key, T value)	Insert a point.
QueryIterator<PointEntry<T>>	iterator()
QueryIterator<PointEntry<T>>	query(double[] key)	Lookup an entries at a given coordinate.
QueryIterator<PointEntry<T>>	query(double[] min, double[] max)
QueryIteratorKNN<PointEntryDist<T>>	queryKNN(double[] center, int k)	Finds the nearest neighbor.
QueryIteratorKNN<PointEntryDist<T>>	queryKNN(double[] center, int k, PointDistanceFunction distFn)	Finds the nearest neighbor.
boolean	remove(double[] key, T value)	Remove *one* entry with the given value.
boolean	removeIf(double[] point, Predicate<PointEntry<T>> condition)	Remove *one* entry with the given condition.
int	size()
String	toStringTree()
boolean	update(double[] oldPoint, double[] newPoint, T value)	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.PointIndexMM

query1NN

Method Detail

create

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

getDims

public int getDims()

Specified by:

getDims in interface Index<T>

Returns:

the number of dimensions

size

public int size()

Specified by:

size in interface Index<T>

Returns:

the number of entries

clear

public void clear()

Description copied from interface: Index

Clear all entries.

Specified by:

clear in interface Index<T>

getStats

public Stats 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.

getNodeCount

public int getNodeCount()

Specified by:

getNodeCount in interface Index<T>

getDepth

public int getDepth()

Specified by:

getDepth in interface Index<T>

toStringTree

public String toStringTree()

Specified by:

toStringTree in interface Index<T>

Returns:

a full string output of the tree structure with all entries

insert

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

Description copied from interface: PointIndexMM

Insert a point.

Specified by:

insert in interface PointIndexMM<T>

Parameters:

key - point

value - value

remove

public boolean remove(double[] key,
                      T value)

Description copied from interface: PointIndexMM

Remove *one* entry with the given value.

Specified by:

remove in interface PointIndexMM<T>

Parameters:

key - the point

value - only entries with this value are removed

Returns:

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

removeIf

public boolean removeIf(double[] point,
                        Predicate<PointEntry<T>> condition)

Description copied from interface: PointIndexMM

Remove *one* entry with the given condition.

Specified by:

removeIf in interface PointIndexMM<T>

Parameters:

point - the point

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[] oldPoint,
                      double[] newPoint,
                      T value)

Description copied from interface: PointIndexMM

Update the position of an entry.

Specified by:

update in interface PointIndexMM<T>

Parameters:

oldPoint - old position

newPoint - new position

value - only entries with this value are updated

Returns:

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

contains

public boolean contains(double[] point,
                        T value)

Description copied from interface: PointIndexMM

Lookup an entry, using exact match.

Specified by:

contains in interface PointIndexMM<T>

Parameters:

point - the point

value - the value

Returns:

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

query

public QueryIterator<PointEntry<T>> query(double[] key)

Description copied from interface: PointIndexMM

Lookup an entries at a given coordinate.

Specified by:

query in interface PointIndexMM<T>

Parameters:

key - the point

Returns:

an iterator over all entries at the given point

query

public QueryIterator<PointEntry<T>> query(double[] min,
                                          double[] max)

Specified by:

query in interface PointIndexMM<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 QueryIterator<PointEntry<T>> iterator()

Specified by:

iterator in interface PointIndexMM<T>

Returns:

An iterator over all entries.

queryKNN

public QueryIteratorKNN<PointEntryDist<T>> queryKNN(double[] center,
                                                    int k)

Description copied from interface: PointIndexMM

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 PointIndexMM<T>

Parameters:

center - center point

k - number of neighbors

Returns:

list of nearest neighbors

queryKNN

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

Description copied from interface: PointIndexMM

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 PointIndexMM<T>

Parameters:

center - center point

k - number of neighbors

distFn - the point distance function to be used

Returns:

list of nearest neighbors