Heap

A collection of values with the largest always on top.

A heap is a binary tree where each node is greater than both its leaves. The tree itself is complete or nearly complete at all times, so the heap is backed by a compact array. When values are added or removed, the tree rotates until the value has sunk until its parent is greater, or floated until all children are less.

Values are presumed to not change in relative position without first being removed, and perhaps added back, or adjusted after mutation using sink(index) or float(index).

Properties

length: The number of items in this collection.

Methods

push(...values): Adds values to the end of a collection.
pop(): Removes a value from the end of a collection, and returns that value.
peek(): Returns the value at the beginning of a collection, the value that would be returned by shift().
delete(value): Deletes the first equivalent value. Returns whether the key was found and successfully deleted.
addEach(values|map): Copies values or entries from another collection into this collection, and then returns this.
deleteEach(values|keys, equals?): Deletes every value or every value for each key. Returns the number of successful deletions.
clear(): Deletes all of the values in the collection.
indexOf(value): Returns the position of a value, or -1 if the value is not found.
iterate|iterator(): Iterates every value in this collection.
forEach(callback, thisp?): Calls the callback for each entry in the collection.
map(callback, thisp?): Returns an array of the respective return values of a callback for each entry in this collection.
filter(callback, thisp?): Returns an array with each value from this collection that passes the given test.
reduce(callback, basis): Aggregates every value in this collection with the result collected up to that index.
reduceRight(callback, basis): Aggregates every value in this collection, from right to left.
group(callback, thisp?, equals?): Returns an array of [key, class] entries where every value from the collection is placed into the same equivalence class if they return the same key through the given callback.
some(callback, thisp?): Returns whether any entry in this collection passes a given test.
every(callback, thisp?): Returns whether every entry in this collection passes a given test.
any(): Returns whether any value in the collection is truthy.
all(): Returns whether all values in the collection are truthy.
one(): Returns one, arbitrary value from this collection, or undefined if there are none.
only(): Returns the only value in this collection, or undefined if there is more than one value, or if there are no values in the collection.
sorted(compare?): Returns a sorted array of the values in this collection.
reversed(): Returns a copy of this collection with the values in reverse order.
join(delimiter?): Returns a string of all the values in the collection delimited by the given string.
sum(zero?): Returns the sum of all values in this collection.
average(): Returns the arithmetic mean of the collection, by computing its sum and the count of values and returning the quotient.
min(): Returns the smallest value in this collection.
max(): Returns the largest value in this collection.
zip(...iterables): Returns an array of the respective values in this collection and in each collection provided as an argument.
enumerate(start?): Returns an array of [index, value] entries for each value in this collection, counting all values from the given index.
concat(...iterables): Returns a new collection of the same type containing all the values of itself and the values of any number of other iterable collections in order.
flatten(): Assuming that this is a collection of collections, returns a new collection that contains all the values of each nested collection in order.
toArray(): Returns an array of each value in this collection.
toObject(): Returns an object with each property name and value corresponding to the entries in this collection.
toJSON(): Used by JSON.stringify to create a JSON representation of the collection.
clone(depth?, memo?): Creates a deep replica of this collection.
constructClone(values?): Creates a shallow clone of this collection.
contentCompare(left, right): The compare function used by this collection to determine how to order its own values.
contentEquals(left, right): The equals function used to check whether values in this collection are equivalent.
addRangeChangeListener(listener, token?, beforeChange?): Adds a listener for when values are added or removed at any position.
removeRangeChangeListener(listener, token?, beforeChange?): Unregisters a range change listener provided by addRangeChangeListener.
dispatchRangeChange(plus, minus, index, beforeChange?): Informs range change listeners that values were removed then added at an index.
addBeforeRangeChangeListener(listener, token?): Adds a listener for before values are added or removed at any position.
removeBeforeRangeChangeListener(listener, token?): Unregisters a range change listener provided by addBeforeRangeChangeListener or addRangeChangeListener with the beforeChange flag.
dispatchBeforeRangeChange(plus, minus, index): Informs range change listeners that values will be removed then added at an index.
addMapChangeListener(listener, token?, beforeChange?): Adds a listener for when the value for a key changes, or when entries are added or removed.
addBeforeMapChangeListener(listener, token?): Adds a listener for before map entries are created, deleted, or updated.
removeMapChangeListener(listener, token?, beforeChange?): Unregisters a map change listener provided by addMapChangeListener.
removeBeforeMapChangeListener(listener, token?): Unregisters a map change listener provided by addBeforeMapChangeListener or addMapChangeListener with the beforeChange flag.
dispatchMapChange(key, value, beforeChange?): Informs map change listeners that an entry was created, deleted, or updated.
dispatchBeforeMapChange(key, value): Informs map change listeners that an entry will be created, deleted, or updated.
addOwnPropertyChangeListener(key, listener, beforeChange?): Adds a listener for an owned property with the given name.
addBeforeOwnPropertyChangeListener(name, listener): Adds a listener for before a property changes.
removeOwnPropertyChangeListener(name, listener, beforeChange?): Unregisters a property change listener provided by addOwnPropertyChangeListener.
removeBeforeOwnPropertyChangeListener(key, listener): Unregisters a property change listener provided by addBeforeOwnPropertyChangeListener or addOwnPropertyChangeListener with the beforeChange flag.
dispatchOwnPropertyChange(key, value, beforeChange?): Informs property change listeners that the value for a property name has changed.
dispatchBeforeOwnPropertyChange(key, value): Informs property change listeners that the value for a property name will change.
makePropertyObservable(name): May perform internal changes necessary to dispatch property changes for a particular name.

Usage

var Heap = require("collections/heap");

Heap()
Heap(values)
Heap(values, equals, compare)

Examples

var heap = new Heap([2, 8, 5]);
heap.push(6)
heap.pop();
heap.peek();

var minHeap = new Heap([2, 8, 5], null, function (a, b) {
    return b - a ;
});
minHeap.push(6)
minHeap.pop();
minHeap.peek();

Source code

Generated from heap.md