de.lmu.ifi.dbs.elki.utilities.datastructures.heap

Interface DoubleObjectHeap<V>

Type Parameters:

V - Value type

All Known Implementing Classes:

DoubleObjectMaxHeap, DoubleObjectMinHeap

public interface DoubleObjectHeap<V>

Basic in-memory heap interface, for double keys and V values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DoubleObjectHeap.UnsortedIter<V> Unsorted iterator - in heap order.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double key, V val) Add a key-value pair to the heap
void	add(double key, V val, int k) Add a key-value pair to the heap if it improves the top.
void	clear() Clear the heap contents.
boolean	isEmpty() Is the heap empty?
double	peekKey() Get the current top key
V	peekValue() Get the current top value
void	poll() Remove the first element
void	replaceTopElement(double key, V val) Combined operation that removes the top element, and inserts a new element instead.
int	size() Query the size
DoubleObjectHeap.UnsortedIter<V>	unsortedIter() Get an unsorted iterator to inspect the heap.

Method Detail

add

void add(double key,
       V val)

Add a key-value pair to the heap

Parameters:

key - Key

val - Value

add

void add(double key,
       V val,
       int k)

Add a key-value pair to the heap if it improves the top.

Parameters:

key - Key

val - Value

k - Desired maximum size

replaceTopElement

void replaceTopElement(double key,
                     V val)

Combined operation that removes the top element, and inserts a new element instead.

Parameters:

key - Key of new element

val - Value of new element

peekKey

double peekKey()

Get the current top key

Returns:

Top key

peekValue

V peekValue()

Get the current top value

Returns:

Value

poll

void poll()

Remove the first element

clear

void clear()

Clear the heap contents.

size

int size()

Query the size

Returns:

Size

isEmpty

boolean isEmpty()

Is the heap empty?

Returns:

true when the size is 0.

unsortedIter

DoubleObjectHeap.UnsortedIter<V> unsortedIter()

Get an unsorted iterator to inspect the heap.

Returns:

Iterator