data-structure-typed 2.5.2 → 2.5.3

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

@@ -6,7 +6,7 @@
 
 # Class: TreeSet\<K, R\>
 
-Defined in: [data-structures/binary-tree/tree-set.ts:26](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L26)
+Defined in: [data-structures/binary-tree/tree-set.ts:26](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L26)
 
 An ordered Set backed by a red-black tree.
 
@@ -44,7 +44,7 @@ An ordered Set backed by a red-black tree.
 new TreeSet<K, R>(elements?, options?): TreeSet<K, R>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:46](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L46)
+Defined in: [data-structures/binary-tree/tree-set.ts:46](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L46)
 
 Create a TreeSet from an iterable of keys or raw elements.
 
@@ -92,7 +92,7 @@ const set = new TreeSet<number, User>(users, { toElementFn: u => u.id });
 get size(): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:101](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L101)
+Defined in: [data-structures/binary-tree/tree-set.ts:101](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L101)
 
 Number of elements in the set.
 
@@ -108,7 +108,7 @@ Number of elements in the set.
 add(key): this;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:468](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L468)
+Defined in: [data-structures/binary-tree/tree-set.ts:508](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L508)
 
 Add a key to the set (no-op if already present).
 
@@ -145,13 +145,54 @@ Expected time O(log n)
 
 ***
 
+### addMany()
+
+```ts
+addMany(keys): boolean[];
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:542](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L542)
+
+Add multiple keys at once.
+
+#### Parameters
+
+##### keys
+
+`Iterable`\<`K`\>
+
+Iterable of keys to add.
+
+#### Returns
+
+`boolean`[]
+
+Array of booleans indicating whether each key was newly added.
+
+ *
+
+#### Remarks
+
+Expected time O(m log n), where m is the number of keys.
+
+#### Example
+
+```ts
+// Add multiple keys
+ const ts = new TreeSet<number>();
+    ts.addMany([5, 3, 7, 1, 9]);
+    console.log(ts.size); // 5;
+```
+
+***
+
 ### ceiling()
 
 ```ts
 ceiling(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3483](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3483)
+Defined in: [data-structures/binary-tree/tree-set.ts:3908](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3908)
 
 Smallest key that is >= the given key.
 
@@ -195,7 +236,7 @@ Smallest key that is >= the given key.
 clear(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1012](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1012)
+Defined in: [data-structures/binary-tree/tree-set.ts:1165](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1165)
 
 Remove all keys.
 
@@ -222,7 +263,7 @@ Remove all keys.
 clone(): TreeSet<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:4341](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L4341)
+Defined in: [data-structures/binary-tree/tree-set.ts:4858](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4858)
 
 Creates a shallow clone of this set.
 
@@ -254,7 +295,7 @@ Time O(n log n), Space O(n)
 delete(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:840](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L840)
+Defined in: [data-structures/binary-tree/tree-set.ts:956](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L956)
 
 Delete a key.
 
@@ -289,13 +330,43 @@ Expected time O(log n)
 
 ***
 
+### deleteWhere()
+
+```ts
+deleteWhere(predicate): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:967](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L967)
+
+Delete all keys matching a predicate.
+
+#### Parameters
+
+##### predicate
+
+(`key`, `index`, `set`) => `boolean`
+
+Function (key, index, set) → boolean; return true to delete.
+
+#### Returns
+
+`boolean`
+
+True if at least one key was deleted.
+
+#### Remarks
+
+Time O(N), Space O(N)
+
+***
+
 ### entries()
 
 ```ts
 entries(): IterableIterator<[K, K]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1523](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1523)
+Defined in: [data-structures/binary-tree/tree-set.ts:1736](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1736)
 
 Iterate over `[value, value]` pairs (native Set convention).
 
@@ -323,7 +394,7 @@ Note: TreeSet stores only keys internally; `[k, k]` is created on-the-fly during
 every(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2406](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2406)
+Defined in: [data-structures/binary-tree/tree-set.ts:2719](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2719)
 
 Test whether all values satisfy a predicate.
 
@@ -363,7 +434,7 @@ Time O(n), Space O(1)
 filter(callbackfn, thisArg?): TreeSet<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2056](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2056)
+Defined in: [data-structures/binary-tree/tree-set.ts:2329](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2329)
 
 Create a new TreeSet containing only values that satisfy the predicate.
 
@@ -404,7 +475,7 @@ Time O(n log n) expected, Space O(n)
 find(callbackfn, thisArg?): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2757](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2757)
+Defined in: [data-structures/binary-tree/tree-set.ts:3110](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3110)
 
 Find the first value that satisfies a predicate.
 
@@ -445,7 +516,7 @@ Time O(n), Space O(1)
 first(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3176](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3176)
+Defined in: [data-structures/binary-tree/tree-set.ts:3573](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3573)
 
 Smallest key in the set.
 
@@ -494,7 +565,7 @@ Smallest key in the set.
 floor(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3633](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3633)
+Defined in: [data-structures/binary-tree/tree-set.ts:4074](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4074)
 
 Largest key that is <= the given key.
 
@@ -530,7 +601,7 @@ Largest key that is <= the given key.
 forEach(cb, thisArg?): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1700](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1700)
+Defined in: [data-structures/binary-tree/tree-set.ts:1933](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1933)
 
 Visit each value in ascending order.
 
@@ -570,7 +641,7 @@ Callback follows native Set convention: `(value, value2, set)`.
 getByRank(k): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:4127](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L4127)
+Defined in: [data-structures/binary-tree/tree-set.ts:4616](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4616)
 
 Returns the element at the k-th position in tree order (0-indexed).
 
@@ -608,7 +679,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 getRank(key): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:4145](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L4145)
+Defined in: [data-structures/binary-tree/tree-set.ts:4634](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4634)
 
 Returns the 0-based rank of a key (number of elements that precede it in tree order).
 
@@ -649,7 +720,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 has(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:654](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L654)
+Defined in: [data-structures/binary-tree/tree-set.ts:750](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L750)
 
 Test whether a key exists.
 
@@ -687,7 +758,7 @@ Expected time O(log n)
 higher(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3781](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3781)
+Defined in: [data-structures/binary-tree/tree-set.ts:4238](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4238)
 
 Smallest key that is > the given key.
 
@@ -721,7 +792,7 @@ Smallest key that is > the given key.
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:269](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L269)
+Defined in: [data-structures/binary-tree/tree-set.ts:289](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L289)
 
 Whether the set is empty.
 
@@ -746,7 +817,7 @@ Whether the set is empty.
 keys(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1181](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1181)
+Defined in: [data-structures/binary-tree/tree-set.ts:1354](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1354)
 
 Iterate over keys in ascending order.
 
@@ -772,7 +843,7 @@ Iterate over keys in ascending order.
 last(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3223](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3223)
+Defined in: [data-structures/binary-tree/tree-set.ts:3624](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3624)
 
 Largest key in the set.
 
@@ -799,7 +870,7 @@ Largest key in the set.
 lower(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3929](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3929)
+Defined in: [data-structures/binary-tree/tree-set.ts:4402](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4402)
 
 Largest key that is < the given key.
 
@@ -836,7 +907,7 @@ map<MK>(
 thisArg?): TreeSet<MK>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1873](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1873)
+Defined in: [data-structures/binary-tree/tree-set.ts:2126](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2126)
 
 Create a new TreeSet by mapping each value to a new key.
 
@@ -889,7 +960,7 @@ Time O(n log n) expected, Space O(n)
 pollFirst(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3272](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3272)
+Defined in: [data-structures/binary-tree/tree-set.ts:3677](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3677)
 
 Remove and return the smallest key.
 
@@ -918,7 +989,7 @@ Remove and return the smallest key.
 pollLast(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3323](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3323)
+Defined in: [data-structures/binary-tree/tree-set.ts:3732](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3732)
 
 Remove and return the largest key.
 
@@ -946,7 +1017,7 @@ Remove and return the largest key.
 print(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3104](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L3104)
+Defined in: [data-structures/binary-tree/tree-set.ts:3497](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3497)
 
 Print a human-friendly representation.
 
@@ -976,7 +1047,7 @@ Time O(n), Space O(n)
 rangeByRank(start, end): K[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:4168](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L4168)
+Defined in: [data-structures/binary-tree/tree-set.ts:4665](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4665)
 
 Returns elements by rank range (0-indexed, inclusive on both ends).
 
@@ -1003,7 +1074,7 @@ Time O(log n + k). Requires `enableOrderStatistic: true`.
 #### Example
 
 ```ts
-// Pagination with rangeByRank
+// Pagination by position in tree order
  const tree = new TreeSet<number>(
         [10, 20, 30, 40, 50, 60, 70, 80, 90],
         { enableOrderStatistic: true }
@@ -1026,7 +1097,7 @@ Time O(log n + k). Requires `enableOrderStatistic: true`.
 rangeSearch(range, options?): K[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:4091](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L4091)
+Defined in: [data-structures/binary-tree/tree-set.ts:4580](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4580)
 
 Return all keys in a given range.
 
@@ -1079,7 +1150,7 @@ Inclusive/exclusive bounds (defaults to inclusive).
 reduce<A>(callbackfn, initialValue): A;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2235](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2235)
+Defined in: [data-structures/binary-tree/tree-set.ts:2528](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2528)
 
 Reduce values into a single accumulator.
 
@@ -1126,7 +1197,7 @@ Time O(n), Space O(1)
 some(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2581](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2581)
+Defined in: [data-structures/binary-tree/tree-set.ts:2914](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2914)
 
 Test whether any value satisfies a predicate.
 
@@ -1166,7 +1237,7 @@ Time O(n), Space O(1)
 toArray(): K[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2934](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L2934)
+Defined in: [data-structures/binary-tree/tree-set.ts:3307](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3307)
 
 Materialize the set into an array of keys.
 
@@ -1196,7 +1267,7 @@ Time O(n), Space O(n)
 values(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1352](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L1352)
+Defined in: [data-structures/binary-tree/tree-set.ts:1545](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1545)
 
 Iterate over values in ascending order.
 
@@ -1224,7 +1295,7 @@ Note: for Set-like containers, `values()` is the same as `keys()`.
 static createDefaultComparator<K>(): Comparator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:71](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L71)
+Defined in: [data-structures/binary-tree/tree-set.ts:71](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L71)
 
 Create the strict default comparator.