data-structure-typed 2.5.2 → 2.6.0

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

@@ -6,7 +6,7 @@
 
 # Class: TreeMap\<K, V, R\>
 
-Defined in: [data-structures/binary-tree/tree-map.ts:26](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L26)
+Defined in: [data-structures/binary-tree/tree-map.ts:26](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L26)
 
 An ordered Map backed by a red-black tree.
 
@@ -48,7 +48,7 @@ An ordered Map backed by a red-black tree.
 new TreeMap<K, V, R>(entries?, options?): TreeMap<K, V, R>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:46](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L46)
+Defined in: [data-structures/binary-tree/tree-map.ts:46](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L46)
 
 Create a TreeMap from an iterable of `[key, value]` entries or raw elements.
 
@@ -97,7 +97,7 @@ const map = new TreeMap<number, User, User>(users, { toEntryFn: u => [u.id, u] }
 get size(): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:134](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L134)
+Defined in: [data-structures/binary-tree/tree-map.ts:134](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L134)
 
 Number of entries in the map.
 
@@ -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:3747](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3747)
+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)
 
 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:1238](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1238)
+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)
 
 Remove all entries.
 
@@ -199,7 +199,7 @@ Remove all entries.
 clone(): TreeMap<K, V>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4652](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4652)
+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)
 
 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:1066](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1066)
+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)
 
 Delete a key.
 
@@ -271,13 +271,43 @@ Expected time O(log n)
 
 ***
 
+### deleteWhere()
+
+```ts
+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)
+
+Delete all entries matching a predicate.
+
+#### Parameters
+
+##### predicate
+
+(`key`, `value`, `index`, `map`) => `boolean`
+
+Function (key, value, index, map) → boolean; return true to delete.
+
+#### Returns
+
+`boolean`
+
+True if at least one entry was deleted.
+
+#### Remarks
+
+Time O(N), Space O(N)
+
+***
+
 ### entries()
 
 ```ts
 entries(): IterableIterator<[K, V | undefined]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1755](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1755)
+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)
 
 Iterate over `[key, value]` entries in ascending key order.
 
@@ -305,7 +335,7 @@ Note: values may be `undefined`.
 every(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2637](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2637)
+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)
 
 Test whether all entries satisfy a predicate.
 
@@ -345,7 +375,7 @@ Time O(n), Space O(1)
 filter(callbackfn, thisArg?): TreeMap<K, V>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2288](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2288)
+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)
 
 Create a new TreeMap containing only entries that satisfy the predicate.
 
@@ -386,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:2988](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2988)
+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)
 
 Find the first entry that satisfies a predicate.
 
@@ -428,7 +458,7 @@ Time O(n), Space O(1)
 first(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3407](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3407)
+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)
 
 Smallest entry by key.
 
@@ -476,7 +506,7 @@ Smallest entry by key.
 floor(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3905](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3905)
+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)
 
 Largest entry whose key is <= the given key.
 
@@ -519,7 +549,7 @@ Largest entry whose key is <= the given key.
 forEach(cb, thisArg?): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1932](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1932)
+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)
 
 Visit each entry in ascending key order.
 
@@ -559,7 +589,7 @@ Note: callback value may be `undefined`.
 get(key): V | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:687](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L687)
+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)
 
 Get the value under a key.
 
@@ -602,7 +632,7 @@ Expected time O(log n)
 getByRank(k): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4433](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4433)
+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)
 
 Returns the entry at the k-th position in tree order (0-indexed).
 
@@ -643,7 +673,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 getRank(key): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4453](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4453)
+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)
 
 Returns the 0-based rank of a key (number of elements that precede it in tree order).
 
@@ -684,7 +714,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 has(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:875](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L875)
+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)
 
 Test whether a key exists.
 
@@ -726,7 +756,7 @@ Expected time O(log n)
 higher(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4063](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4063)
+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)
 
 Smallest entry whose key is > the given key.
 
@@ -769,7 +799,7 @@ Smallest entry whose key is > the given key.
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:302](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L302)
+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)
 
 Whether the map is empty.
 
@@ -794,7 +824,7 @@ Whether the map is empty.
 keys(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1407](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1407)
+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)
 
 Iterate over keys in ascending order.
 
@@ -820,7 +850,7 @@ Iterate over keys in ascending order.
 last(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3460](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3460)
+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)
 
 Largest entry by key.
 
@@ -852,7 +882,7 @@ Largest entry by key.
 lower(key): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4219](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4219)
+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)
 
 Largest entry whose key is < the given key.
 
@@ -896,7 +926,7 @@ map<MK, MV>(
 thisArg?): TreeMap<MK, MV>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2105](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2105)
+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)
 
 Create a new TreeMap by mapping each entry to a new `[key, value]` entry.
 
@@ -953,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:3515](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3515)
+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)
 
 Remove and return the smallest entry.
 
@@ -987,7 +1017,7 @@ Remove and return the smallest entry.
 pollLast(): [K, V | undefined] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3572](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3572)
+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)
 
 Remove and return the largest entry.
 
@@ -1021,7 +1051,7 @@ Remove and return the largest entry.
 print(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3335](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3335)
+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)
 
 Print a human-friendly representation.
 
@@ -1051,7 +1081,7 @@ Time O(n), Space O(n)
 rangeByRank(start, end): [K, V | undefined][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:4476](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4476)
+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)
 
 Returns keys by rank range (0-indexed, inclusive on both ends).
 
@@ -1078,7 +1108,7 @@ Time O(log n + k). Requires `enableOrderStatistic: true`.
 #### Example
 
 ```ts
-// Pagination with rangeByRank
+// Pagination by position in tree order
  const tree = new TreeMap<number>(
         [10, 20, 30, 40, 50, 60, 70, 80, 90],
         { enableOrderStatistic: true }
@@ -1101,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:4395](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L4395)
+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)
 
 Return all entries in a given key range.
 
@@ -1167,7 +1197,7 @@ Inclusive/exclusive bounds (defaults to inclusive).
 reduce<A>(callbackfn, initialValue): A;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2466](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2466)
+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)
 
 Reduce entries into a single accumulator.
 
@@ -1213,7 +1243,7 @@ Time O(n), Space O(1)
 set(key, value): this;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:497](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L497)
+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)
 
 Set or overwrite a value for a key.
 
@@ -1263,13 +1293,54 @@ Expected time O(log n)
 
 ***
 
+### setMany()
+
+```ts
+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)
+
+Set multiple key-value pairs at once.
+
+#### Parameters
+
+##### entries
+
+`Iterable`\<\[`K`, `V` \| `undefined`\]\>
+
+Iterable of `[key, value]` tuples.
+
+#### Returns
+
+`boolean`[]
+
+Array of booleans indicating whether each entry was successfully set.
+
+ *
+
+#### Remarks
+
+Expected time O(m log n), where m is the number of entries.
+
+#### Example
+
+```ts
+// Set multiple key-value pairs
+ const tm = new TreeMap<number, string>();
+    tm.setMany([[1, 'a'], [2, 'b'], [3, 'c']]);
+    console.log(tm.size); // 3;
+```
+
+***
+
 ### some()
 
 ```ts
 some(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:2812](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L2812)
+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)
 
 Test whether any entry satisfies a predicate.
 
@@ -1309,7 +1380,7 @@ Time O(n), Space O(1)
 toArray(): [K, V | undefined][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:3165](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L3165)
+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)
 
 Materialize the map into an array of `[key, value]` tuples.
 
@@ -1339,7 +1410,7 @@ Time O(n), Space O(n)
 values(): IterableIterator<V | undefined>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:1584](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L1584)
+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)
 
 Iterate over values in ascending key order.
 
@@ -1367,7 +1438,7 @@ Note: values may be `undefined` (TreeMap allows storing `undefined`, like native
 static createDefaultComparator<K>(): Comparator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-map.ts:87](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-map.ts#L87)
+Defined in: [data-structures/binary-tree/tree-map.ts:87](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-map.ts#L87)
 
 Create the strict default comparator.