Index (tinspin-indexes 2.1.2 API)

All Known Subinterfaces:

BoxMap<T>, BoxMultimap<T>, PointMap<T>, PointMultimap<T>

All Known Implementing Classes:

CoverTree, KDTree, PHTreeMMP, PHTreeP, PHTreeR, PointArray, PointMapWrapper, PointMultimapWrapper, QuadTreeKD, QuadTreeKD0, QuadTreeKD2, QuadTreeRKD, QuadTreeRKD0, RectArray, RTree
```
public interface Index
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`Index.BEComparator`
`static class`	`Index.BoxEntry<T>`	A box entry.
`static class`	`Index.BoxEntryKnn<T>`
`static interface`	`Index.BoxFilterKnn<T>`
`static interface`	`Index.BoxIterator<T>`
`static interface`	`Index.BoxIteratorKnn<T>`
`static class`	`Index.PEComparator`
`static class`	`Index.PointEntry<T>`
`static class`	`Index.PointEntryKnn<T>`
`static interface`	`Index.PointFilterKnn<T>`
`static interface`	`Index.PointIterator<T>`
`static interface`	`Index.PointIteratorKnn<T>`
`static interface`	`Index.QueryIterator<T>`
`static interface`	`Index.QueryIteratorKnn<T>`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clear()`	Clear all entries.
`int`	`getDepth()`
`int`	`getDims()`
`int`	`getNodeCount()`
`Stats`	`getStats()`
`int`	`size()`
`String`	`toStringTree()`

- Method Detail
  - getDims
```
int getDims()
```
    Returns:
    
    the number of dimensions
  - size
```
int size()
```
    Returns:
    
    the number of entries
  - clear
```
void clear()
```
    Clear all entries.
  - getStats
```
Stats getStats()
```
    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
```
int getNodeCount()
```
  - getDepth
```
int getDepth()
```
  - toStringTree
```
String toStringTree()
```
    Returns:
    
    a full string output of the tree structure with all entries