KNNHeap (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

All Known Implementing Classes:

DoubleIntegerDBIDKNNHeap
```
public interface KNNHeap
```
Interface for kNN heaps.
To instantiate, use: DBIDUtil.newHeap(int)!

Since:

0.5.5

Author:

Erich Schubert

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear the heap.
`boolean`	`contains(DBIDRef other)` Check if an object is already in the heap.
`int`	`getK()` Get the K parameter ("maxsize" internally).
`double`	`getKNNDistance()` Get the distance to the k nearest neighbor, or maxdist otherwise.
`void`	`insert(DoubleDBIDPair e)` Add a distance-id pair to the heap unless the distance is too large.
`double`	`insert(double distance, DBIDRef id)` Add a distance-id pair to the heap unless the distance is too large.
`default boolean`	`isEmpty()` Test if the heap is empty.
`int`	`size()` Current size of heap.
`KNNList`	`toKNNList()` Serialize to a `KNNList`.
`KNNList`	`toKNNListSqrt()` Serialize to a `KNNList`, but applying sqrt to every distance.
`DoubleDBIDListIter`	`unorderedIterator()` Unordered iterator over the heap.

- Method Detail
  - toKNNList
```
KNNList toKNNList()
```
    Serialize to a KNNList. This empties the heap!
    
    Returns:
    
    KNNList with the heaps contents.
  - toKNNListSqrt
```
KNNList toKNNListSqrt()
```
    Serialize to a KNNList, but applying sqrt to every distance. This empties the heap!
    
    Returns:
    
    KNNList with the heaps contents.
  - getK
```
int getK()
```
    Get the K parameter ("maxsize" internally).
    
    Returns:
    
    K
  - getKNNDistance
```
double getKNNDistance()
```
    Get the distance to the k nearest neighbor, or maxdist otherwise.
    
    Returns:
    
    Maximum distance
  - insert
```
double insert(double distance,
              DBIDRef id)
```
    Add a distance-id pair to the heap unless the distance is too large.
    Compared to the super.add() method, this often saves the pair construction.
    
    Parameters:
    
    distance - Distance value
    
    id - ID number
    
    Returns:
    
    current k-distance
  - insert
```
void insert(DoubleDBIDPair e)
```
    Add a distance-id pair to the heap unless the distance is too large.
    Use for existing pairs.
    
    Parameters:
    
    e - Existing distance pair
  - size
```
int size()
```
    Current size of heap.
    
    Returns:
    
    Heap size
  - isEmpty
```
default boolean isEmpty()
```
    Test if the heap is empty.
    
    Returns:
    
    true when empty.
  - clear
```
void clear()
```
    Clear the heap.
  - unorderedIterator
```
DoubleDBIDListIter unorderedIterator()
```
    Unordered iterator over the heap.
    
    Returns:
    
    Iterator
  - contains
```
boolean contains(DBIDRef other)
```
    Check if an object is already in the heap.
    
    Parameters:
    
    other - Other object
    
    Returns:
    
    true if contained

Interface KNNHeap

Method Summary

Method Detail

toKNNList

toKNNListSqrt

getK

getKNNDistance

insert

insert

size

isEmpty

clear

unorderedIterator

contains