Class BinaryArrayHeap<K>
- java.lang.Object
-
- org.jheaps.array.AbstractArrayWeakHeap<K>
-
- org.jheaps.array.AbstractArrayHeap<K>
-
- org.jheaps.array.BinaryArrayHeap<K>
-
- Type Parameters:
K
- the type of keys maintained by this heap
- All Implemented Interfaces:
java.io.Serializable
,Heap<K>
public class BinaryArrayHeap<K> extends AbstractArrayHeap<K>
An array based binary heap. The heap is sorted according to the natural ordering of its keys, or by aComparator
provided at heap creation time, depending on which constructor is used.The implementation uses an array in order to store the elements and automatically maintains the size of the array much like a
Vector
does, providing amortized O(log(n)) time cost for theinsert
anddeleteMin
operations. OperationfindMin
, is a worst-case O(1) operation. The bounds are worst-case if the user initializes the heap with a capacity larger or equal to the total number of elements that are going to be inserted into the heap.Constructing such a heap from an array of elements can be performed using the method
heapify(Object[])
orheapify(Object[], Comparator)
in linear time.Note that the ordering maintained by a binary heap, like any heap, and whether or not an explicit comparator is provided, must be consistent with
equals
if this heap is to correctly implement theHeap
interface. (SeeComparable
orComparator
for a precise definition of consistent with equals.) This is so because theHeap
interface is defined in terms of theequals
operation, but a binary heap performs all key comparisons using itscompareTo
(orcompare
) method, so two keys that are deemed equal by this method are, from the standpoint of the binary heap, equal. The behavior of a heap is well-defined even if its ordering is inconsistent withequals
; it just fails to obey the general contract of theHeap
interface.Note that this implementation is not synchronized. If multiple threads access a heap concurrently, and at least one of the threads modifies the heap structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements or changing the key of some element.) This is typically accomplished by synchronizing on some object that naturally encapsulates the heap.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_HEAP_CAPACITY
Default initial capacity of the binary heap.private static long
serialVersionUID
-
Fields inherited from class org.jheaps.array.AbstractArrayWeakHeap
array, comparator, DOWNSIZING_MIN_HEAP_CAPACITY, MAX_HEAP_CAPACITY, MIN_HEAP_CAPACITY, minCapacity, size
-
-
Constructor Summary
Constructors Constructor Description BinaryArrayHeap()
Constructs a new, empty heap, using the natural ordering of its keys.BinaryArrayHeap(int capacity)
Constructs a new, empty heap, with a provided initial capacity using the natural ordering of its keys.BinaryArrayHeap(java.util.Comparator<? super K> comparator)
Constructs a new, empty heap, ordered according to the given comparator.BinaryArrayHeap(java.util.Comparator<? super K> comparator, int capacity)
Constructs a new, empty heap, with a provided initial capacity ordered according to the given comparator.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
ensureCapacity(int capacity)
Ensure that the array representation has the necessary capacity.protected void
fixdown(int k)
Downwards fix starting from a particular elementprotected void
fixdownWithComparator(int k)
Downwards fix starting from a particular element.protected void
fixup(int k)
Upwards fix starting from a particular elementprotected void
fixupWithComparator(int k)
Upwards fix starting from a particular element.static <K> BinaryArrayHeap<K>
heapify(K[] array)
Create a heap from an array of elements.static <K> BinaryArrayHeap<K>
heapify(K[] array, java.util.Comparator<? super K> comparator)
Create a heap from an array of elements.-
Methods inherited from class org.jheaps.array.AbstractArrayHeap
deleteMin, findMin, initCapacity, insert
-
Methods inherited from class org.jheaps.array.AbstractArrayWeakHeap
checkCapacity, clear, comparator, isEmpty, size
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
DEFAULT_HEAP_CAPACITY
public static final int DEFAULT_HEAP_CAPACITY
Default initial capacity of the binary heap.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BinaryArrayHeap
public BinaryArrayHeap()
Constructs a new, empty heap, using the natural ordering of its keys.All keys inserted into the heap must implement the
Comparable
interface. Furthermore, all such keys must be mutually comparable:k1.compareTo(k2)
must not throw aClassCastException
for any keysk1
andk2
in the heap. If the user attempts to put a key into the heap that violates this constraint (for example, the user attempts to put a string key into a heap whose keys are integers), theinsert(Object key)
call will throw aClassCastException
.The initial capacity of the heap is
DEFAULT_HEAP_CAPACITY
and adjusts automatically based on the sequence of insertions and deletions.
-
BinaryArrayHeap
public BinaryArrayHeap(int capacity)
Constructs a new, empty heap, with a provided initial capacity using the natural ordering of its keys.All keys inserted into the heap must implement the
Comparable
interface. Furthermore, all such keys must be mutually comparable:k1.compareTo(k2)
must not throw aClassCastException
for any keysk1
andk2
in the heap. If the user attempts to put a key into the heap that violates this constraint (for example, the user attempts to put a string key into a heap whose keys are integers), theinsert(Object key)
call will throw aClassCastException
.The initial capacity of the heap is provided by the user and is adjusted automatically based on the sequence of insertions and deletions. The capacity will never become smaller than the initial requested capacity.
- Parameters:
capacity
- the initial heap capacity
-
BinaryArrayHeap
public BinaryArrayHeap(java.util.Comparator<? super K> comparator)
Constructs a new, empty heap, ordered according to the given comparator.All keys inserted into the heap must be mutually comparable by the given comparator:
comparator.compare(k1, k2)
must not throw aClassCastException
for any keysk1
andk2
in the heap. If the user attempts to put a key into the heap that violates this constraint, theinsert(Object key)
call will throw aClassCastException
.The initial capacity of the heap is
DEFAULT_HEAP_CAPACITY
and adjusts automatically based on the sequence of insertions and deletions.- Parameters:
comparator
- the comparator that will be used to order this heap. Ifnull
, the natural ordering of the keys will be used.
-
BinaryArrayHeap
public BinaryArrayHeap(java.util.Comparator<? super K> comparator, int capacity)
Constructs a new, empty heap, with a provided initial capacity ordered according to the given comparator.All keys inserted into the heap must be mutually comparable by the given comparator:
comparator.compare(k1, k2)
must not throw aClassCastException
for any keysk1
andk2
in the heap. If the user attempts to put a key into the heap that violates this constraint, theinsert(Object key)
call will throw aClassCastException
.The initial capacity of the heap is provided by the user and is adjusted automatically based on the sequence of insertions and deletions. The capacity will never become smaller than the initial requested capacity.
- Parameters:
comparator
- the comparator that will be used to order this heap. Ifnull
, the natural ordering of the keys will be used.capacity
- the initial heap capacity
-
-
Method Detail
-
heapify
public static <K> BinaryArrayHeap<K> heapify(K[] array)
Create a heap from an array of elements. The elements of the array are not destroyed. The method has linear time complexity.- Type Parameters:
K
- the type of keys maintained by the heap- Parameters:
array
- an array of elements- Returns:
- a binary heap
- Throws:
java.lang.IllegalArgumentException
- in case the array is null
-
heapify
public static <K> BinaryArrayHeap<K> heapify(K[] array, java.util.Comparator<? super K> comparator)
Create a heap from an array of elements. The elements of the array are not destroyed. The method has linear time complexity.- Type Parameters:
K
- the type of keys maintained by the heap- Parameters:
array
- an array of elementscomparator
- the comparator to use- Returns:
- a binary heap
- Throws:
java.lang.IllegalArgumentException
- in case the array is null
-
ensureCapacity
protected void ensureCapacity(int capacity)
Ensure that the array representation has the necessary capacity.- Specified by:
ensureCapacity
in classAbstractArrayWeakHeap<K>
- Parameters:
capacity
- the requested capacity
-
fixup
protected void fixup(int k)
Description copied from class:AbstractArrayWeakHeap
Upwards fix starting from a particular element- Specified by:
fixup
in classAbstractArrayWeakHeap<K>
- Parameters:
k
- the index of the starting element
-
fixupWithComparator
protected void fixupWithComparator(int k)
Description copied from class:AbstractArrayWeakHeap
Upwards fix starting from a particular element. Performs comparisons using the comparator.- Specified by:
fixupWithComparator
in classAbstractArrayWeakHeap<K>
- Parameters:
k
- the index of the starting element
-
fixdown
protected void fixdown(int k)
Description copied from class:AbstractArrayWeakHeap
Downwards fix starting from a particular element- Specified by:
fixdown
in classAbstractArrayWeakHeap<K>
- Parameters:
k
- the index of the starting element
-
fixdownWithComparator
protected void fixdownWithComparator(int k)
Description copied from class:AbstractArrayWeakHeap
Downwards fix starting from a particular element. Performs comparisons using the comparator.- Specified by:
fixdownWithComparator
in classAbstractArrayWeakHeap<K>
- Parameters:
k
- the index of the starting element
-
-