Handle

A handle to a Union-Find node, referencing a mergeable collection of type Bag.

A Handle is the outer interface of the MergeArray framework for building relaxed concurrent mergeable data structures. Such a data structure should wrap a Handle to a Bag type which manages access and merging of sequential data structures of type Bag.ElementType.

Members

Aliases

Obj alias Obj = Bag.ElementType: The type of the sequential data structures which applyUntil operates on.

Functions

apply void apply(void delegate(Obj*) dg): Atomically applies dg to some element of the Bag. Progress: Lock-free if there are no more than width total concurrent threads, otherwise deadlock-free.
applyUntil void applyUntil(bool delegate(Obj*) dg): Applies dg to elements in Bags which this Handle refers to during this call until dg returns true for the first time.
applyUntil_2 void applyUntil_2(bool delegate(Obj*, Obj*) dg): Undocumented in source. Be warned that the author may not have intended to support it.
canMergeWith bool canMergeWith(Handle other): Undocumented in source. Be warned that the author may not have intended to support it.
ensureMerged void ensureMerged(): Undocumented in source. Be warned that the author may not have intended to support it.
findClosestBag auto findClosestBag(): Undocumented in source.
mergeInto MergeResult mergeInto(Handle other): Attempts to merge the elements in this and other's Bags together.
tryApplyEachUntil bool tryApplyEachUntil(bool delegate(Obj*) dg): Calls tryApplyEachUntil(dg) on the Bag this Handle references and returns the result.
update bool update(): Attempt to move this shared handle down the chain to skip over merged nodes.

Properties

id size_t id [@property getter]
id size_t id [@property getter]
isFullyMerged bool isFullyMerged [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
unshared Handle unshared [@property getter]: Atomically loads a shared Handle.
width size_t width [@property getter]
width size_t width [@property getter]

Static functions

fixedAllocSize size_t fixedAllocSize(Args a)
make Handle make(size_t id, BagArgs bagArgs): GC allocates a new Node and returns a Handle to it.
makeWith Handle makeWith(size_t id, BagArgs bagArgs): Static factory method which uses Alloc to allocate a new Node and returns a Handle to it.