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

Class TopBoundedUpdatableHeap<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

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.

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Queue<E>

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.

See Also:

Serialized Form

Nested Class Summary

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

Heap.Itr

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxsize Maximum size
private static long	serialVersionUID Serial version

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, modCount, queue, size, validSize

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()
protected void	handleOverflow(E e) Handle an overflow in the structure.
boolean	offerAt(int pos, E e)

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

clear, heapifyDownComparable, heapifyDownComparator, heapifyUpComparable, heapifyUpComparator, offer, poll, removeAt, removeObject

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

add, addAll, castQueueElement, checkHeap, contains, ensureValid, heapifyDown, heapifyUp, iterator, peek, resize, size, toSortedArrayList

Methods inherited from class java.util.AbstractQueue

element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version

See Also:

Constant Field Values

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 boolean offerAt(int pos,
              E e)

Overrides:

offerAt in class UpdatableHeap<E>

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()

Returns:

the maximum size