data-structure-typed 2.6.0 → 2.6.2

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

@@ -6,7 +6,7 @@
 
 # Class: Stack\<E, R\>
 
-Defined in: [data-structures/stack/stack.ts:135](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L135)
+Defined in: [data-structures/stack/stack.ts:134](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L134)
 
 LIFO stack with array storage and optional record→element conversion.
 
@@ -170,7 +170,7 @@ Time O(1), Space O(1)
 new Stack<E, R>(elements?, options?): Stack<E, R>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:146](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L146)
+Defined in: [data-structures/stack/stack.ts:142](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L142)
 
 Create a Stack and optionally bulk-push elements.
 
@@ -212,7 +212,7 @@ Time O(N), Space O(N)
 get elements(): E[];
 ```
 
-Defined in: [data-structures/stack/stack.ts:159](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L159)
+Defined in: [data-structures/stack/stack.ts:154](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L154)
 
 Get the backing array of elements.
 
@@ -236,7 +236,7 @@ Internal elements array.
 get size(): number;
 ```
 
-Defined in: [data-structures/stack/stack.ts:210](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L210)
+Defined in: [data-structures/stack/stack.ts:167](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L167)
 
 Get the number of stored elements.
 
@@ -258,8 +258,6 @@ Time O(1), Space O(1)
 
 Current size.
 
- *
-
 ***
 
 ### toElementFn
@@ -330,7 +328,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 clear(): void;
 ```
 
-Defined in: [data-structures/stack/stack.ts:621](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L621)
+Defined in: [data-structures/stack/stack.ts:339](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L339)
 
 Remove all elements and reset storage.
 
@@ -340,8 +338,6 @@ Remove all elements and reset storage.
 
 void
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -367,7 +363,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:675](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L675)
+Defined in: [data-structures/stack/stack.ts:355](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L355)
 
 Deep clone this stack.
 
@@ -377,8 +373,6 @@ Deep clone this stack.
 
 A new stack with the same content.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(N)
@@ -406,7 +400,7 @@ Time O(N), Space O(N)
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:538](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L538)
+Defined in: [data-structures/stack/stack.ts:296](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L296)
 
 Delete the first occurrence of a specific element.
 
@@ -424,8 +418,6 @@ Element to remove (using the configured equality).
 
 True if an element was removed.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(1)
@@ -447,7 +439,7 @@ Time O(N), Space O(1)
 deleteAt(index): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:550](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L550)
+Defined in: [data-structures/stack/stack.ts:307](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L307)
 
 Delete the element at an index.
 
@@ -477,7 +469,7 @@ Time O(N), Space O(1)
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:563](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L563)
+Defined in: [data-structures/stack/stack.ts:319](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L319)
 
 Delete the first element that satisfies a predicate.
 
@@ -501,6 +493,30 @@ Time O(N), Space O(1)
 
 ***
 
+### 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
+
+[`IterableElementBase`](IterableElementBase.md).[`entries`](IterableElementBase.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -547,7 +563,7 @@ Time O(n) in the worst case; may exit early when the first failure is found. Spa
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:731](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L731)
+Defined in: [data-structures/stack/stack.ts:373](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L373)
 
 Filter elements into a new stack of the same class.
 
@@ -571,8 +587,6 @@ Value for `this` inside the predicate.
 
 A new stack with kept values.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(N)
@@ -728,7 +742,7 @@ Time O(n), Space O(1).
 has(element): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:189](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L189)
+Defined in: [data-structures/base/iterable-element-base.ts:188](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L188)
 
 Checks whether a strictly-equal element exists in the structure.
 
@@ -756,13 +770,47 @@ Time O(n) in the worst case. 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
+
+[`IterableElementBase`](IterableElementBase.md).[`includes`](IterableElementBase.md#includes)
+
+***
+
 ### isEmpty()
 
 ```ts
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L284)
+Defined in: [data-structures/stack/stack.ts:200](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L200)
 
 Check whether the stack is empty.
 
@@ -772,8 +820,6 @@ Check whether the stack is empty.
 
 True if size is 0.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -794,6 +840,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
+
+[`IterableElementBase`](IterableElementBase.md).[`keys`](IterableElementBase.md#keys)
+
+***
+
 ### map()
 
 ```ts
@@ -803,7 +873,7 @@ map<EM, RM>(
 thisArg?): Stack<EM, RM>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:811](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L811)
+Defined in: [data-structures/stack/stack.ts:415](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L415)
 
 Map values into a new stack (possibly different element type).
 
@@ -843,8 +913,6 @@ Value for `this` inside the callback.
 
 A new Stack with mapped elements.
 
- *
-
 #### Remarks
 
 Time O(N), Space O(N)
@@ -870,7 +938,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:749](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L749)
+Defined in: [data-structures/stack/stack.ts:390](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L390)
 
 Map values into a new stack of the same element type.
 
@@ -910,7 +978,7 @@ Time O(N), Space O(N)
 peek(): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:338](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L338)
+Defined in: [data-structures/stack/stack.ts:214](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L214)
 
 Get the top element without removing it.
 
@@ -920,8 +988,6 @@ Get the top element without removing it.
 
 Top element or undefined.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -943,7 +1009,7 @@ Time O(1), Space O(1)
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:470](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L470)
+Defined in: [data-structures/stack/stack.ts:266](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L266)
 
 Pop and return the top element.
 
@@ -953,8 +1019,6 @@ Pop and return the top element.
 
 Removed element or undefined.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -989,7 +1053,7 @@ Time O(1), 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.
 
@@ -1015,7 +1079,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(element): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:402](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L402)
+Defined in: [data-structures/stack/stack.ts:238](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L238)
 
 Push one element onto the top.
 
@@ -1033,8 +1097,6 @@ Element to push.
 
 True when pushed.
 
- *
-
 #### Remarks
 
 Time O(1), Space O(1)
@@ -1065,7 +1127,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/stack/stack.ts:481](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L481)
+Defined in: [data-structures/stack/stack.ts:276](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L276)
 
 Push many elements from an iterable.
 
@@ -1127,7 +1189,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
 
@@ -1149,7 +1211,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
 
@@ -1175,7 +1237,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
 
@@ -1209,7 +1271,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:832](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L832)
+Defined in: [data-structures/stack/stack.ts:435](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L435)
 
 Set the equality comparator used by delete/search operations.
 
@@ -1279,7 +1341,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
 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.
 
@@ -1305,7 +1367,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.
@@ -1361,7 +1423,7 @@ static fromArray<E, R>(
    options?): any;
 ```
 
-Defined in: [data-structures/stack/stack.ts:225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L225)
+Defined in: [data-structures/stack/stack.ts:181](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L181)
 
 Create a stack from an array of elements.
 
@@ -1446,7 +1508,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:856](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L856)
+Defined in: [data-structures/stack/stack.ts:459](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L459)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -1476,7 +1538,7 @@ Time O(1), Space O(1)
 protected _createLike<T, RR>(elements?, options?): Stack<T, RR>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:871](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L871)
+Defined in: [data-structures/stack/stack.ts:473](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L473)
 
 (Protected) Create a like-kind stack and seed it from an iterable.
 
@@ -1522,7 +1584,7 @@ Time O(N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:888](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L888)
+Defined in: [data-structures/stack/stack.ts:489](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L489)
 
 (Protected) Iterate elements from bottom to top.
 
@@ -1548,7 +1610,7 @@ Time O(N), Space O(1)
 protected _indexOfByEquals(target): number;
 ```
 
-Defined in: [data-structures/stack/stack.ts:844](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L844)
+Defined in: [data-structures/stack/stack.ts:448](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L448)
 
 (Protected) Find the index of a target element using the equality function.