Class BinaryTreeSoftAddressableHeap<K,V>
- Type Parameters:
K
- the type of keys maintained by this heapV
- the type of values maintained by this heap
- All Implemented Interfaces:
Serializable
,AddressableHeap<K,
,V> MergeableAddressableHeap<K,
V>
Comparator
provided at heap creation time, depending on which
constructor is used.
If n elements are inserted into a soft heap, then up to εn of the elements still contained in the heap, for a given error parameter ε, may be corrupted, i.e., have their keys artificially increased. In exchange for allowing these corruptions, each soft heap operation is performed in O(log 1/ε) amortized time. Note that n here is the number of elements inserted into the heaps, not the current number of elements in the heap which may be considerably smaller. Moreover the user has no control on which elements may be corrupted.
This variant of the soft heap is due to Kaplan and Zwick, described in detail in the following paper:
- Haim Kaplan and Uri Zwick, A simpler implementation and analysis of Chazelle's Soft Heaps, In Proceedings of the 20th Annual ACM-SIAM Symposium on Discrete Algorithms (SODA 2009), 477--485, 2009.
Note that the operation decreaseKey()
always throws an
UnsupportedOperationException
as a soft heap does not support such an
operation.
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 soft 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 the Heap
interface. (See Comparable
or Comparator
for a precise
definition of consistent with equals.) This is so because the
Heap
interface is defined in terms of the equals
operation,
but a pairing heap performs all key comparisons using its compareTo
(or compare
) method, so two keys that are deemed equal by this method
are, from the standpoint of the heap, equal. The behavior of a heap
is well-defined even if its ordering is inconsistent with
equals
; it just fails to obey the general contract of the
Heap
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
(package private) static class
(package private) static class
(package private) static class
Nested classes/interfaces inherited from interface org.jheaps.AddressableHeap
AddressableHeap.Handle<K,
V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Comparator
<? super K> The comparator used to maintain order in this heap, or null if it uses the natural ordering of its keys.private BinaryTreeSoftAddressableHeap
<K, V> Used to reference the current heap or some other heap in case of melding, so that handles remain valid even after a meld, without having to iterate over them.private final int
Tree nodes with less or equal than this rank will have no corrupted keys.(package private) final BinaryTreeSoftAddressableHeap.RootList
<K, V> The root list, in non-decreasing rank order.private static final long
private long
Size of the heap.private static final long[]
Already computed values for target sizes. -
Constructor Summary
ConstructorsConstructorDescriptionBinaryTreeSoftAddressableHeap
(double errorRate) Constructs a new, empty heap, using the natural ordering of its keys.BinaryTreeSoftAddressableHeap
(double errorRate, Comparator<? super K> comparator) Constructs a new, empty heap, ordered according to the given comparator. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear all the elements of the heap.private BinaryTreeSoftAddressableHeap.TreeNode
<K, V> combine
(BinaryTreeSoftAddressableHeap.TreeNode<K, V> x, BinaryTreeSoftAddressableHeap.TreeNode<K, V> y) Combine two trees into a new tree.Comparator
<? super K> Returns the comparator used to order the keys in this AddressableHeap, ornull
if this heap uses the natural ordering of its keys.private void
Delete a node from the root list.private void
Delete an element.Delete and return an element with the minimum key.findMin()
Find an element with the minimum key.Insert a new element into the heap with a null value.Insert a new element into the heap.boolean
isEmpty()
Returnstrue
if this heap is empty.void
meld
(MergeableAddressableHeap<K, V> other) Meld a heap into the current heap.private void
mergeInto
(BinaryTreeSoftAddressableHeap.RootListNode<K, V> head, BinaryTreeSoftAddressableHeap.RootListNode<K, V> tail) Merge a list into the root list.private void
Sift elements from children nodes until the current node has enough elements in its list.long
size()
Returns the number of elements in the heap.private long
targetSize
(int rank) Compute the target size for a particular rank.private void
Update all suffix minimum pointers for a node and all its predecessors in the root list.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
comparator
The comparator used to maintain order in this heap, or null if it uses the natural ordering of its keys. -
TARGET_SIZE
private static final long[] TARGET_SIZEAlready computed values for target sizes. -
rankLimit
private final int rankLimitTree nodes with less or equal than this rank will have no corrupted keys. -
rootList
The root list, in non-decreasing rank order. -
size
private long sizeSize of the heap. -
other
Used to reference the current heap or some other 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 Details
-
BinaryTreeSoftAddressableHeap
public BinaryTreeSoftAddressableHeap(double errorRate) 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
.- Parameters:
errorRate
- the error rate- Throws:
IllegalArgumentException
- if the error rate is less or equal to zeroIllegalArgumentException
- if the error rate is greater or equal to one
-
BinaryTreeSoftAddressableHeap
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:
errorRate
- the error ratecomparator
- the comparator that will be used to order this heap. Ifnull
, the natural ordering of the keys will be used.- Throws:
IllegalArgumentException
- if the error rate is less or equal to zeroIllegalArgumentException
- if the error rate is greater or equal to one
-
-
Method Details
-
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
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
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- Throws:
IllegalArgumentException
- ifother
has a different error rate
-
insert
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
-
insert
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
-
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
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
-
targetSize
private long targetSize(int rank) Compute the target size for a particular rank.- Parameters:
rank
- the rank- Returns:
- the target size
-
sift
Sift elements from children nodes until the current node has enough elements in its list.- Parameters:
x
- the node
-
combine
private BinaryTreeSoftAddressableHeap.TreeNode<K,V> combine(BinaryTreeSoftAddressableHeap.TreeNode<K, V> x, BinaryTreeSoftAddressableHeap.TreeNode<K, V> y) Combine two trees into a new tree.- Parameters:
x
- the first treey
- the second tree- Returns:
- the combined tree
-
updateSuffixMin
Update all suffix minimum pointers for a node and all its predecessors in the root list.- Parameters:
t
- the node
-
mergeInto
private void mergeInto(BinaryTreeSoftAddressableHeap.RootListNode<K, V> head, BinaryTreeSoftAddressableHeap.RootListNode<K, V> tail) Merge a list into the root list. Assumes that the two lists are sorted in non-decreasing order of rank.- Parameters:
head
- the list headtail
- the list tail
-
delete
Delete a node from the root list.- Parameters:
n
- the node
-
delete
Delete an element.- Parameters:
n
- the element to delete
-