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

Class AbstractKNNHeap<P extends DistanceDBIDPair<D>,D extends Distance<D>>

java.lang.Object

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

Type Parameters:

P - pair type

D - distance type

All Implemented Interfaces:

KNNHeap<D>

Direct Known Subclasses:

DoubleDistanceKNNHeap, GenericKNNHeap

public abstract class AbstractKNNHeap<P extends DistanceDBIDPair<D>,D extends Distance<D>>
extends Object
implements KNNHeap<D>

Heap used for KNN management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractKNNHeap.Comp Comparator to use.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<? super DistanceDBIDPair<?>>	COMPARATOR Static comparator.
protected TiedTopBoundedHeap<P>	heap The actual heap.

Constructor Summary

Constructors

Constructor and Description
AbstractKNNHeap(int k) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	add(P pair) Add a pair to the heap.
void	clear() Clear the heap.
int	getK() Get the K parameter ("maxsize" internally).
boolean	isEmpty() Test if the heap is empty.
P	peek() Peek at the largest element in the heap.
P	poll() Poll the largest element from the heap.
int	size() Current size of heap.

Methods inherited from class java.lang.Object

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

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

add, getKNNDistance, toKNNList

Field Detail

COMPARATOR

public static final Comparator<? super DistanceDBIDPair<?>> COMPARATOR

Static comparator.

heap

protected final TiedTopBoundedHeap<P extends DistanceDBIDPair<D>> heap

The actual heap.

Constructor Detail

AbstractKNNHeap

public AbstractKNNHeap(int k)

Constructor.

Parameters:

k - Maximum heap size (unless tied)

Method Detail

add

public abstract void add(P pair)

Add a pair to the heap.

Parameters:

pair - Pair to add.

getK

public final int getK()

Description copied from interface: KNNHeap

Get the K parameter ("maxsize" internally).

Specified by:

getK in interface KNNHeap<D extends Distance<D>>

Returns:

K

size

public int size()

Description copied from interface: KNNHeap

Current size of heap.

Specified by:

size in interface KNNHeap<D extends Distance<D>>

Returns:

Heap size

peek

public P peek()

Description copied from interface: KNNHeap

Peek at the largest element in the heap.

Specified by:

peek in interface KNNHeap<D extends Distance<D>>

Returns:

The current largest element.

isEmpty

public boolean isEmpty()

Description copied from interface: KNNHeap

Test if the heap is empty.

Specified by:

isEmpty in interface KNNHeap<D extends Distance<D>>

Returns:

true when empty.

clear

public void clear()

Description copied from interface: KNNHeap

Clear the heap.

Specified by:

clear in interface KNNHeap<D extends Distance<D>>

poll

public P 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<D extends Distance<D>>

Returns:

largest element