data-structure-typed 2.5.2 → 2.5.3

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

@@ -6,7 +6,7 @@
 
 # Class: DoublyLinkedList\<E, R\>
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:150](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L150)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:150](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L150)
 
 Doubly linked list with O(1) push/pop/unshift/shift and linear scans.
 
@@ -112,7 +112,7 @@ Caution: Although our linked list classes provide methods such as at, setAt, add
 new DoublyLinkedList<E, R>(elements?, options?): DoublyLinkedList<E, R>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:161](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L161)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:161](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L161)
 
 Create a DoublyLinkedList and optionally bulk-insert elements.
 
@@ -158,7 +158,7 @@ LinearLinkedBase<E, R, DoublyLinkedListNode<E>>.constructor
 get first(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:219](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L219)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:219](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L219)
 
 Get the first element value.
 
@@ -182,7 +182,7 @@ First element or undefined.
 get head(): DoublyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:185](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L185)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:185](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L185)
 
 Get the head node.
 
@@ -206,7 +206,7 @@ Head node or undefined.
 get last(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:229](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L229)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:229](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L229)
 
 Get the last element value.
 
@@ -230,7 +230,7 @@ Last element or undefined.
 get length(): number;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:209](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L209)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:209](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L209)
 
 Get the number of elements.
 
@@ -258,7 +258,7 @@ Current length.
 get maxLen(): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:100](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L100)
+Defined in: [data-structures/base/linear-base.ts:100](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L100)
 
 Upper bound for length (if positive), or `-1` when unbounded.
 
@@ -286,7 +286,7 @@ Maximum allowed length.
 get tail(): DoublyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:197](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L197)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:197](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L197)
 
 Get the tail node.
 
@@ -310,7 +310,7 @@ Tail node or undefined.
 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.
 
@@ -336,7 +336,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.
 
@@ -370,7 +370,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/doubly-linked-list.ts:801](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L801)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:829](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L829)
 
 Insert a new element/node after an existing one.
 
@@ -410,7 +410,7 @@ Time O(N), Space O(1)
 addAt(index, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:750](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L750)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:778](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L778)
 
 Insert a new element/node at an index, shifting following nodes.
 
@@ -461,7 +461,7 @@ Time O(N), Space O(1)
 addBefore(existingElementOrNode, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:774](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L774)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:802](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L802)
 
 Insert a new element/node before an existing one.
 
@@ -501,7 +501,7 @@ Time O(N), Space O(1)
 at(index): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:609](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L609)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:629](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L629)
 
 Get the element at a given index.
 
@@ -546,7 +546,7 @@ Time O(N), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1040](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1040)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1084](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1084)
 
 Remove all nodes and reset length.
 
@@ -583,7 +583,7 @@ Time O(N), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1273](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1273)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1353](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1353)
 
 Deep clone this list (values are copied by reference).
 
@@ -621,7 +621,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L473)
+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)
 
 Concatenate lists/elements preserving order.
 
@@ -657,7 +657,7 @@ Time O(sum(length)), Space O(sum(length))
 delete(elementOrNode?): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:934](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L934)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:970](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L970)
 
 Delete the first match by value/node.
 
@@ -702,7 +702,7 @@ Time O(N), Space O(1)
 deleteAt(index): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:876](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L876)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:908](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L908)
 
 Delete the element at an index.
 
@@ -741,13 +741,43 @@ Time O(N), Space O(1)
 
 ***
 
+### deleteWhere()
+
+```ts
+deleteWhere(predicate): boolean;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1278)
+
+Delete the first element that satisfies a predicate.
+
+#### Parameters
+
+##### predicate
+
+(`value`, `index`, `list`) => `boolean`
+
+Function (value, index, list) → boolean to decide deletion.
+
+#### Returns
+
+`boolean`
+
+True if a match was removed.
+
+#### Remarks
+
+Time O(N), Space O(1)
+
+***
+
 ### every()
 
 ```ts
 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.
 
@@ -790,7 +820,7 @@ fill(
    end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:292](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L292)
+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)
 
 Fill a range with a value.
 
@@ -836,7 +866,7 @@ Time O(n), Space O(1)
 filter(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1327](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1327)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1411](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1411)
 
 Filter values into a new list of the same class.
 
@@ -889,7 +919,7 @@ Time O(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.
 
@@ -935,7 +965,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.
 
@@ -977,7 +1007,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L151)
+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)
 
 Find the first index matching a predicate.
 
@@ -1017,7 +1047,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.
 
@@ -1057,7 +1087,7 @@ Time O(n), Space O(1).
 getBackward(elementNodeOrPredicate): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1147](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1147)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1199](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1199)
 
 Find the first value matching a predicate scanning backward.
 
@@ -1101,7 +1131,7 @@ Time O(N), Space O(1)
 getNode(elementNodeOrPredicate?): DoublyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:673](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L673)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:697](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L697)
 
 Find a node by value, reference, or predicate.
 
@@ -1133,7 +1163,7 @@ Time O(N), Space O(1)
 getNodeAt(index): DoublyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:659](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L659)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:683](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L683)
 
 Get the node reference at a given index.
 
@@ -1177,7 +1207,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L189)
+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)
 
 Checks whether a strictly-equal element exists in the structure.
 
@@ -1211,7 +1241,7 @@ Time O(n) in the worst case. Space O(1).
 indexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:422](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L422)
+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)
 
 Linked-list optimized `indexOf` (forwards scan).
 
@@ -1251,7 +1281,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:992](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L992)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1032](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1032)
 
 Check whether the list is empty.
 
@@ -1286,7 +1316,7 @@ Time O(1), Space O(1)
 isNode(elementNodeOrPredicate): elementNodeOrPredicate is DoublyLinkedListNode<E>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:260](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L260)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:260](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L260)
 
 Type guard: check whether the input is a DoublyLinkedListNode.
 
@@ -1318,7 +1348,7 @@ Time O(1), Space O(1)
 join(separator?): string;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L228)
+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)
 
 Join all elements into a string.
 
@@ -1352,7 +1382,7 @@ Time O(n), Space O(n)
 lastIndexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:448](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L448)
+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)
 
 Linked-list optimized `lastIndexOf` (reverse scan).
 
@@ -1395,7 +1425,7 @@ map<EM, RM>(
 thisArg?): DoublyLinkedList<EM, RM>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1412](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1412)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1500](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1500)
 
 Map values into a new list (possibly different element type).
 
@@ -1471,7 +1501,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1342](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1342)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1426](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1426)
 
 Map values into a new list of the same class.
 
@@ -1511,7 +1541,7 @@ Time O(N), Space O(N)
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:394](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L394)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:402](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L402)
 
 Remove and return the tail element.
 
@@ -1554,7 +1584,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/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.
 
@@ -1580,7 +1610,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:323](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L323)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:327](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L327)
 
 Append an element/node to the tail.
 
@@ -1635,7 +1665,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:537](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L537)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:553](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L553)
 
 Append a sequence of elements/nodes.
 
@@ -1703,7 +1733,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
 
@@ -1725,7 +1755,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
 
@@ -1751,7 +1781,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
 
@@ -1785,7 +1815,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L574)
+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)
 
 Right-to-left reduction using reverse iterator.
 
@@ -1831,7 +1861,7 @@ Time O(n), Space O(1)
 reverse(): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1205](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1205)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1261](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1261)
 
 Reverse the list in place.
 
@@ -1868,7 +1898,7 @@ Time O(N), Space O(1)
 search(elementNodeOrPredicate): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1090](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1090)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1138](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1138)
 
 Find the first value matching a predicate scanning forward.
 
@@ -1911,7 +1941,7 @@ Time O(N), Space O(1)
 setAt(index, value): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:825](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L825)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:853](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L853)
 
 Set the element value at an index.
 
@@ -1951,7 +1981,7 @@ Time O(N), Space O(1)
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1223](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1223)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1299](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1299)
 
 Set the equality comparator used to compare values.
 
@@ -1981,7 +2011,7 @@ Time O(1), Space O(1)
 shift(): E | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:454](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L454)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:466](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L466)
 
 Remove and return the head element.
 
@@ -2014,7 +2044,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L494)
+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)
 
 Slice via forward iteration (no random access required).
 
@@ -2054,7 +2084,7 @@ Time O(n), Space O(n)
 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.
 
@@ -2094,7 +2124,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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L185)
+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)
 
 In-place stable order via array sort semantics.
 
@@ -2131,7 +2161,7 @@ splice(
    items): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:522](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L522)
+Defined in: [data-structures/base/linear-base.ts:522](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L522)
 
 Splice by walking node iterators from the start index.
 
@@ -2177,7 +2207,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: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.
 
@@ -2203,7 +2233,7 @@ Time O(n), Space O(n).
 toReversedArray(): E[];
 ```
 
-Defined in: [data-structures/base/linear-base.ts:237](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L237)
+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)
 
 Snapshot elements into a reversed array.
 
@@ -2229,7 +2259,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.
@@ -2256,7 +2286,7 @@ Time O(n), Space O(n).
 unshift(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:515](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L515)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:531](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L531)
 
 Prepend an element/node to the head.
 
@@ -2297,7 +2327,7 @@ Time O(1), Space O(1)
 unshiftMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:553](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L553)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:569](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L569)
 
 Prepend a sequence of elements/nodes.
 
@@ -2329,7 +2359,7 @@ Time O(N), Space O(1)
 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).
 
@@ -2355,7 +2385,7 @@ Creating the iterator is O(1); full iteration is Time O(n), Space O(1).
 static fromArray<E, R>(this, data): any;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:243](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L243)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:243](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L243)
 
 Create a new list from an array of elements.
 
@@ -2404,7 +2434,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`).
 
@@ -2434,7 +2464,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1474](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1474)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1562](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1562)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -2468,7 +2498,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): DoublyLinkedList<EM, RM>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1492](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1492)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1580](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1580)
 
 (Protected) Create a like-kind instance and seed it from an iterable.
 
@@ -2516,7 +2546,7 @@ Time O(N), Space O(N)
 protected _ensureNode(elementOrNode): DoublyLinkedListNode<E>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1430](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1430)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1518](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1518)
 
 (Protected) Create or return a node for the given input (node or raw element).
 
@@ -2546,7 +2576,7 @@ Time O(1), Space O(1)
 protected _ensurePredicate(elementNodeOrPredicate): (node) => boolean;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1442](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1442)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1530](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1530)
 
 (Protected) Normalize input into a predicate over nodes.
 
@@ -2578,7 +2608,7 @@ Time O(1), Space O(1)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1503](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1503)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1591](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1591)
 
 Internal iterator factory used by the default iterator.
 
@@ -2604,7 +2634,7 @@ Implementations should yield in O(1) per element with O(1) extra space when poss
 protected _getNodeIterator(): IterableIterator<DoublyLinkedListNode<E>>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1519](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1519)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1607](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1607)
 
 Iterate linked nodes from head to tail.
 
@@ -2630,7 +2660,7 @@ Time O(n), Space O(1)
 protected _getPrevNode(node): DoublyLinkedListNode<E> | undefined;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1463](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1463)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1551](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1551)
 
 (Protected) Get the previous node of a given node.
 
@@ -2664,7 +2694,7 @@ Time O(1), Space O(1)
 protected _getReverseIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/linked-list/doubly-linked-list.ts:1511](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/linked-list/doubly-linked-list.ts#L1511)
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:1599](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/linked-list/doubly-linked-list.ts#L1599)
 
 Reverse-direction iterator over elements.