de.lmu.ifi.dbs.elki.database.ids.distance

Interface DoubleDistanceKNNHeap

All Superinterfaces:

KNNHeap<DoubleDistance>

All Known Implementing Classes:

DoubleDistanceDBIDPairKNNHeap, DoubleDistanceIntegerDBIDKNNHeap, DoubleDistanceIntegerDBIDKNNListHeap

public interface DoubleDistanceKNNHeap
extends KNNHeap<DoubleDistance>

Interface for kNN heaps storing double distances and DBIDs.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double distance, DBIDRef id) Add a distance-id pair to the heap unless the distance is too large.
void	add(Double distance, DBIDRef id) Deprecated.
void	add(DoubleDistanceDBIDPair e) Add a distance-id pair to the heap unless the distance is too large.
void	add(DoubleDistance dist, DBIDRef id) Deprecated. if you know your distances are double-valued, you should be using the primitive type.
double	doubleKNNDistance() Get the distance to the k nearest neighbor, or maxdist otherwise.
DoubleDistance	getKNNDistance() Deprecated. if you know your distances are double-valued, you should be using the primitive type.
DoubleDistanceDBIDPair	peek() Peek at the largest element in the heap.
DoubleDistanceDBIDPair	poll() Poll the largest element from the heap.
DoubleDistanceKNNList	toKNNList() Serialize to a KNNList.

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.distance.KNNHeap

clear, getK, isEmpty, size

Method Detail

add

void add(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

add

@Deprecated
void add(Double distance,
                  DBIDRef id)

Deprecated.

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

add

void add(DoubleDistanceDBIDPair e)

Add a distance-id pair to the heap unless the distance is too large. Use for existing pairs.

Parameters:

e - Existing distance pair

add

@Deprecated
void add(DoubleDistance dist,
                  DBIDRef id)

Deprecated. if you know your distances are double-valued, you should be using the primitive type.

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.

Specified by:

add in interface KNNHeap<DoubleDistance>

Parameters:

dist - Distance value

id - ID number

doubleKNNDistance

double doubleKNNDistance()

Get the distance to the k nearest neighbor, or maxdist otherwise.

Returns:

Maximum distance

getKNNDistance

@Deprecated
DoubleDistance getKNNDistance()

Deprecated. if you know your distances are double-valued, you should be using the primitive type.

Get the distance to the k nearest neighbor, or maxdist otherwise.

Specified by:

getKNNDistance in interface KNNHeap<DoubleDistance>

Returns:

Maximum distance

poll

DoubleDistanceDBIDPair poll()

Description copied from interface: KNNHeap

Poll the largest element from the heap. This is in descending order because of the heap structure. For a convenient way to serialize the heap into a list that you can iterate in ascending order, see KNNHeap.toKNNList().

Specified by:

poll in interface KNNHeap<DoubleDistance>

Returns:

largest element

peek

DoubleDistanceDBIDPair peek()

Description copied from interface: KNNHeap

Peek at the largest element in the heap.

Specified by:

peek in interface KNNHeap<DoubleDistance>

Returns:

The current largest element.

toKNNList

DoubleDistanceKNNList toKNNList()

Description copied from interface: KNNHeap

Serialize to a KNNList. This empties the heap!

Specified by:

toKNNList in interface KNNHeap<DoubleDistance>

Returns:

KNNList with the heaps contents.