data-structure-typed 2.5.2 → 2.6.0

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

@@ -6,13 +6,13 @@
 
 # Class: Heap\<E, R\>
 
-Defined in: [data-structures/heap/heap.ts:150](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L150)
+Defined in: [data-structures/heap/heap.ts:150](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L150)
 
 Binary heap with pluggable comparator; supports fast insertion and removal of the top element.
 
 ## Remarks
 
-Time O(1), Space O(1)
+Typical operations: O(log N) insert/remove, O(1) peek. Space O(N).
 
 ## Examples
 
@@ -186,7 +186,7 @@ Min Heap: The value of each parent node is less than or equal to the value of it
 new Heap<E, R>(elements?, options?): Heap<E, R>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:161](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L161)
+Defined in: [data-structures/heap/heap.ts:161](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L161)
 
 Create a Heap and optionally bulk-insert elements.
 
@@ -228,7 +228,7 @@ Time O(N), Space O(N)
 get comparator(): Comparator<E>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1184](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1184)
+Defined in: [data-structures/heap/heap.ts:1272](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1272)
 
 Get the comparator used to order elements.
 
@@ -252,7 +252,7 @@ Comparator function.
 get elements(): E[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:180](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L180)
+Defined in: [data-structures/heap/heap.ts:180](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L180)
 
 Get the backing array of the heap.
 
@@ -276,7 +276,7 @@ Internal elements array.
 get leaf(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:244](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L244)
+Defined in: [data-structures/heap/heap.ts:248](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L248)
 
 Get the last leaf element.
 
@@ -300,7 +300,7 @@ Last element or undefined.
 get size(): number;
 ```
 
-Defined in: [data-structures/heap/heap.ts:234](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L234)
+Defined in: [data-structures/heap/heap.ts:238](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L238)
 
 Get the number of elements.
 
@@ -339,7 +339,7 @@ Heap size.
 get toElementFn(): ((rawElement) => E) | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L48)
+Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L48)
 
 Exposes the current `toElementFn`, if configured.
 
@@ -365,7 +365,7 @@ The converter function or `undefined` when not set.
 iterator: IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L61)
+Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L61)
 
 Returns an iterator over the structure's 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:338](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L338)
+Defined in: [data-structures/heap/heap.ts:346](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L346)
 
 Insert an element.
 
@@ -421,7 +421,7 @@ True.
 
 #### Remarks
 
-Time O(1) amortized, Space O(1)
+Time O(log N) amortized, Space O(1)
 
 #### Example
 
@@ -450,7 +450,7 @@ Time O(1) amortized, Space O(1)
 addMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:388](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L388)
+Defined in: [data-structures/heap/heap.ts:400](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L400)
 
 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:676](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L676)
+Defined in: [data-structures/heap/heap.ts:740](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L740)
 
 Remove all elements.
 
@@ -529,7 +529,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1020](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1020)
+Defined in: [data-structures/heap/heap.ts:1100](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1100)
 
 Deep clone this heap.
 
@@ -568,7 +568,7 @@ Time O(N), Space O(N)
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:779](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L779)
+Defined in: [data-structures/heap/heap.ts:841](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L841)
 
 Delete one occurrence of an element.
 
@@ -603,13 +603,37 @@ Time O(N), Space O(1)
 
 ***
 
-### deleteBy()
+### ~~deleteBy()~~
 
 ```ts
 deleteBy(predicate): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:807](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L807)
+Defined in: [data-structures/heap/heap.ts:865](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L865)
+
+#### Parameters
+
+##### predicate
+
+(`element`, `index`, `heap`) => `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Deprecated
+
+Use `deleteWhere` instead. Will be removed in a future major version.
+
+***
+
+### deleteWhere()
+
+```ts
+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)
 
 Delete the first element that matches a predicate.
 
@@ -639,7 +663,7 @@ Time O(N), Space O(1)
 dfs(order?): E[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:878](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L878)
+Defined in: [data-structures/heap/heap.ts:950](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L950)
 
 Traverse the binary heap as a complete binary tree and collect elements.
 
@@ -680,7 +704,7 @@ Time O(N), Space O(H)
 every(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L87)
+Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L87)
 
 Tests whether all elements satisfy the predicate.
 
@@ -720,7 +744,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:1072](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1072)
+Defined in: [data-structures/heap/heap.ts:1156](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1156)
 
 Filter elements into a new heap of the same class.
 
@@ -773,7 +797,7 @@ Time O(N log N), Space O(N)
 find<S>(predicate, thisArg?): S | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L163)
+Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L163)
 
 Finds the first element that satisfies the predicate and returns it.
 
@@ -819,7 +843,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 find(predicate, thisArg?): E | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L164)
+Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L164)
 
 Finds the first element that satisfies the predicate and returns it.
 
@@ -861,7 +885,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:909](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L909)
+Defined in: [data-structures/heap/heap.ts:981](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L981)
 
 Restore heap order bottom-up (heapify in-place).
 
@@ -883,7 +907,7 @@ Time O(N), Space O(1)
 forEach(callbackfn, thisArg?): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L133)
+Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L133)
 
 Invokes a callback for each element in iteration order.
 
@@ -923,7 +947,7 @@ Time O(n), Space O(1).
 has(element): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:730](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L730)
+Defined in: [data-structures/heap/heap.ts:788](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L788)
 
 Check if an equal element exists in the heap.
 
@@ -968,7 +992,7 @@ Time O(N), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/heap/heap.ts:628](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L628)
+Defined in: [data-structures/heap/heap.ts:688](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L688)
 
 Check whether the heap is empty.
 
@@ -1009,7 +1033,7 @@ map<EM, RM>(
 thisArg?): Heap<EM, RM>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1133](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1133)
+Defined in: [data-structures/heap/heap.ts:1221](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1221)
 
 Map elements into a new heap of possibly different element type.
 
@@ -1076,7 +1100,7 @@ Time O(N log N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1157](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1157)
+Defined in: [data-structures/heap/heap.ts:1245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1245)
 
 Map elements into a new heap of the same element type.
 
@@ -1116,7 +1140,7 @@ Time O(N log N), Space O(N)
 peek(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:579](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L579)
+Defined in: [data-structures/heap/heap.ts:635](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L635)
 
 Get the current top element without removing it.
 
@@ -1197,28 +1221,23 @@ Time O(1), Space O(1)
 
 ***
 
-### poll()
+### ~~poll()~~
 
 ```ts
 poll(): E | undefined;
 ```
 
-Defined in: [data-structures/heap/heap.ts:468](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L468)
-
-Remove and return the top element.
+Defined in: [data-structures/heap/heap.ts:511](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L511)
 
 #### Returns
 
 `E` \| `undefined`
 
-Top element or undefined.
+#### Deprecated
 
+Use `pop` instead. Will be removed in a future major version.
  *
 
-#### Remarks
-
-Time O(log N), Space O(1)
-
 #### Example
 
 ```ts
@@ -1250,13 +1269,35 @@ Time O(log N), Space O(1)
 
 ***
 
+### pop()
+
+```ts
+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)
+
+Remove and return the top element (min or max depending on comparator).
+
+#### Returns
+
+`E` \| `undefined`
+
+The removed top element, or undefined if empty.
+
+#### Remarks
+
+Time O(log N) amortized, Space O(1)
+
+***
+
 ### print()
 
 ```ts
 print(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L269)
+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)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1314,7 +1355,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L194)
+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)
 
 ##### Parameters
 
@@ -1336,7 +1377,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L195)
+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)
 
 ##### Parameters
 
@@ -1362,7 +1403,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L196)
+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)
 
 ##### Type Parameters
 
@@ -1390,43 +1431,13 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
 
 ***
 
-### refill()
-
-```ts
-refill(elements): boolean[];
-```
-
-Defined in: [data-structures/heap/heap.ts:687](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L687)
-
-Replace the backing array and rebuild the heap.
-
-#### Parameters
-
-##### elements
-
-`Iterable`\<`E`\>
-
-Iterable used to refill the heap.
-
-#### Returns
-
-`boolean`[]
-
-Array of per-node results from fixing steps.
-
-#### Remarks
-
-Time O(N), Space O(N)
-
-***
-
 ### setEquality()
 
 ```ts
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:835](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L835)
+Defined in: [data-structures/heap/heap.ts:903](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L903)
 
 Set the equality comparator used by has/delete operations.
 
@@ -1456,7 +1467,7 @@ Time O(1), Space O(1)
 some(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L110)
+Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L110)
 
 Tests whether at least one element satisfies the predicate.
 
@@ -1496,7 +1507,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:963](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L963)
+Defined in: [data-structures/heap/heap.ts:1039](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1039)
 
 Return all elements in ascending order by repeatedly polling.
 
@@ -1529,7 +1540,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L246)
+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)
 
 Materializes the elements into a new array.
 
@@ -1555,7 +1566,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L258)
+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)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -1582,7 +1593,7 @@ Time O(n), Space O(n).
 values(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L72)
+Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L72)
 
 Returns an iterator over the values (alias of the default iterator).
 
@@ -1611,7 +1622,7 @@ static from<T, R, S>(
    options?): S;
 ```
 
-Defined in: [data-structures/heap/heap.ts:259](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L259)
+Defined in: [data-structures/heap/heap.ts:263](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L263)
 
 Create a heap of the same class from an iterable.
 
@@ -1665,7 +1676,7 @@ Time O(N), Space O(N)
 static heapify<EE, RR>(elements, options): Heap<EE, RR>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:277](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L277)
+Defined in: [data-structures/heap/heap.ts:281](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L281)
 
 Build a Heap from an iterable in linear time given a comparator.
 
@@ -1714,7 +1725,7 @@ Time O(N), Space O(N)
 protected optional _toElementFn?: (rawElement) => E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L39)
+Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L39)
 
 The converter used to transform a raw element (`R`) into a public element (`E`).
 
@@ -1744,7 +1755,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1230](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1230)
+Defined in: [data-structures/heap/heap.ts:1318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1318)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -1774,7 +1785,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): Heap<EM, RM>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1248](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1248)
+Defined in: [data-structures/heap/heap.ts:1336](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1336)
 
 (Protected) Create a like-kind instance seeded by elements.
 
@@ -1820,7 +1831,7 @@ Time O(N log N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/heap/heap.ts:1188](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1188)
+Defined in: [data-structures/heap/heap.ts:1276](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1276)
 
 Internal iterator factory used by the default iterator.
 
@@ -1846,7 +1857,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:1268](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/heap/heap.ts#L1268)
+Defined in: [data-structures/heap/heap.ts:1356](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L1356)
 
 (Protected) Spawn an empty like-kind heap instance.