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

Class TopBoundedUpdatableHeap<E>

java.lang.Object

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

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

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

Type Parameters:

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

Direct Known Subclasses:

TiedTopBoundedUpdatableHeap

public class TopBoundedUpdatableHeap<E>
extends UpdatableHeap<E>

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

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.UpdatableHeap

IN_TIES, index, NO_VALUE

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

comparator, queue, size

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compare(Object e, Object object) Test if the priority of an object is higher.
int	getMaxSize() Get the maximum size.
protected void	handleOverflow(E e) Handle an overflow in the structure.
void	offerAt(int pos, E e) Offer element at the given position.

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

add, clear, heapifyDownComparable, heapifyDownComparator, heapifyUpComparable, heapifyUpComparator, poll, removeAt, removeObject, replaceTopElement

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

checkHeap, heapifyDown, heapifyUp, heapModified, isEmpty, peek, 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

TopBoundedUpdatableHeap

public TopBoundedUpdatableHeap(int maxsize)

Constructor with maximum size only.

Parameters:

maxsize - Maximum size

TopBoundedUpdatableHeap

public TopBoundedUpdatableHeap(int maxsize,
                       Comparator<? super E> comparator)

Constructor with maximum size and Comparator.

Parameters:

maxsize - Maximum size

comparator - Comparator

Method Detail

offerAt

public void offerAt(int pos,
           E e)

Description copied from class: UpdatableHeap

Offer element at the given position.

Overrides:

offerAt in class UpdatableHeap<E>

Parameters:

pos - Position

e - Element

compare

protected int compare(Object e,
          Object object)

Test if the priority of an object is higher.

Parameters:

e - New object

object - Reference object

Returns:

True when an update is needed

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