data-structure-typed 2.6.0 → 2.6.1

package/docs-site-docusaurus/docs/api/classes/FibonacciHeap.md

@@ -6,7 +6,7 @@
 
 # Class: FibonacciHeap\<E\>
 
-Defined in: [data-structures/heap/heap.ts:1388](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1388)
+Defined in: [data-structures/heap/heap.ts:1430](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1430)
 
 Fibonacci heap (min-heap) optimized for fast merges and amortized operations.
 
@@ -34,7 +34,7 @@ examples will be generated by unit test
 new FibonacciHeap<E>(comparator?): FibonacciHeap<E>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1396](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1396)
+Defined in: [data-structures/heap/heap.ts:1438](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1438)
 
 Create a FibonacciHeap.
 
@@ -66,7 +66,7 @@ Time O(1), Space O(1)
 get min(): FibonacciHeapNode<E> | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1427](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1427)
+Defined in: [data-structures/heap/heap.ts:1469](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1469)
 
 Get the current minimum node.
 
@@ -90,7 +90,7 @@ Min node or undefined.
 get root(): FibonacciHeapNode<E> | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1410](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1410)
+Defined in: [data-structures/heap/heap.ts:1452](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1452)
 
 Get the circular root list head.
 
@@ -112,7 +112,7 @@ Root node or undefined.
 consumeLinkedList(head?): FibonacciHeapNode<E>[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:1476](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1476)
+Defined in: [data-structures/heap/heap.ts:1518](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1518)
 
 Collect nodes from a circular doubly linked list starting at head.
 
@@ -142,7 +142,7 @@ Time O(K), Space O(K)
 merge(heapToMerge): void;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1547](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1547)
+Defined in: [data-structures/heap/heap.ts:1589](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1589)
 
 Meld another heap into this heap.
 
@@ -172,7 +172,7 @@ Time O(1), Space O(1)
 mergeWithChild(parent, node): void;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1498](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1498)
+Defined in: [data-structures/heap/heap.ts:1540](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1540)
 
 Insert a node into a parent's child list (circular).
 
@@ -208,7 +208,7 @@ Time O(1), Space O(1)
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1518](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1518)
+Defined in: [data-structures/heap/heap.ts:1560](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1560)
 
 Remove and return the minimum element, consolidating the root list.
 
@@ -230,7 +230,7 @@ Time O(log N) amortized, Space O(1)
 push(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1455](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1455)
+Defined in: [data-structures/heap/heap.ts:1497](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1497)
 
 Push an element into the root list.
 

package/docs-site-docusaurus/docs/api/classes/FibonacciHeapNode.md

@@ -6,7 +6,7 @@
 
 # Class: FibonacciHeapNode\<E\>
 
-Defined in: [data-structures/heap/heap.ts:1366](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1366)
+Defined in: [data-structures/heap/heap.ts:1408](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1408)
 
 Node container used by FibonacciHeap.
 

package/docs-site-docusaurus/docs/api/classes/HashMap.md

@@ -317,7 +317,7 @@ Time O(n) to iterate, Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:267](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L267)
+Defined in: [data-structures/hash/hash-map.ts:273](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L273)
 
 Remove all entries and reset counters.
 
@@ -354,7 +354,7 @@ Time O(N), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:716](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L716)
+Defined in: [data-structures/hash/hash-map.ts:743](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L743)
 
 Deep clone this map, preserving hashing behavior.
 
@@ -392,7 +392,7 @@ Time O(N), Space O(N)
 delete(key): boolean;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:641](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L641)
+Defined in: [data-structures/hash/hash-map.ts:665](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L665)
 
 Delete an entry by key.
 
@@ -501,7 +501,7 @@ Time O(n), Space O(1)
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:854](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L854)
+Defined in: [data-structures/hash/hash-map.ts:887](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L887)
 
 Filter entries into a new map.
 
@@ -650,7 +650,7 @@ Time O(n), Space O(1)
 get(key): V | undefined;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:526](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L526)
+Defined in: [data-structures/hash/hash-map.ts:544](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L544)
 
 Get the value for a key.
 
@@ -711,7 +711,7 @@ Time O(1), Space O(1)
 has(key): boolean;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:583](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L583)
+Defined in: [data-structures/hash/hash-map.ts:604](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L604)
 
 Check if a key exists.
 
@@ -791,7 +791,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:216](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L216)
+Defined in: [data-structures/hash/hash-map.ts:219](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L219)
 
 Check whether the map is empty.
 
@@ -827,7 +827,7 @@ Time O(1), Space O(1)
 isEntry(rawElement): rawElement is [K, V];
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L278)
+Defined in: [data-structures/hash/hash-map.ts:284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L284)
 
 Type guard: check if a raw value is a [key, value] entry.
 
@@ -881,7 +881,7 @@ Time O(n), Space O(1)
 map<VM>(callbackfn, thisArg?): HashMap<K, VM>;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:775](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L775)
+Defined in: [data-structures/hash/hash-map.ts:805](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L805)
 
 Map values to a new map with the same keys.
 
@@ -1010,7 +1010,7 @@ Time O(n), Space O(1)
 set(key, value): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:385](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L385)
+Defined in: [data-structures/hash/hash-map.ts:397](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L397)
 
 Insert or replace a single entry.
 
@@ -1070,7 +1070,7 @@ Time O(1), Space O(1)
 setHashFn(fn): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:661](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L661)
+Defined in: [data-structures/hash/hash-map.ts:685](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L685)
 
 Replace the hash function and rehash the non-object store.
 
@@ -1100,7 +1100,7 @@ Time O(N), Space O(N)
 setMany(entryOrRawElements): boolean[];
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:445](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L445)
+Defined in: [data-structures/hash/hash-map.ts:460](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L460)
 
 Insert many entries from an iterable.
 
@@ -1262,7 +1262,7 @@ Time O(n), Space O(1)
 protected _createLike<TK, TV, TR>(entries?, options?): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:871](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L871)
+Defined in: [data-structures/hash/hash-map.ts:904](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L904)
 
 (Protected) Create a like-kind instance and seed it from an iterable.
 
@@ -1312,7 +1312,7 @@ Time O(N), Space O(N)
 protected _getIterator(): IterableIterator<[K, V]>;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:885](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L885)
+Defined in: [data-structures/hash/hash-map.ts:918](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L918)
 
 Underlying iterator for the default iteration protocol.
 

package/docs-site-docusaurus/docs/api/classes/Heap.md

@@ -228,7 +228,7 @@ Time O(N), Space O(N)
 get comparator(): Comparator<E>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1272](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1272)
+Defined in: [data-structures/heap/heap.ts:1314](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1314)
 
 Get the comparator used to order elements.
 
@@ -276,7 +276,7 @@ Internal elements array.
 get leaf(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:248](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L248)
+Defined in: [data-structures/heap/heap.ts:251](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L251)
 
 Get the last leaf element.
 
@@ -300,7 +300,7 @@ Last element or undefined.
 get size(): number;
 ```
 
-Defined in: [data-structures/heap/heap.ts:238](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L238)
+Defined in: [data-structures/heap/heap.ts:241](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L241)
 
 Get the number of elements.
 
@@ -399,7 +399,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 add(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:346](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L346)
+Defined in: [data-structures/heap/heap.ts:352](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L352)
 
 Insert an element.
 
@@ -450,7 +450,7 @@ Time O(log N) amortized, Space O(1)
 addMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:400](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L400)
+Defined in: [data-structures/heap/heap.ts:409](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L409)
 
 Insert many elements from an iterable.
 
@@ -492,7 +492,7 @@ Time O(N log N), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/heap/heap.ts:740](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L740)
+Defined in: [data-structures/heap/heap.ts:761](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L761)
 
 Remove all elements.
 
@@ -529,7 +529,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1100](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1100)
+Defined in: [data-structures/heap/heap.ts:1136](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1136)
 
 Deep clone this heap.
 
@@ -568,7 +568,7 @@ Time O(N), Space O(N)
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:841](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L841)
+Defined in: [data-structures/heap/heap.ts:868](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L868)
 
 Delete one occurrence of an element.
 
@@ -609,7 +609,7 @@ Time O(N), Space O(1)
 deleteBy(predicate): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:865](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L865)
+Defined in: [data-structures/heap/heap.ts:892](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L892)
 
 #### Parameters
 
@@ -633,7 +633,7 @@ Use `deleteWhere` instead. Will be removed in a future major version.
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:875](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L875)
+Defined in: [data-structures/heap/heap.ts:902](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L902)
 
 Delete the first element that matches a predicate.
 
@@ -663,7 +663,7 @@ Time O(N), Space O(1)
 dfs(order?): E[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:950](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L950)
+Defined in: [data-structures/heap/heap.ts:980](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L980)
 
 Traverse the binary heap as a complete binary tree and collect elements.
 
@@ -698,6 +698,30 @@ Time O(N), Space O(H)
 
 ***
 
+### entries()
+
+```ts
+entries(): IterableIterator<[number, E]>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:208](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L208)
+
+Return an iterator of `[index, value]` pairs (Array-compatible).
+
+#### Returns
+
+`IterableIterator`\<\[`number`, `E`\]\>
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+
+#### Inherited from
+
+[`IterableElementBase`](IterableElementBase.md).[`entries`](IterableElementBase.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -744,7 +768,7 @@ Time O(n) in the worst case; may exit early when the first failure is found. Spa
 filter(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1156](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1156)
+Defined in: [data-structures/heap/heap.ts:1195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1195)
 
 Filter elements into a new heap of the same class.
 
@@ -885,7 +909,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 fix(): boolean[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:981](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L981)
+Defined in: [data-structures/heap/heap.ts:1011](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1011)
 
 Restore heap order bottom-up (heapify in-place).
 
@@ -947,7 +971,7 @@ Time O(n), Space O(1).
 has(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:788](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L788)
+Defined in: [data-structures/heap/heap.ts:812](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L812)
 
 Check if an equal element exists in the heap.
 
@@ -986,13 +1010,47 @@ Time O(N), Space O(1)
 
 ***
 
+### includes()
+
+```ts
+includes(element): boolean;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:200](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L200)
+
+Check whether a value exists (Array-compatible alias for `has`).
+
+#### Parameters
+
+##### element
+
+`E`
+
+Element to search for (uses `===`).
+
+#### Returns
+
+`boolean`
+
+`true` if found.
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1).
+
+#### Inherited from
+
+[`IterableElementBase`](IterableElementBase.md).[`includes`](IterableElementBase.md#includes)
+
+***
+
 ### isEmpty()
 
 ```ts
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:688](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L688)
+Defined in: [data-structures/heap/heap.ts:706](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L706)
 
 Check whether the heap is empty.
 
@@ -1024,6 +1082,30 @@ Time O(1), Space O(1)
 
 ***
 
+### keys()
+
+```ts
+keys(): IterableIterator<number>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:219](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L219)
+
+Return an iterator of numeric indices (Array-compatible).
+
+#### Returns
+
+`IterableIterator`\<`number`\>
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+
+#### Inherited from
+
+[`IterableElementBase`](IterableElementBase.md).[`keys`](IterableElementBase.md#keys)
+
+***
+
 ### map()
 
 ```ts
@@ -1033,7 +1115,7 @@ map<EM, RM>(
 thisArg?): Heap<EM, RM>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1221](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1221)
+Defined in: [data-structures/heap/heap.ts:1263](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1263)
 
 Map elements into a new heap of possibly different element type.
 
@@ -1100,7 +1182,7 @@ Time O(N log N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1245)
+Defined in: [data-structures/heap/heap.ts:1287](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1287)
 
 Map elements into a new heap of the same element type.
 
@@ -1140,7 +1222,7 @@ Time O(N log N), Space O(N)
 peek(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:635](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L635)
+Defined in: [data-structures/heap/heap.ts:650](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L650)
 
 Get the current top element without removing it.
 
@@ -1227,7 +1309,7 @@ Time O(1), Space O(1)
 poll(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:511](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L511)
+Defined in: [data-structures/heap/heap.ts:523](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L523)
 
 #### Returns
 
@@ -1236,6 +1318,7 @@ Defined in: [data-structures/heap/heap.ts:511](https://github.com/zrwusa/data-st
 #### Deprecated
 
 Use `pop` instead. Will be removed in a future major version.
+
  *
 
 #### Example
@@ -1275,7 +1358,7 @@ Use `pop` instead. Will be removed in a future major version.
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:520](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L520)
+Defined in: [data-structures/heap/heap.ts:532](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L532)
 
 Remove and return the top element (min or max depending on comparator).
 
@@ -1297,7 +1380,7 @@ Time O(log N) amortized, Space O(1)
 print(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L269)
+Defined in: [data-structures/base/iterable-element-base.ts:301](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L301)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1355,7 +1438,7 @@ Time O(n), Space O(1). Throws if called on an empty structure without `initialVa
 reduce(callbackfn): E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L194)
+Defined in: [data-structures/base/iterable-element-base.ts:226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L226)
 
 ##### Parameters
 
@@ -1377,7 +1460,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.c
 reduce(callbackfn, initialValue): E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L195)
+Defined in: [data-structures/base/iterable-element-base.ts:227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L227)
 
 ##### Parameters
 
@@ -1403,7 +1486,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.c
 reduce<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L196)
+Defined in: [data-structures/base/iterable-element-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L228)
 
 ##### Type Parameters
 
@@ -1437,7 +1520,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:903](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L903)
+Defined in: [data-structures/heap/heap.ts:930](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L930)
 
 Set the equality comparator used by has/delete operations.
 
@@ -1507,7 +1590,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
 sort(): E[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:1039](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1039)
+Defined in: [data-structures/heap/heap.ts:1072](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1072)
 
 Return all elements in ascending order by repeatedly polling.
 
@@ -1540,7 +1623,7 @@ Time O(N log N), Space O(N)
 toArray(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:246](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L246)
+Defined in: [data-structures/base/iterable-element-base.ts:278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L278)
 
 Materializes the elements into a new array.
 
@@ -1566,7 +1649,7 @@ Time O(n), Space O(n).
 toVisual(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:258](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L258)
+Defined in: [data-structures/base/iterable-element-base.ts:290](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L290)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -1622,7 +1705,7 @@ static from<T, R, S>(
    options?): S;
 ```
 
-Defined in: [data-structures/heap/heap.ts:263](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L263)
+Defined in: [data-structures/heap/heap.ts:266](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L266)
 
 Create a heap of the same class from an iterable.
 
@@ -1676,7 +1759,7 @@ Time O(N), Space O(N)
 static heapify<EE, RR>(elements, options): Heap<EE, RR>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:281](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L281)
+Defined in: [data-structures/heap/heap.ts:284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L284)
 
 Build a Heap from an iterable in linear time given a comparator.
 
@@ -1755,7 +1838,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1318)
+Defined in: [data-structures/heap/heap.ts:1360](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1360)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -1785,7 +1868,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): Heap<EM, RM>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1336](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1336)
+Defined in: [data-structures/heap/heap.ts:1378](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1378)
 
 (Protected) Create a like-kind instance seeded by elements.
 
@@ -1831,7 +1914,7 @@ Time O(N log N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1276](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1276)
+Defined in: [data-structures/heap/heap.ts:1318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1318)
 
 Internal iterator factory used by the default iterator.
 
@@ -1857,7 +1940,7 @@ Implementations should yield in O(1) per element with O(1) extra space when poss
 protected _spawnLike<EM, RM>(options?): Heap<EM, RM>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1356](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1356)
+Defined in: [data-structures/heap/heap.ts:1398](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1398)
 
 (Protected) Spawn an empty like-kind heap instance.