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

Class TopBoundedHeap<E>

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.datastructures.heap.Heap<E>

de.lmu.ifi.dbs.elki.utilities.datastructures.heap.TopBoundedHeap<E>

Type Parameters:

E - Element type. Should be Comparable or a Comparator needs to be given.

Direct Known Subclasses:

TiedTopBoundedHeap

public class TopBoundedHeap<E>
extends Heap<E>

Heap class that is bounded in size from the top. It will keep the bottom k Elements only.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.utilities.datastructures.heap.Heap

Heap.UnorderedIter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxsize Maximum size.

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.datastructures.heap.Heap

comparator, queue, size

Constructor Summary

Constructors

Constructor and Description
TopBoundedHeap(int maxsize) Constructor with maximum size only.
TopBoundedHeap(int maxsize, java.util.Comparator<? super E> comparator) Constructor with maximum size and Comparator.

Method Summary

Modifier and Type	Method and Description
void	add(E e) Add an element to the heap.
int	getMaxSize() Get the maximum size.
protected void	handleOverflow(E e) Handle an overflow in the structure.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.datastructures.heap.Heap

checkHeap, clear, heapifyDown, heapifyUp, heapModified, isEmpty, peek, poll, removeAt, replaceTopElement, resize, size, unorderedIter

Methods inherited from class java.lang.Object

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

Field Detail

maxsize

protected int maxsize

Maximum size.

Constructor Detail

TopBoundedHeap

public TopBoundedHeap(int maxsize)

Constructor with maximum size only.

Parameters:

maxsize - Maximum size

TopBoundedHeap

public TopBoundedHeap(int maxsize,
                      java.util.Comparator<? super E> comparator)

Constructor with maximum size and Comparator.

Parameters:

maxsize - Maximum size

comparator - Comparator

Method Detail

add

public void add(E e)

Description copied from class: Heap

Add an element to the heap.

Overrides:

add in class Heap<E>

Parameters:

e - Element to add

handleOverflow

protected void handleOverflow(E e)

Handle an overflow in the structure. This function can be overridden to get overflow treatment.

Parameters:

e - Overflowing element.

getMaxSize

public int getMaxSize()

Get the maximum size.

Returns:

the maximum size