Class HollowHeap<K,V>
- java.lang.Object
-
- org.jheaps.dag.HollowHeap<K,V>
-
- Type Parameters:
K
- the type of keys maintained by this heapV
- the type of values maintained by this heap
- All Implemented Interfaces:
java.io.Serializable
,AddressableHeap<K,V>
,MergeableAddressableHeap<K,V>
public class HollowHeap<K,V> extends java.lang.Object implements MergeableAddressableHeap<K,V>, java.io.Serializable
Hollow heaps. 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.This is the hollow heap described in detail in the following paper:
- TD Hansen, H Kaplan, RE Tarjan and U Zwick. Hollow heaps. ACM Transactions on Algorithms (TALG), 13(3), 42, 2017.
This implementation provides amortized O(1) time for operations that do not involve deleting an element such as
insert
, anddecreaseKey
. OperationsdeleteMin
anddelete
are amortized O(log(n)). The operationmeld
is also amortized O(1).All the above bounds, however, assume that the user does not perform cascading melds on heaps such as:
d.meld(e); c.meld(d); b.meld(c); a.meld(b);
The above scenario, although efficiently supported by using union-find with path compression, invalidates the claimed bounds.Note that the ordering maintained by this 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 theAddressableHeap
interface. (SeeComparable
orComparator
for a precise definition of consistent with equals.) This is so because theAddressableHeap
interface is defined in terms of theequals
operation, but this heap performs all key comparisons using itscompareTo
(orcompare
) method, so two keys that are deemed equal by this method are, from the standpoint of this 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 theAddressableHeap
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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
HollowHeap.HollowNode<K,V>
(package private) static class
HollowHeap.Item<K,V>
-
Nested classes/interfaces inherited from interface org.jheaps.AddressableHeap
AddressableHeap.Handle<K,V>
-
-
Field Summary
Fields Modifier and Type Field Description private HollowHeap.HollowNode<K,V>[]
aux
Auxiliary array for performing links.private static int
AUX_BUCKET_ARRAY_SIZE
Size of bucket array.private java.util.Comparator<? super K>
comparator
The comparator used to maintain order in this heap, or null if it uses the natural ordering of its keys.private long
nodes
Number of nodes (hollow or not).private HollowHeap<K,V>
other
Used to reference the current heap or some other pairing heap in case of melding, so that handles remain valid even after a meld, without having to iterate over them.private HollowHeap.HollowNode<K,V>
root
The last node in the root listprivate static long
serialVersionUID
private long
size
Size of the heap
-
Constructor Summary
Constructors Constructor Description HollowHeap()
Constructs a new, empty heap, using the natural ordering of its keys.HollowHeap(java.util.Comparator<? super K> comparator)
Constructs a new, empty heap, ordered according to the given comparator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear all the elements of the heap.java.util.Comparator<? super K>
comparator()
Returns the comparator used to order the keys in this AddressableHeap, ornull
if this heap uses the natural ordering of its keys.private void
decreaseKey(HollowHeap.Item<K,V> e, K newKey)
Decrease the key of an item.private void
delete(HollowHeap.Item<K,V> e)
Delete an itemAddressableHeap.Handle<K,V>
deleteMin()
Delete and return an element with the minimum key.private int
doRankedLinks(HollowHeap.HollowNode<K,V> u)
private void
doUnrankedLinks(int maxRank)
AddressableHeap.Handle<K,V>
findMin()
Find an element with the minimum key.AddressableHeap.Handle<K,V>
insert(K key)
Insert a new element into the heap with a null value.AddressableHeap.Handle<K,V>
insert(K key, V value)
Insert a new element into the heap.boolean
isEmpty()
Returnstrue
if this heap is empty.private HollowHeap.HollowNode<K,V>
link(HollowHeap.HollowNode<K,V> v, HollowHeap.HollowNode<K,V> w)
void
meld(MergeableAddressableHeap<K,V> other)
Meld a heap into the current heap.long
size()
Returns the number of elements in the heap.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
AUX_BUCKET_ARRAY_SIZE
private static final int AUX_BUCKET_ARRAY_SIZE
Size of bucket array. Based on maximum rank.- See Also:
- Constant Field Values
-
comparator
private final java.util.Comparator<? super K> comparator
The comparator used to maintain order in this heap, or null if it uses the natural ordering of its keys.
-
root
private HollowHeap.HollowNode<K,V> root
The last node in the root list
-
size
private long size
Size of the heap
-
nodes
private long nodes
Number of nodes (hollow or not). Useful for rebuilding.
-
aux
private HollowHeap.HollowNode<K,V>[] aux
Auxiliary array for performing links.
-
other
private HollowHeap<K,V> other
Used to reference the current heap or some other pairing heap in case of melding, so that handles remain valid even after a meld, without having to iterate over them. In order to avoid maintaining a full-fledged union-find data structure, we disallow a heap to be used in melding more than once. We use however, path-compression in case of cascading melds, that it, a handle moves from one heap to another and then another.
-
-
Constructor Detail
-
HollowHeap
public HollowHeap()
Constructs a new, empty heap, using the natural ordering of its keys. All keys inserted into the heap must implement theComparable
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
.
-
HollowHeap
public HollowHeap(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
.- Parameters:
comparator
- the comparator that will be used to order this heap. Ifnull
, the natural ordering of the keys will be used.
-
-
Method Detail
-
insert
public AddressableHeap.Handle<K,V> insert(K key, V value)
Insert a new element into the heap.- Specified by:
insert
in interfaceAddressableHeap<K,V>
- Parameters:
key
- the element's keyvalue
- the element's value- Returns:
- a handle for the newly added element
- Throws:
java.lang.IllegalStateException
- if the heap has already been used in the right hand side of a meld
-
insert
public AddressableHeap.Handle<K,V> insert(K key)
Insert a new element into the heap with a null value.- Specified by:
insert
in interfaceAddressableHeap<K,V>
- Parameters:
key
- the element's key- Returns:
- a handle for the newly added element
- Throws:
java.lang.IllegalStateException
- if the heap has already been used in the right hand side of a meld
-
findMin
public AddressableHeap.Handle<K,V> findMin()
Find an element with the minimum key.- Specified by:
findMin
in interfaceAddressableHeap<K,V>
- Returns:
- a handle to an element with minimum key
-
deleteMin
public AddressableHeap.Handle<K,V> deleteMin()
Delete and return an element with the minimum key. If multiple such elements exists, only one of them will be deleted. After the element is deleted the handle is invalidated and only methodAddressableHeap.Handle.getKey()
andAddressableHeap.Handle.getValue()
can be used.- Specified by:
deleteMin
in interfaceAddressableHeap<K,V>
- Returns:
- a handle to the deleted element with minimum key
-
isEmpty
public boolean isEmpty()
Returnstrue
if this heap is empty.- Specified by:
isEmpty
in interfaceAddressableHeap<K,V>
- Returns:
true
if this heap is empty,false
otherwise
-
size
public long size()
Returns the number of elements in the heap.- Specified by:
size
in interfaceAddressableHeap<K,V>
- Returns:
- the number of elements in the heap
-
comparator
public java.util.Comparator<? super K> comparator()
Returns the comparator used to order the keys in this AddressableHeap, ornull
if this heap uses the natural ordering of its keys.- Specified by:
comparator
in interfaceAddressableHeap<K,V>
- Returns:
- the comparator used to order the keys in this heap, or
null
if this addressable heap uses the natural ordering of its keys
-
clear
public void clear()
Clear all the elements of the heap. After calling this method all handles should be considered invalidated and the behavior of methodsAddressableHeap.Handle.decreaseKey(Object)
andAddressableHeap.Handle.delete()
is undefined.- Specified by:
clear
in interfaceAddressableHeap<K,V>
-
meld
public void meld(MergeableAddressableHeap<K,V> other)
Meld a heap into the current heap. After the operation theother
heap will be empty and will not permit further insertions.- Specified by:
meld
in interfaceMergeableAddressableHeap<K,V>
- Parameters:
other
- a merge-able heap
-
decreaseKey
private void decreaseKey(HollowHeap.Item<K,V> e, K newKey)
Decrease the key of an item.- Parameters:
n
- the itemnewKey
- the new key
-
delete
private void delete(HollowHeap.Item<K,V> e)
Delete an item- Parameters:
e
- the item
-
doRankedLinks
private int doRankedLinks(HollowHeap.HollowNode<K,V> u)
-
doUnrankedLinks
private void doUnrankedLinks(int maxRank)
-
link
private HollowHeap.HollowNode<K,V> link(HollowHeap.HollowNode<K,V> v, HollowHeap.HollowNode<K,V> w)
-
-