PointIndexWrapper (tinspin-indexes 1.7.0 API)

java.lang.Object
- org.tinspin.index.PointIndexWrapper<T>

All Implemented Interfaces:: Index<T>, PointIndex<T>

public class PointIndexWrapper<T>
extends Object
implements PointIndex<T>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear all entries.
`static <T> PointIndex<T>`	`create(RectangleIndex<T> ind)`
`int`	`getDepth()`
`int`	`getDims()`
`int`	`getNodeCount()`
`Stats`	`getStats()`
`void`	`insert(double[] key, T value)` Insert a point.
`QueryIterator<PointEntry<T>>`	`iterator()`
`void`	`load(Entry<T>[] entries)`
`QueryIterator<PointEntry<T>>`	`query(double[] min, double[] max)`
`PointEntryDist<T>`	`query1NN(double[] center)` Finds the nearest neighbor.
`T`	`queryExact(double[] point)` Lookup an entry, using exact match.
`QueryIteratorKNN<PointEntryDist<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

- Method Detail
  - create
```
public static <T> PointIndex<T> create(RectangleIndex<T> ind)
```
  - iterator
```
public QueryIterator<PointEntry<T>> iterator()
```
    Specified by:
    
    iterator in interface PointIndex<T>
    
    Returns:
    
    An iterator over all entries.
  - query
```
public QueryIterator<PointEntry<T>> query(double[] min,
                                          double[] max)
```
    Specified by:
    
    query in interface PointIndex<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 PointEntryDist<T> query1NN(double[] center)
```
    Description copied from interface: PointIndex
    
    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 PointIndex<T>
    
    Parameters:
    
    center - center point
    
    Returns:
    
    the nearest neighbor
  - queryKNN
```
public QueryIteratorKNN<PointEntryDist<T>> queryKNN(double[] center,
                                                    int k)
```
    Description copied from interface: PointIndex
    
    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 PointIndex<T>
    
    Parameters:
    
    center - center point
    
    k - number of neighbors
    
    Returns:
    
    list of nearest neighbors
  - insert
```
public void insert(double[] key,
                   T value)
```
    Description copied from interface: PointIndex
    
    Insert a point.
    
    Specified by:
    
    insert in interface PointIndex<T>
    
    Parameters:
    
    key - point
    
    value - value
  - remove
```
public T remove(double[] point)
```
    Description copied from interface: PointIndex
    
    Remove a point entry.
    
    Specified by:
    
    remove in interface PointIndex<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: PointIndex
    
    Update the position of an entry.
    
    Specified by:
    
    update in interface PointIndex<T>
    
    Parameters:
    
    oldPoint - old position
    
    newPoint - new position
    
    Returns:
    
    the value of the entry or null if the entry was not found
  - queryExact
```
public T queryExact(double[] point)
```
    Description copied from interface: PointIndex
    
    Lookup an entry, using exact match.
    
    Specified by:
    
    queryExact in interface PointIndex<T>
    
    Parameters:
    
    point - the point
    
    Returns:
    
    the value of the entry or null if the entry was not found
  - 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>
  - load
```
public void load(Entry<T>[] entries)
```
  - toStringTree
```
public String toStringTree()
```
    Specified by:
    
    toStringTree in interface Index<T>
    
    Returns:
    
    a full string output of the tree structure with all entries

Class PointIndexWrapper<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

iterator

query

query1NN

queryKNN

insert

remove

update

queryExact

getDims

size

clear

getStats

getNodeCount

getDepth

load

toStringTree