de.lmu.ifi.dbs.elki.distance.distanceresultlist

Class GenericKNNHeap<D extends Distance<D>>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distanceresultlist.AbstractKNNHeap<DistanceDBIDPair<D>,D>

de.lmu.ifi.dbs.elki.distance.distanceresultlist.GenericKNNHeap<D>

Type Parameters:

D - Distance type

All Implemented Interfaces:

KNNHeap<D>

 class GenericKNNHeap<D extends Distance<D>>
extends AbstractKNNHeap<DistanceDBIDPair<D>,D>

Heap for collecting kNN candiates with arbitrary distance types. For double distances, see DoubleDistanceKNNHeap To instantiate, use KNNUtil.newHeap(de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction<?, D>, int) instead!

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.distance.distanceresultlist.AbstractKNNHeap

AbstractKNNHeap.Comp

Field Summary

Fields

Modifier and Type	Field and Description
protected D	knndistance Cached distance to k nearest neighbor (to avoid going through AbstractKNNHeap.peek() each time).

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distanceresultlist.AbstractKNNHeap

COMPARATOR, heap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericKNNHeap(int k) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(D distance, DBIDRef id) Add a distance-id pair to the heap unless the distance is too large.
void	add(DistanceDBIDPair<D> pair) Add a pair to the heap.
D	getKNNDistance() Get the distance to the k nearest neighbor, or maxdist otherwise.
protected void	heapModified()
GenericKNNList<D>	toKNNList() Serialize to a GenericKNNList.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distanceresultlist.AbstractKNNHeap

clear, getK, isEmpty, peek, poll, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

knndistance

protected D extends Distance<D> knndistance

Cached distance to k nearest neighbor (to avoid going through AbstractKNNHeap.peek() each time).

Constructor Detail

GenericKNNHeap

protected GenericKNNHeap(int k)

Constructor. To instantiate, use KNNUtil.newHeap(de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction<?, D>, int) instead!

Parameters:

k - Heap size

Method Detail

toKNNList

public GenericKNNList<D> toKNNList()

Serialize to a GenericKNNList. This empties the heap!

Returns:

KNNList with the heaps contents.

add

public void add(D distance,
       DBIDRef id)

Description copied from interface: KNNHeap

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

public void add(DistanceDBIDPair<D> pair)

Description copied from class: AbstractKNNHeap

Add a pair to the heap.

Specified by:

add in class AbstractKNNHeap<DistanceDBIDPair<D extends Distance<D>>,D extends Distance<D>>

Parameters:

pair - Pair to add.

heapModified

protected void heapModified()

getKNNDistance

public D getKNNDistance()

Description copied from interface: KNNHeap

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

Returns:

Maximum distance