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

Class AbstractHeap

java.lang.Object

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

Direct Known Subclasses:

DoubleHeap, IntegerHeap, ObjectHeap

public class AbstractHeap
extends Object

Abstract base class for heaps.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_CAPACITY Default initial capacity
int	modCount (Structural) modification counter.
int	size Current number of objects
int	validSize Indicate up to where the heap is valid

Constructor Summary

Constructors

Constructor and Description
AbstractHeap() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Delete all elements from the heap.
protected int	desiredSize(int requiredSize, int capacity) Test whether we need to resize to have the requested capacity.
protected void	heapModified() Called at the end of each heap modification.
int	size() Query the size

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

Default initial capacity

See Also:

Constant Field Values

size

public int size

Current number of objects

validSize

public int validSize

Indicate up to where the heap is valid

modCount

public int modCount

(Structural) modification counter. Used to invalidate iterators.

Constructor Detail

AbstractHeap

public AbstractHeap()

Constructor.

Method Detail

size

public int size()

Query the size

Returns:

Size

clear

public void clear()

Delete all elements from the heap.

desiredSize

protected final int desiredSize(int requiredSize,
              int capacity)

Test whether we need to resize to have the requested capacity.

Parameters:

requiredSize - required capacity

capacity - Current capacity

Returns:

new capacity

heapModified

protected void heapModified()

Called at the end of each heap modification.