data-structure-typed 2.6.0 → 2.6.2

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

@@ -6,7 +6,7 @@
 
 # Class: PriorityQueue\<E, R\>
 
-Defined in: [data-structures/priority-queue/priority-queue.ts:75](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/priority-queue/priority-queue.ts#L75)
+Defined in: [data-structures/priority-queue/priority-queue.ts:74](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/priority-queue/priority-queue.ts#L74)
 
 ## Examples
 
@@ -66,7 +66,7 @@ Defined in: [data-structures/priority-queue/priority-queue.ts:75](https://github
       comparator: (a, b) => a[0] - b[0]
     });
 
-    bandwidth.add([1, 'Video call']);     // highest priority
+    bandwidth.add([1, 'Video call']); // highest priority
     bandwidth.add([3, 'File download']);
     bandwidth.add([2, 'Web browsing']);
     bandwidth.add([1, 'Voice call']);
@@ -106,7 +106,7 @@ Defined in: [data-structures/priority-queue/priority-queue.ts:75](https://github
 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:211](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L211)
 
 Get the comparator used to order elements.
 
@@ -134,7 +134,7 @@ Comparator function.
 get elements(): E[];
 ```
 
-Defined in: [data-structures/heap/heap.ts:180](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L180)
+Defined in: [data-structures/heap/heap.ts:175](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L175)
 
 Get the backing array of the heap.
 
@@ -162,7 +162,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:202](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L202)
 
 Get the last leaf element.
 
@@ -190,7 +190,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:193](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L193)
 
 Get the number of elements.
 
@@ -217,8 +217,6 @@ Time O(1), Space O(1)
 
 Heap size.
 
- *
-
 #### Inherited from
 
 [`Heap`](Heap.md).[`size`](Heap.md#size)
@@ -293,7 +291,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:267](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L267)
 
 Insert an element.
 
@@ -311,8 +309,6 @@ Element to insert.
 
 True.
 
- *
-
 #### Remarks
 
 Time O(log N) amortized, Space O(1)
@@ -348,7 +344,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:284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L284)
 
 Insert many elements from an iterable.
 
@@ -366,8 +362,6 @@ Iterable of elements or raw values.
 
 Array of per-element success flags.
 
- *
-
 #### Remarks
 
 Time O(N log N), Space O(1)
@@ -394,7 +388,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:469](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L469)
 
 Remove all elements.
 
@@ -404,8 +398,6 @@ Remove all elements.
 
 void
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -431,7 +423,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:648](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L648)
 
 Deep clone this heap.
 
@@ -441,8 +433,6 @@ Deep clone this heap.
 
 A new heap with the same elements.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(N)
@@ -470,7 +460,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:500](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L500)
 
 Delete one occurrence of an element.
 
@@ -488,8 +478,6 @@ Element to delete.
 
 True if an element was removed.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(1)
@@ -515,7 +503,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:524](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L524)
 
 #### Parameters
 
@@ -543,7 +531,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:534](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L534)
 
 Delete the first element that matches a predicate.
 
@@ -577,7 +565,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:577](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L577)
 
 Traverse the binary heap as a complete binary tree and collect elements.
 
@@ -595,8 +583,6 @@ Traversal order: 'PRE' | 'IN' | 'POST'.
 
 Array of visited elements.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(H)
@@ -616,6 +602,30 @@ Time O(N), Space O(H)
 
 ***
 
+### entries()
+
+```ts
+entries(): IterableIterator<[number, E]>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:207](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L207)
+
+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
+
+[`Heap`](Heap.md).[`entries`](Heap.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -662,7 +672,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:666](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L666)
 
 Filter elements into a new heap of the same class.
 
@@ -686,8 +696,6 @@ Value for `this` inside the callback.
 
 A new heap with the kept elements.
 
- *
-
 #### Remarks
 
 Time O(N log N), Space O(N)
@@ -803,7 +811,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:607](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L607)
 
 Restore heap order bottom-up (heapify in-place).
 
@@ -869,7 +877,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:484](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L484)
 
 Check if an equal element exists in the heap.
 
@@ -887,8 +895,6 @@ Element to search for.
 
 True if found.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(1)
@@ -908,13 +914,47 @@ Time O(N), Space O(1)
 
 ***
 
+### includes()
+
+```ts
+includes(element): boolean;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:199](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L199)
+
+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
+
+[`Heap`](Heap.md).[`includes`](Heap.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:455](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L455)
 
 Check whether the heap is empty.
 
@@ -924,8 +964,6 @@ Check whether the heap is empty.
 
 True if size is 0.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -946,6 +984,30 @@ Time O(1), Space O(1)
 
 ***
 
+### keys()
+
+```ts
+keys(): IterableIterator<number>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:218](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L218)
+
+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
+
+[`Heap`](Heap.md).[`keys`](Heap.md#keys)
+
+***
+
 ### map()
 
 ```ts
@@ -955,7 +1017,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:694](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L694)
 
 Map elements into a new heap of possibly different element type.
 
@@ -995,8 +1057,6 @@ Value for `this` inside the callback.
 
 A new heap with mapped elements.
 
- *
-
 #### Remarks
 
 Time O(N log N), Space O(N)
@@ -1022,7 +1082,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:717](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L717)
 
 Map elements into a new heap of the same element type.
 
@@ -1062,7 +1122,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:440](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L440)
 
 Get the current top element without removing it.
 
@@ -1072,8 +1132,6 @@ Get the current top element without removing it.
 
 Top element or undefined.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -1153,7 +1211,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:356](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L356)
 
 #### Returns
 
@@ -1162,7 +1220,6 @@ 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
 
@@ -1205,7 +1262,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:365](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L365)
 
 Remove and return the top element (min or max depending on comparator).
 
@@ -1231,7 +1288,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:298](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L298)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1289,7 +1346,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:225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L225)
 
 ##### Parameters
 
@@ -1311,7 +1368,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:226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L226)
 
 ##### Parameters
 
@@ -1337,7 +1394,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:227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L227)
 
 ##### Type Parameters
 
@@ -1371,7 +1428,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:561](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L561)
 
 Set the equality comparator used by has/delete operations.
 
@@ -1445,7 +1502,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:625](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L625)
 
 Return all elements in ascending order by repeatedly polling.
 
@@ -1455,8 +1512,6 @@ Return all elements in ascending order by repeatedly polling.
 
 Sorted array of elements.
 
- *
-
 #### Remarks
 
 Time O(N log N), Space O(N)
@@ -1482,7 +1537,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:275](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L275)
 
 Materializes the elements into a new array.
 
@@ -1508,7 +1563,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:287](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L287)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -1564,7 +1619,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:225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L225)
 
 Create a heap of the same class from an iterable.
 
@@ -1622,7 +1677,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:242](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L242)
 
 Build a Heap from an iterable in linear time given a comparator.
 
@@ -1705,7 +1760,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:779](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L779)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -1739,7 +1794,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:793](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L793)
 
 (Protected) Create a like-kind instance seeded by elements.
 
@@ -1789,7 +1844,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:738](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L738)
 
 Internal iterator factory used by the default iterator.
 
@@ -1815,7 +1870,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:812](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/heap/heap.ts#L812)
 
 (Protected) Spawn an empty like-kind heap instance.