data-structure-typed 2.6.1 → 2.6.2

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

@@ -194,7 +194,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 abstract addAt(index, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:388](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L388)
+Defined in: [data-structures/base/linear-base.ts:372](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L372)
 
 Insert an element/node at a position.
 
@@ -230,7 +230,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract at(index): E | undefined;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:371](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L371)
+Defined in: [data-structures/base/linear-base.ts:355](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L355)
 
 Get element at an index.
 
@@ -260,7 +260,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract clear(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:321](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L321)
+Defined in: [data-structures/base/iterable-element-base.ts:318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L318)
 
 Removes all elements from the structure.
 
@@ -286,7 +286,7 @@ Expected Time O(1) or O(n) depending on the implementation; Space O(1).
 abstract clone(): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:321](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L321)
+Defined in: [data-structures/base/linear-base.ts:305](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L305)
 
 Deep clone while preserving concrete subtype.
 
@@ -312,7 +312,7 @@ Time O(n), Space O(n)
 concat(...items): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:165](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L165)
+Defined in: [data-structures/base/linear-base.ts:161](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L161)
 
 Concatenate elements and/or containers.
 
@@ -342,7 +342,7 @@ Time O(sum(length)), Space O(sum(length))
 abstract delete(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:363](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L363)
+Defined in: [data-structures/base/linear-base.ts:347](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L347)
 
 Remove one element or node if present.
 
@@ -372,7 +372,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract deleteAt(pos): E | undefined;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:379](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L379)
+Defined in: [data-structures/base/linear-base.ts:363](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L363)
 
 Remove element at a position.
 
@@ -402,7 +402,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 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)
+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).
 
@@ -469,7 +469,7 @@ fill(
    end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:292](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L292)
+Defined in: [data-structures/base/linear-base.ts:279](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L279)
 
 Fill a range with a value.
 
@@ -511,7 +511,7 @@ Time O(n), Space O(1)
 abstract filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:373](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L373)
+Defined in: [data-structures/base/iterable-element-base.ts:370](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L370)
 
 Filters elements using the provided predicate and returns the same concrete structure type.
 
@@ -641,7 +641,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 findIndex(predicate, thisArg?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:151](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L151)
+Defined in: [data-structures/base/linear-base.ts:147](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L147)
 
 Find the first index matching a predicate.
 
@@ -717,7 +717,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.
 
@@ -751,7 +751,7 @@ Time O(n) in the worst case. Space O(1).
 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)
+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`).
 
@@ -821,7 +821,7 @@ Time O(n), Space O(1)
 abstract isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L312)
+Defined in: [data-structures/base/iterable-element-base.ts:309](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L309)
 
 Indicates whether the structure currently contains no elements.
 
@@ -847,7 +847,7 @@ Expected Time O(1), Space O(1) for most implementations.
 join(separator?): string;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L228)
+Defined in: [data-structures/base/linear-base.ts:218](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L218)
 
 Join all elements into a string.
 
@@ -877,7 +877,7 @@ Time O(n), Space O(n)
 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)
+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).
 
@@ -901,7 +901,7 @@ Provided for familiarity when migrating from Array. Time O(n), Space O(1) per st
 lastIndexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:131](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L131)
+Defined in: [data-structures/base/linear-base.ts:129](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L129)
 
 Last index of a value from the right.
 
@@ -940,7 +940,7 @@ abstract map<EM, RM>(
 thisArg?): IterableElementBase<EM, RM>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:345](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L345)
+Defined in: [data-structures/base/iterable-element-base.ts:342](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L342)
 
 Maps each element to a new element and returns a new iterable structure.
 
@@ -1000,7 +1000,7 @@ Time O(n), Space O(n).
 abstract mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:361](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L361)
+Defined in: [data-structures/base/iterable-element-base.ts:358](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L358)
 
 Maps each element to the same element type and returns the same concrete structure type.
 
@@ -1040,7 +1040,7 @@ Time O(n), Space O(n).
 print(): void;
 ```
 
-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)
+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.
 
@@ -1066,7 +1066,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 abstract push(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:347](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L347)
+Defined in: [data-structures/base/linear-base.ts:331](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L331)
 
 Append one element or node to the tail.
 
@@ -1096,7 +1096,7 @@ Time O(1) amortized typical, Space O(1)
 abstract pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/base/linear-base.ts:355](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L355)
+Defined in: [data-structures/base/linear-base.ts:339](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L339)
 
 Append many elements/nodes at once.
 
@@ -1160,7 +1160,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:226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L226)
+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
 
@@ -1182,7 +1182,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:226](https://github.c
 reduce(callbackfn, initialValue): E;
 ```
 
-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)
+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
 
@@ -1208,7 +1208,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:227](https://github.c
 reduce<U>(callbackfn, initialValue): U;
 ```
 
-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)
+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
 
@@ -1242,7 +1242,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:228](https://github.c
 reduceRight<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:256](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L256)
+Defined in: [data-structures/base/linear-base.ts:245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L245)
 
 Right-to-left reduction over elements.
 
@@ -1284,7 +1284,7 @@ Time O(n), Space O(1)
 abstract reverse(): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:328](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L328)
+Defined in: [data-structures/base/linear-base.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L312)
 
 Reverse the order of elements in-place (or equivalent).
 
@@ -1306,7 +1306,7 @@ Time O(n), Space O(1)
 abstract setAt(index, value): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:314](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L314)
+Defined in: [data-structures/base/linear-base.ts:298](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L298)
 
 Set the value at an index.
 
@@ -1342,7 +1342,7 @@ Time O(1) typical, Space O(1)
 slice(start?, end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:273](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L273)
+Defined in: [data-structures/base/linear-base.ts:261](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L261)
 
 Create a shallow copy of a subrange.
 
@@ -1418,7 +1418,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
 sort(compareFn?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:185](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L185)
+Defined in: [data-structures/base/linear-base.ts:179](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L179)
 
 In-place stable order via array sort semantics.
 
@@ -1451,7 +1451,7 @@ splice(
    items): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:201](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L201)
+Defined in: [data-structures/base/linear-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L195)
 
 Remove and/or insert elements at a position (array-compatible).
 
@@ -1493,7 +1493,7 @@ Time O(n + m), Space O(min(n, m)) where `m = items.length`
 toArray(): E[];
 ```
 
-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)
+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.
 
@@ -1519,7 +1519,7 @@ Time O(n), Space O(n).
 toReversed(): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:335](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L335)
+Defined in: [data-structures/base/linear-base.ts:319](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L319)
 
 Return a new instance of the same type with elements in reverse order (non-mutating).
 
@@ -1541,7 +1541,7 @@ Provided for familiarity when migrating from Array (ES2023 `toReversed`). Time O
 toReversedArray(): E[];
 ```
 
-Defined in: [data-structures/base/linear-base.ts:237](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L237)
+Defined in: [data-structures/base/linear-base.ts:227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L227)
 
 Snapshot elements into a reversed array.
 
@@ -1563,7 +1563,7 @@ Time O(n), Space O(n)
 toVisual(): E[];
 ```
 
-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)
+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.
@@ -1649,7 +1649,7 @@ Time O(1), Space O(1).
 abstract protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:396](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L396)
+Defined in: [data-structures/base/linear-base.ts:380](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L380)
 
 Create an empty list of the same species.
 
@@ -1679,7 +1679,7 @@ Time O(1), Space O(1)
 abstract protected _getIterator(...args): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:384](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L384)
+Defined in: [data-structures/base/iterable-element-base.ts:381](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L381)
 
 Internal iterator factory used by the default iterator.
 
@@ -1713,7 +1713,7 @@ Implementations should yield in O(1) per element with O(1) extra space when poss
 abstract protected _getReverseIterator(...args): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:403](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L403)
+Defined in: [data-structures/base/linear-base.ts:387](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L387)
 
 Reverse-direction iterator over elements.