data-structure-typed 2.5.3 → 2.6.1

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

@@ -113,7 +113,7 @@ Number of entries in the map.
 ceiling(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4192](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4192)
+Defined in: [data-structures/binary-tree/tree-map.ts:4498](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4498)
 
 Smallest entry whose key is >= the given key.
 
@@ -172,7 +172,7 @@ Smallest entry whose key is >= the given key.
 clear(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1411](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1411)
+Defined in: [data-structures/binary-tree/tree-map.ts:1513](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1513)
 
 Remove all entries.
 
@@ -199,7 +199,7 @@ Remove all entries.
 clone(): TreeMap<K, V>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:5189](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5189)
+Defined in: [data-structures/binary-tree/tree-map.ts:5564](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5564)
 
 Creates a shallow clone of this map.
 
@@ -231,7 +231,7 @@ Time O(n log n), Space O(n)
 delete(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1202](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1202)
+Defined in: [data-structures/binary-tree/tree-map.ts:1289](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1289)
 
 Delete a key.
 
@@ -277,7 +277,7 @@ Expected time O(log n)
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1213](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1213)
+Defined in: [data-structures/binary-tree/tree-map.ts:1300](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1300)
 
 Delete all entries matching a predicate.
 
@@ -307,7 +307,7 @@ Time O(N), Space O(N)
 entries(): IterableIterator<[K, V | undefined]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1988](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1988)
+Defined in: [data-structures/binary-tree/tree-map.ts:2135](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2135)
 
 Iterate over `[key, value]` entries in ascending key order.
 
@@ -335,7 +335,7 @@ Note: values may be `undefined`.
 every(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2970](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2970)
+Defined in: [data-structures/binary-tree/tree-map.ts:3192](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3192)
 
 Test whether all entries satisfy a predicate.
 
@@ -375,7 +375,7 @@ Time O(n), Space O(1)
 filter(callbackfn, thisArg?): TreeMap<K, V>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2581](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2581)
+Defined in: [data-structures/binary-tree/tree-map.ts:2773](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2773)
 
 Create a new TreeMap containing only entries that satisfy the predicate.
 
@@ -416,7 +416,7 @@ Time O(n log n) expected, Space O(n)
 find(callbackfn, thisArg?): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3361](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3361)
+Defined in: [data-structures/binary-tree/tree-map.ts:3613](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3613)
 
 Find the first entry that satisfies a predicate.
 
@@ -458,7 +458,7 @@ Time O(n), Space O(1)
 first(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3824](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3824)
+Defined in: [data-structures/binary-tree/tree-map.ts:4109](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4109)
 
 Smallest entry by key.
 
@@ -506,7 +506,7 @@ Smallest entry by key.
 floor(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4366](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4366)
+Defined in: [data-structures/binary-tree/tree-map.ts:4684](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4684)
 
 Largest entry whose key is <= the given key.
 
@@ -549,7 +549,7 @@ Largest entry whose key is <= the given key.
 forEach(cb, thisArg?): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2185](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2185)
+Defined in: [data-structures/binary-tree/tree-map.ts:2347](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2347)
 
 Visit each entry in ascending key order.
 
@@ -589,7 +589,7 @@ Note: callback value may be `undefined`.
 get(key): V | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:783](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L783)
+Defined in: [data-structures/binary-tree/tree-map.ts:840](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L840)
 
 Get the value under a key.
 
@@ -632,7 +632,7 @@ Expected time O(log n)
 getByRank(k): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4942](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4942)
+Defined in: [data-structures/binary-tree/tree-map.ts:5296](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5296)
 
 Returns the entry at the k-th position in tree order (0-indexed).
 
@@ -673,7 +673,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 getRank(key): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4962](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4962)
+Defined in: [data-structures/binary-tree/tree-map.ts:5316](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5316)
 
 Returns the 0-based rank of a key (number of elements that precede it in tree order).
 
@@ -714,7 +714,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 has(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:991](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L991)
+Defined in: [data-structures/binary-tree/tree-map.ts:1063](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1063)
 
 Test whether a key exists.
 
@@ -756,7 +756,7 @@ Expected time O(log n)
 higher(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4540](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4540)
+Defined in: [data-structures/binary-tree/tree-map.ts:4870](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4870)
 
 Smallest entry whose key is > the given key.
 
@@ -799,7 +799,7 @@ Smallest entry whose key is > the given key.
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:322](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L322)
+Defined in: [data-structures/binary-tree/tree-map.ts:337](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L337)
 
 Whether the map is empty.
 
@@ -824,7 +824,7 @@ Whether the map is empty.
 keys(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1600](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1600)
+Defined in: [data-structures/binary-tree/tree-map.ts:1717](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1717)
 
 Iterate over keys in ascending order.
 
@@ -850,7 +850,7 @@ Iterate over keys in ascending order.
 last(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3881](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3881)
+Defined in: [data-structures/binary-tree/tree-map.ts:4169](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4169)
 
 Largest entry by key.
 
@@ -882,7 +882,7 @@ Largest entry by key.
 lower(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4712](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4712)
+Defined in: [data-structures/binary-tree/tree-map.ts:5054](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5054)
 
 Largest entry whose key is < the given key.
 
@@ -926,7 +926,7 @@ map<MK, MV>(
 thisArg?): TreeMap<MK, MV>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2378](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2378)
+Defined in: [data-structures/binary-tree/tree-map.ts:2555](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2555)
 
 Create a new TreeMap by mapping each entry to a new `[key, value]` entry.
 
@@ -983,7 +983,7 @@ Time O(n log n) expected, Space O(n)
 pollFirst(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3940](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3940)
+Defined in: [data-structures/binary-tree/tree-map.ts:4231](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4231)
 
 Remove and return the smallest entry.
 
@@ -1017,7 +1017,7 @@ Remove and return the smallest entry.
 pollLast(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4001](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4001)
+Defined in: [data-structures/binary-tree/tree-map.ts:4295](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4295)
 
 Remove and return the largest entry.
 
@@ -1051,7 +1051,7 @@ Remove and return the largest entry.
 print(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3748](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3748)
+Defined in: [data-structures/binary-tree/tree-map.ts:4030](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4030)
 
 Print a human-friendly representation.
 
@@ -1081,7 +1081,7 @@ Time O(n), Space O(n)
 rangeByRank(start, end): [K, V | undefined][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4993](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4993)
+Defined in: [data-structures/binary-tree/tree-map.ts:5353](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5353)
 
 Returns keys by rank range (0-indexed, inclusive on both ends).
 
@@ -1131,7 +1131,7 @@ Time O(log n + k). Requires `enableOrderStatistic: true`.
 rangeSearch(range, options?): [K, V | undefined][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4904](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L4904)
+Defined in: [data-structures/binary-tree/tree-map.ts:5258](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L5258)
 
 Return all entries in a given key range.
 
@@ -1197,7 +1197,7 @@ Inclusive/exclusive bounds (defaults to inclusive).
 reduce<A>(callbackfn, initialValue): A;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2779](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2779)
+Defined in: [data-structures/binary-tree/tree-map.ts:2986](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L2986)
 
 Reduce entries into a single accumulator.
 
@@ -1243,7 +1243,7 @@ Time O(n), Space O(1)
 set(key, value): this;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:537](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L537)
+Defined in: [data-structures/binary-tree/tree-map.ts:567](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L567)
 
 Set or overwrite a value for a key.
 
@@ -1299,7 +1299,7 @@ Expected time O(log n)
 setMany(entries): boolean[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:570](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L570)
+Defined in: [data-structures/binary-tree/tree-map.ts:612](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L612)
 
 Set multiple key-value pairs at once.
 
@@ -1340,7 +1340,7 @@ Expected time O(m log n), where m is the number of entries.
 some(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3165](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3165)
+Defined in: [data-structures/binary-tree/tree-map.ts:3402](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3402)
 
 Test whether any entry satisfies a predicate.
 
@@ -1380,7 +1380,7 @@ Time O(n), Space O(1)
 toArray(): [K, V | undefined][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3558](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3558)
+Defined in: [data-structures/binary-tree/tree-map.ts:3825](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L3825)
 
 Materialize the map into an array of `[key, value]` tuples.
 
@@ -1410,7 +1410,7 @@ Time O(n), Space O(n)
 values(): IterableIterator<V | undefined>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1797](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1797)
+Defined in: [data-structures/binary-tree/tree-map.ts:1929](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L1929)
 
 Iterate over values in ascending key order.