Functions

heapPush(heap, item[, cmp]):

Push the value item onto the heap, maintaining the heap invariant.

heapPop(heap[, cmp]):

Pop the smallest item off the heap, maintaining the heap invariant.

heapPushPop(heap, item[, cmp]):

Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heapPush() followed by a separate call to heapPop().

heapify(x[, cmp]):

Transform array x into a heap, in-place, in linear time. Returns the heap to enable chaining.

heapReplace(heap, item[, cmp]):

Pop and return the smallest item from the heap, and also push the new item. The heap size doesn’t change. If the heap is empty, IndexError is raised.

This one step operation is more efficient than a heapPop() followed by heapPush() and can be more appropriate when using a fixed-size heap. The pop/push combination always returns an element from the heap and replaces it with item.

The value returned may be larger than the item added. If that isn’t desired, consider using heapPushPop() instead. Its push/pop combination returns the smaller of the two values, leaving the larger value on the heap.

imergeSorted(iterables[, cmp]):

Merge multiple sorted inputs into a single sorted output (for example, merge timestamped entries from multiple log files). Returns an iterator over the sorted values.

Similar to sorted(chain(iterables)) but returns an iterable, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest).

isHeap(lst[, cmp]):

Test if the lst Array fulfills the heap invariant.

note: Observe that, in contrast to the default cmp in base heap functions, the compare fn must return true for equal elements also.

nLargest(n, iterable[, cmp]):

Return a list with the n largest elements from the dataset defined by iterable.

nSmallest(n, iterable[, cmp]):

Return a list with the n smallest elements from the dataset defined by iterable.