data-structure-typed 2.5.2 → 2.5.3

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

@@ -6,7 +6,7 @@
 
 # Class: MinPriorityQueue\<E, R\>
 
-Defined in: [data-structures/priority-queue/min-priority-queue.ts:79](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/priority-queue/min-priority-queue.ts#L79)
+Defined in: [data-structures/priority-queue/min-priority-queue.ts:79](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/priority-queue/min-priority-queue.ts#L79)
 
 Min-oriented priority queue (min-heap) built on [PriorityQueue](PriorityQueue.md).
 The queue removes the smallest element first under the provided comparator.
@@ -107,7 +107,7 @@ Extra record/metadata associated with each element.
 new MinPriorityQueue<E, R>(elements?, options?): MinPriorityQueue<E, R>;
 ```
 
-Defined in: [data-structures/priority-queue/min-priority-queue.ts:86](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/priority-queue/min-priority-queue.ts#L86)
+Defined in: [data-structures/priority-queue/min-priority-queue.ts:86](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/priority-queue/min-priority-queue.ts#L86)
 
 Creates a min-priority queue.
 
@@ -149,7 +149,7 @@ PriorityQueue<E, R>.constructor
 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.
 
@@ -177,7 +177,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.
 
@@ -205,7 +205,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.
 
@@ -233,7 +233,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.
 
@@ -276,7 +276,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.
 
@@ -302,7 +302,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.
 
@@ -336,7 +336,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.
 
@@ -358,7 +358,7 @@ True.
 
 #### Remarks
 
-Time O(1) amortized, Space O(1)
+Time O(log N) amortized, Space O(1)
 
 #### Example
 
@@ -391,7 +391,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.
 
@@ -437,7 +437,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.
 
@@ -474,7 +474,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.
 
@@ -513,7 +513,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.
 
@@ -552,13 +552,41 @@ 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.
+
+#### Inherited from
+
+[`PriorityQueue`](PriorityQueue.md).[`deleteBy`](PriorityQueue.md#deleteby)
+
+***
+
+### 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.
 
@@ -582,7 +610,7 @@ Time O(N), Space O(1)
 
 #### Inherited from
 
-[`PriorityQueue`](PriorityQueue.md).[`deleteBy`](PriorityQueue.md#deleteby)
+[`PriorityQueue`](PriorityQueue.md).[`deleteWhere`](PriorityQueue.md#deletewhere)
 
 ***
 
@@ -592,7 +620,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.
 
@@ -637,7 +665,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.
 
@@ -677,7 +705,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.
 
@@ -730,7 +758,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.
 
@@ -776,7 +804,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.
 
@@ -818,7 +846,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).
 
@@ -844,7 +872,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.
 
@@ -884,7 +912,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.
 
@@ -929,7 +957,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.
 
@@ -970,7 +998,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.
 
@@ -1037,7 +1065,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.
 
@@ -1077,7 +1105,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.
 
@@ -1162,28 +1190,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
@@ -1219,13 +1242,39 @@ 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)
+
+#### Inherited from
+
+[`PriorityQueue`](PriorityQueue.md).[`pop`](PriorityQueue.md#pop)
+
+***
+
 ### 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.
 
@@ -1283,7 +1332,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
 
@@ -1305,7 +1354,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
 
@@ -1331,7 +1380,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
 
@@ -1359,47 +1408,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)
-
-#### Inherited from
-
-[`PriorityQueue`](PriorityQueue.md).[`refill`](PriorityQueue.md#refill)
-
-***
-
 ### 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.
 
@@ -1433,7 +1448,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.
 
@@ -1473,7 +1488,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.
 
@@ -1510,7 +1525,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.
 
@@ -1536,7 +1551,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.
@@ -1563,7 +1578,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).
 
@@ -1592,7 +1607,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.
 
@@ -1650,7 +1665,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.
 
@@ -1703,7 +1718,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`).
 
@@ -1733,7 +1748,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.
 
@@ -1767,7 +1782,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.
 
@@ -1817,7 +1832,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.
 
@@ -1843,7 +1858,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.
 

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

@@ -6,7 +6,7 @@
 
 # Class: Navigator\<T\>
 
-Defined in: [data-structures/matrix/navigator.ts:31](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/navigator.ts#L31)
+Defined in: [data-structures/matrix/navigator.ts:31](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/navigator.ts#L31)
 
 ## Type Parameters
 
@@ -22,7 +22,7 @@ Defined in: [data-structures/matrix/navigator.ts:31](https://github.com/zrwusa/d
 new Navigator<T>(-): Navigator<T>;
 ```
 
-Defined in: [data-structures/matrix/navigator.ts:43](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/navigator.ts#L43)
+Defined in: [data-structures/matrix/navigator.ts:43](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/navigator.ts#L43)
 
 The constructor initializes the Navigator object with the given parameters and sets the current position as visited
 in the matrix.
@@ -47,7 +47,7 @@ in the matrix.
 check(direction): boolean;
 ```
 
-Defined in: [data-structures/matrix/navigator.ts:74](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/navigator.ts#L74)
+Defined in: [data-structures/matrix/navigator.ts:74](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/navigator.ts#L74)
 
 The function checks if there is a valid move in the specified direction in a matrix.
 
@@ -74,7 +74,7 @@ a boolean value.
 move(direction): void;
 ```
 
-Defined in: [data-structures/matrix/navigator.ts:104](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/navigator.ts#L104)
+Defined in: [data-structures/matrix/navigator.ts:104](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/navigator.ts#L104)
 
 The `move` function updates the current position based on the given direction and updates the matrix accordingly.
 
@@ -99,7 +99,7 @@ It can have one of the following values: 'up', 'right', 'down', or 'left'.
 start(): void;
 ```
 
-Defined in: [data-structures/matrix/navigator.ts:57](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/navigator.ts#L57)
+Defined in: [data-structures/matrix/navigator.ts:57](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/navigator.ts#L57)
 
 The "start" function moves the character in its current direction until it encounters an obstacle, then it turns the
 character and repeats the process.