Class CostlessMeldPairingHeap<K,V>
- java.lang.Object
-
- org.jheaps.tree.CostlessMeldPairingHeap<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 CostlessMeldPairingHeap<K,V> extends java.lang.Object implements MergeableAddressableHeap<K,V>, java.io.Serializable
The costless meld variant of the pairing 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 implementation provides amortized O(1) time for
findMin
andinsert
, amortized O(log(n)) fordeleteMin
anddelete
and amortized O(loglog(n)) for thedecreaseKey
operation. The operationmeld
takes amortized zero time.This variant of the pairing heap is due to Amr Elmasry, described in detail in the following paper:
- Amr Elmasry, Pairing Heaps with Costless Meld, In Proceedings of the 18th Annual European Symposium on Algorithms (ESA 2010), 183--193, 2010.
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 a pairing 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 a pairing 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 pairing 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:
PairingHeap
,FibonacciHeap
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
CostlessMeldPairingHeap.Node<K,V>
-
Nested classes/interfaces inherited from interface org.jheaps.AddressableHeap
AddressableHeap.Handle<K,V>
-
-
Field Summary
Fields Modifier and Type Field Description 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 CostlessMeldPairingHeap.Node<K,V>[]
decreasePool
The decrease poolprivate java.util.Comparator<CostlessMeldPairingHeap.Node<K,V>>
decreasePoolComparator
Comparator for nodes in the decrease pool.private byte
decreasePoolMinPos
Index of node with minimum key in the decrease pool.private byte
decreasePoolSize
How many elements are valid in the decrease poolprivate static int
DEFAULT_DECREASE_POOL_SIZE
Maximum length of decrease pool for long type.private CostlessMeldPairingHeap<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 CostlessMeldPairingHeap.Node<K,V>
root
The root of the pairing heapprivate static long
serialVersionUID
private long
size
Size of the pairing heap
-
Constructor Summary
Constructors Constructor Description CostlessMeldPairingHeap()
Constructs a new, empty heap, using the natural ordering of its keys.CostlessMeldPairingHeap(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 private void
addPool(CostlessMeldPairingHeap.Node<K,V> n, boolean updateMinimum)
Append to decrease pool.void
clear()
Clear all the elements of the heap.private CostlessMeldPairingHeap.Node<K,V>
combine(CostlessMeldPairingHeap.Node<K,V> l)
Two pass pair and compute root.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
consolidate()
private CostlessMeldPairingHeap.Node<K,V>
cutChildren(CostlessMeldPairingHeap.Node<K,V> n)
Cut the children of a node and return the list.private void
cutFromParent(CostlessMeldPairingHeap.Node<K,V> n)
Cut a node from its parent.private CostlessMeldPairingHeap.Node<K,V>
cutOldestChild(CostlessMeldPairingHeap.Node<K,V> n)
Cut the oldest child of a node.private void
decreaseKey(CostlessMeldPairingHeap.Node<K,V> n, K newKey)
private void
delete(CostlessMeldPairingHeap.Node<K,V> n)
Delete a node.AddressableHeap.Handle<K,V>
deleteMin()
Delete and return an element with the minimum key.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 CostlessMeldPairingHeap.Node<K,V>
link(CostlessMeldPairingHeap.Node<K,V> f, CostlessMeldPairingHeap.Node<K,V> s)
private void
linkInPlace(CostlessMeldPairingHeap.Node<K,V> orphan, CostlessMeldPairingHeap.Node<K,V> n)
Put an orphan node into the position of another node.private CostlessMeldPairingHeap.Node<K,V>
linkWithComparator(CostlessMeldPairingHeap.Node<K,V> f, CostlessMeldPairingHeap.Node<K,V> s)
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
-
DEFAULT_DECREASE_POOL_SIZE
private static final int DEFAULT_DECREASE_POOL_SIZE
Maximum length of decrease pool for long type.- 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 CostlessMeldPairingHeap.Node<K,V> root
The root of the pairing heap
-
size
private long size
Size of the pairing heap
-
decreasePool
private CostlessMeldPairingHeap.Node<K,V>[] decreasePool
The decrease pool
-
decreasePoolSize
private byte decreasePoolSize
How many elements are valid in the decrease pool
-
decreasePoolMinPos
private byte decreasePoolMinPos
Index of node with minimum key in the decrease pool. Not existent if decreasePoolMin >= decreasePoolSize.
-
decreasePoolComparator
private transient java.util.Comparator<CostlessMeldPairingHeap.Node<K,V>> decreasePoolComparator
Comparator for nodes in the decrease pool. Initialized lazily and used when sorting entries in the decrease pool.
-
other
private CostlessMeldPairingHeap<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
-
CostlessMeldPairingHeap
public CostlessMeldPairingHeap()
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
.
-
CostlessMeldPairingHeap
public CostlessMeldPairingHeap(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
-
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>
-
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
-
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. This operation takes amortized zero cost.- Specified by:
meld
in interfaceMergeableAddressableHeap<K,V>
- Parameters:
other
- a merge-able heap
-
decreaseKey
private void decreaseKey(CostlessMeldPairingHeap.Node<K,V> n, K newKey)
-
delete
private void delete(CostlessMeldPairingHeap.Node<K,V> n)
Delete a node.- Parameters:
n
- the node
-
consolidate
private void consolidate()
-
addPool
private void addPool(CostlessMeldPairingHeap.Node<K,V> n, boolean updateMinimum)
Append to decrease pool.
-
combine
private CostlessMeldPairingHeap.Node<K,V> combine(CostlessMeldPairingHeap.Node<K,V> l)
Two pass pair and compute root.
-
cutChildren
private CostlessMeldPairingHeap.Node<K,V> cutChildren(CostlessMeldPairingHeap.Node<K,V> n)
Cut the children of a node and return the list.- Parameters:
n
- the node- Returns:
- the first node in the children list
-
cutOldestChild
private CostlessMeldPairingHeap.Node<K,V> cutOldestChild(CostlessMeldPairingHeap.Node<K,V> n)
Cut the oldest child of a node.- Parameters:
n
- the node- Returns:
- the oldest child of a node or null
-
cutFromParent
private void cutFromParent(CostlessMeldPairingHeap.Node<K,V> n)
Cut a node from its parent.- Parameters:
n
- the node
-
linkInPlace
private void linkInPlace(CostlessMeldPairingHeap.Node<K,V> orphan, CostlessMeldPairingHeap.Node<K,V> n)
Put an orphan node into the position of another node. The other node becomes an orphan.- Parameters:
orphan
- the orphan noden
- the node which will become an orphan
-
link
private CostlessMeldPairingHeap.Node<K,V> link(CostlessMeldPairingHeap.Node<K,V> f, CostlessMeldPairingHeap.Node<K,V> s)
-
linkWithComparator
private CostlessMeldPairingHeap.Node<K,V> linkWithComparator(CostlessMeldPairingHeap.Node<K,V> f, CostlessMeldPairingHeap.Node<K,V> s)
-
-