data-structure-typed 2.5.3 → 2.6.1

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

@@ -6,7 +6,7 @@
 
 # Class: LinkedListQueue\<E, R\>
 
-Defined in: [data-structures/queue/queue.ts:1110](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1110)
+Defined in: [data-structures/queue/queue.ts:1146](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1146)
 
 Queue implemented over a singly linked list; preserves head/tail operations with linear scans for queries.
 
@@ -314,7 +314,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 addAfter(existingElementOrNode, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1189](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1189)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1225)
 
 Insert a new element/node after an existing one.
 
@@ -354,7 +354,7 @@ Time O(N), Space O(1)
 addAt(index, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:934](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L934)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:961](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L961)
 
 Insert a new element/node at an index, shifting following nodes.
 
@@ -405,7 +405,7 @@ Time O(N), Space O(1)
 addBefore(existingElementOrNode, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1159](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1159)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1195)
 
 Insert a new element/node before an existing one.
 
@@ -445,7 +445,7 @@ Time O(N), Space O(1)
 at(index): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:686](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L686)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:701](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L701)
 
 Get the element at a given index.
 
@@ -491,7 +491,7 @@ Time O(N), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1059](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1059)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1092](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1092)
 
 Remove all nodes and reset length.
 
@@ -528,7 +528,7 @@ Time O(N), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1117](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1117)
+Defined in: [data-structures/queue/queue.ts:1153](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1153)
 
 Deep clone this linked-list-based queue.
 
@@ -554,7 +554,7 @@ Time O(N), Space O(N)
 concat(...items): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:473](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L473)
+Defined in: [data-structures/base/linear-base.ts:484](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L484)
 
 Concatenate lists/elements preserving order.
 
@@ -590,7 +590,7 @@ Time O(sum(length)), Space O(sum(length))
 countOccurrences(elementOrNode): number;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1265](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1265)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1301](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1301)
 
 Count how many nodes match a value/node/predicate.
 
@@ -626,7 +626,7 @@ Time O(N), Space O(1)
 delete(elementOrNode?): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:868](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L868)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:892](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L892)
 
 Delete the first match by value/node.
 
@@ -671,7 +671,7 @@ Time O(N), Space O(1)
 deleteAt(index): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:808](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L808)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:829](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L829)
 
 Delete the element at an index.
 
@@ -716,7 +716,7 @@ Time O(N), Space O(1)
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1295](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1295)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1331](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1331)
 
 Delete the first node whose value matches a predicate.
 
@@ -744,6 +744,30 @@ Time O(N), Space O(1)
 
 ***
 
+### entries()
+
+```ts
+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)
+
+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
+
+[`SinglyLinkedList`](SinglyLinkedList.md).[`entries`](SinglyLinkedList.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -839,7 +863,7 @@ Time O(n), Space O(1)
 filter(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1435](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1435)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1477](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1477)
 
 Filter values into a new list of the same class.
 
@@ -1070,7 +1094,7 @@ Time O(n), Space O(1).
 getNode(elementNodeOrPredicate?): SinglyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1137](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1137)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1173](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1173)
 
 Find a node by value, reference, or predicate.
 
@@ -1106,7 +1130,7 @@ Time O(N), Space O(1)
 getNodeAt(index): SinglyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:753](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L753)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:771](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L771)
 
 Get the node reference at a given index.
 
@@ -1178,13 +1202,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:200](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L200)
+
+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
+
+[`SinglyLinkedList`](SinglyLinkedList.md).[`includes`](SinglyLinkedList.md#includes)
+
+***
+
 ### indexOf()
 
 ```ts
 indexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:422](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L422)
+Defined in: [data-structures/base/linear-base.ts:433](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L433)
 
 Linked-list optimized `indexOf` (forwards scan).
 
@@ -1224,7 +1282,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1007](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1007)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1037](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1037)
 
 Check whether the list is empty.
 
@@ -1259,7 +1317,7 @@ Time O(1), Space O(1)
 isNode(elementNodeOrPredicate): elementNodeOrPredicate is SinglyLinkedListNode<E>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:700](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L700)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:715](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L715)
 
 Type guard: check whether the input is a SinglyLinkedListNode.
 
@@ -1323,13 +1381,37 @@ Time O(n), Space O(n)
 
 ***
 
+### keys()
+
+```ts
+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)
+
+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
+
+[`SinglyLinkedList`](SinglyLinkedList.md).[`keys`](SinglyLinkedList.md#keys)
+
+***
+
 ### lastIndexOf()
 
 ```ts
 lastIndexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:448](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L448)
+Defined in: [data-structures/base/linear-base.ts:459](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L459)
 
 Linked-list optimized `lastIndexOf` (reverse scan).
 
@@ -1372,7 +1454,7 @@ map<EM, RM>(
 thisArg?): SinglyLinkedList<EM, RM>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1515](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1515)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1560](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1560)
 
 Map values into a new list (possibly different element type).
 
@@ -1439,7 +1521,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1450](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1450)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1492](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1492)
 
 Map values into a new list of the same class.
 
@@ -1479,7 +1561,7 @@ Time O(N), Space O(N)
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:428](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L428)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:434](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L434)
 
 Remove and return the tail element.
 
@@ -1526,7 +1608,7 @@ Time O(N), 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:301](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L301)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1552,7 +1634,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:355](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L355)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:358](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L358)
 
 Append an element/node to the tail.
 
@@ -1607,7 +1689,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:590](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L590)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:602](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L602)
 
 Append a sequence of elements/nodes.
 
@@ -1675,7 +1757,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:226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L226)
 
 ##### Parameters
 
@@ -1697,7 +1779,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:227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L227)
 
 ##### Parameters
 
@@ -1723,7 +1805,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:228](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L228)
 
 ##### Type Parameters
 
@@ -1757,7 +1839,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
 reduceRight<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:574](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L574)
+Defined in: [data-structures/base/linear-base.ts:585](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L585)
 
 Right-to-left reduction using reverse iterator.
 
@@ -1803,7 +1885,7 @@ Time O(n), Space O(1)
 reverse(): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1115](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1115)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1151](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1151)
 
 Reverse the list in place.
 
@@ -1840,7 +1922,7 @@ Time O(N), Space O(1)
 search(elementNodeOrPredicate): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:622](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L622)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:634](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L634)
 
 Find the first value matching a predicate (by node).
 
@@ -1876,7 +1958,7 @@ Time O(N), Space O(1)
 setAt(index, value): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:954](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L954)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:981](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L981)
 
 Set the element value at an index.
 
@@ -1916,7 +1998,7 @@ Time O(N), Space O(1)
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1283](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1283)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1319](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1319)
 
 Set the equality comparator used to compare values.
 
@@ -1950,7 +2032,7 @@ Time O(1), Space O(1)
 shift(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:496](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L496)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:505](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L505)
 
 Remove and return the head element.
 
@@ -1987,7 +2069,7 @@ Time O(1), Space O(1)
 slice(start?, end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:494](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L494)
+Defined in: [data-structures/base/linear-base.ts:505](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L505)
 
 Slice via forward iteration (no random access required).
 
@@ -2104,7 +2186,7 @@ splice(
    items?): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1209](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1209)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1245)
 
 Remove and/or insert elements at a position (array-like behavior).
 
@@ -2150,7 +2232,7 @@ Time O(N + M), Space O(M)
 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:278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L278)
 
 Materializes the elements into a new array.
 
@@ -2170,6 +2252,32 @@ Time O(n), Space O(n).
 
 ***
 
+### toReversed()
+
+```ts
+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)
+
+Return a new instance of the same type with elements in reverse order (non-mutating).
+
+#### Returns
+
+`this`
+
+A new reversed instance.
+
+#### Remarks
+
+Provided for familiarity when migrating from Array (ES2023 `toReversed`). Time O(n), Space O(n).
+
+#### Inherited from
+
+[`SinglyLinkedList`](SinglyLinkedList.md).[`toReversed`](SinglyLinkedList.md#toreversed)
+
+***
+
 ### toReversedArray()
 
 ```ts
@@ -2202,7 +2310,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:290](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L290)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -2229,7 +2337,7 @@ Time O(n), Space O(n).
 unshift(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:571](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L571)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:583](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L583)
 
 Prepend an element/node to the head.
 
@@ -2289,7 +2397,7 @@ Time O(1), Space O(1)
 unshiftMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:606](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L606)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:618](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L618)
 
 Prepend a sequence of elements/nodes.
 
@@ -2447,7 +2555,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1638](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1638)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1683](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1683)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -2481,7 +2589,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): SinglyLinkedList<EM, RM>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1656](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1656)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1701](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1701)
 
 (Protected) Create a like-kind instance and seed it from an iterable.
 
@@ -2533,7 +2641,7 @@ Time O(N), Space O(N)
 protected _ensureNode(elementOrNode): SinglyLinkedListNode<E>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1557](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1557)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1602](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1602)
 
 (Protected) Normalize input into a node instance.
 
@@ -2567,7 +2675,7 @@ Time O(1), Space O(1)
 protected _ensurePredicate(elementNodeOrPredicate): (node) => boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1569](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1569)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1614](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1614)
 
 (Protected) Normalize input into a node predicate.
 
@@ -2603,7 +2711,7 @@ Time O(1), Space O(1)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1598](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1598)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1643](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1643)
 
 (Protected) Iterate values from head to tail.
 
@@ -2629,7 +2737,7 @@ Time O(N), Space O(1)
 protected _getNodeIterator(): IterableIterator<SinglyLinkedListNode<E>>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1623](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1623)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1668](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1668)
 
 (Protected) Iterate nodes from head to tail.
 
@@ -2655,7 +2763,7 @@ Time O(N), Space O(1)
 protected _getPrevNode(node): SinglyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1585](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1585)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1630](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1630)
 
 (Protected) Get the previous node of a given node.
 
@@ -2689,7 +2797,7 @@ Time O(N), Space O(1)
 protected _getReverseIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1612](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1612)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1657](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1657)
 
 (Protected) Iterate values from tail to head.
 
@@ -2715,7 +2823,7 @@ Time O(N), Space O(N)
 protected _isPredicate(elementNodeOrPredicate): elementNodeOrPredicate is (node: SinglyLinkedListNode<E>) => boolean;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1544](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1544)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1589](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1589)
 
 (Protected) Check if input is a node predicate function.
 
@@ -2751,7 +2859,7 @@ Time O(1), Space O(1)
 protected _spawnLike<EM, RM>(options?): SinglyLinkedList<EM, RM>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1676](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1676)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1721](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1721)
 
 (Protected) Spawn an empty like-kind list instance.
 
@@ -2795,7 +2903,7 @@ Time O(1), Space O(1)
 protected createNode(value): SinglyLinkedListNode<E>;
 ```
 
-Defined in: [data-structures/linked-list/singly-linked-list.ts:1533](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1533)
+Defined in: [data-structures/linked-list/singly-linked-list.ts:1578](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/singly-linked-list.ts#L1578)
 
 (Protected) Create a node from a value.