Package org.tinspin.index.array

Class PointArray<T>

java.lang.Object

org.tinspin.index.array.PointArray<T>

All Implemented Interfaces:

Index, PointMap<T>, PointMultimap<T>

public class PointArray<T>
extends Object
implements PointMap<T>, PointMultimap<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

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

PointMultimap.Factory

Constructor Summary

Constructors

Constructor	Description
PointArray(int dims, int size)	Setup of a simple array data structure (no indexing).

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all entries.
boolean	contains(double[] key)	Lookup an entry, using exact match.
boolean	contains(double[] point, T value)	Lookup an entry, using exact match.
int	getDepth()
int	getDims()
int	getNodeCount()
Stats	getStats()
void	insert(double[] key, T value)	Insert a point.
Index.PointIterator<T>	iterator()
org.tinspin.index.array.PointArray.AQueryIterator	query(double[] min, double[] max)
Index.PointEntryKnn<T>	query1nn(double[] center)	Finds the nearest neighbor.
T	queryExact(double[] point)	Lookup an entry, using exact match.
Index.PointIterator<T>	queryExactPoint(double[] point)	Lookup an entries at a given coordinate.
org.tinspin.index.array.PointArray.AQueryIteratorKnn	queryKnn(double[] center, int k)	Finds the nearest neighbor.
Index.PointIteratorKnn<T>	queryKnn(double[] center, int k, PointDistance distFn)	Finds the nearest neighbor.
T	remove(double[] point)	Remove a point entry.
boolean	remove(double[] point, T value)	Remove *one* entry with the given value.
boolean	removeIf(double[] point, Predicate<Index.PointEntry<T>> condition)	Remove *one* entry with the given condition.
int	size()
String	toString()
String	toStringTree()
T	update(double[] oldPoint, double[] newPoint)	Update the position of an entry.
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, wait, wait, wait

Constructor Detail

PointArray

public PointArray(int dims,
                  int size)

Setup of a simple array data structure (no indexing).

Parameters:

dims - dimensions

size - size

Method Detail

insert

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

Description copied from interface: PointMap

Insert a point.

Specified by:

insert in interface PointMap<T>

Specified by:

insert in interface PointMultimap<T>

Parameters:

key - point

value - value

remove

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

Description copied from interface: PointMultimap

Remove *one* entry with the given value.

Specified by:

remove in interface PointMultimap<T>

Parameters:

point - 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<Index.PointEntry<T>> condition)

Description copied from interface: PointMultimap

Remove *one* entry with the given condition.

Specified by:

removeIf in interface PointMultimap<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

queryExactPoint

public Index.PointIterator<T> queryExactPoint(double[] point)

Description copied from interface: PointMultimap

Lookup an entries at a given coordinate.

Specified by:

queryExactPoint in interface PointMultimap<T>

Parameters:

point - the point

Returns:

an iterator over all entries at the given point

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

contains

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

Description copied from interface: PointMultimap

Lookup an entry, using exact match.

Specified by:

contains in interface PointMultimap<T>

Parameters:

point - the point

value - the value

Returns:

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

query

public org.tinspin.index.array.PointArray.AQueryIterator query(double[] min,
                                                               double[] max)

Specified by:

query in interface PointMap<T>

Specified by:

query in interface PointMultimap<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.

query1nn

public Index.PointEntryKnn<T> query1nn(double[] center)

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:

query1nn in interface PointMap<T>

Specified by:

query1nn in interface PointMultimap<T>

Parameters:

center - center point

Returns:

the nearest neighbor

iterator

public Index.PointIterator<T> iterator()

Specified by:

iterator in interface PointMap<T>

Specified by:

iterator in interface PointMultimap<T>

Returns:

An iterator over all entries.

queryKnn

public org.tinspin.index.array.PointArray.AQueryIteratorKnn 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>

Specified by:

queryKnn in interface PointMultimap<T>

Parameters:

center - center point

k - number of neighbors

Returns:

list of nearest neighbors

queryKnn

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

Description copied from interface: PointMultimap

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

Parameters:

center - center point

k - number of neighbors

distFn - the point distance function to be used

Returns:

list of nearest neighbors

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

update

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

Description copied from interface: PointMultimap

Update the position of an entry.

Specified by:

update in interface PointMultimap<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

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

toString

public String toString()

Overrides:

toString in class Object

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