data-structure-typed 2.6.0 → 2.6.1

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

@@ -108,7 +108,7 @@ Number of elements in the set.
 add(key): this;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:538](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L538)
 
 Add a key to the set (no-op if already present).
 
@@ -151,7 +151,7 @@ Expected time O(log n)
 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)
+Defined in: [data-structures/binary-tree/tree-set.ts:584](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L584)
 
 Add multiple keys at once.
 
@@ -192,7 +192,7 @@ Expected time O(m log n), where m is the number of keys.
 ceiling(key): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4199](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4199)
 
 Smallest key that is >= the given key.
 
@@ -236,7 +236,7 @@ Smallest key that is >= the given key.
 clear(): void;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1252](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1252)
 
 Remove all keys.
 
@@ -263,20 +263,16 @@ Remove all keys.
 clone(): TreeSet<K>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:5350](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5350)
 
-Creates a shallow clone of this set.
+Deep copy
+
+ *
 
 #### Returns
 
 `TreeSet`\<`K`\>
 
-#### Remarks
-
-Time O(n log n), Space O(n)
-
- *
-
 #### Example
 
 ```ts
@@ -295,7 +291,7 @@ Time O(n log n), Space O(n)
 delete(key): boolean;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1028](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1028)
 
 Delete a key.
 
@@ -336,7 +332,7 @@ Expected time O(log n)
 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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1039](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1039)
 
 Delete all keys matching a predicate.
 
@@ -360,13 +356,51 @@ Time O(N), Space O(N)
 
 ***
 
+### difference()
+
+```ts
+difference(other): TreeSet<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5252](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5252)
+
+Return a new TreeSet containing elements in this set but not in the other.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys.
+
+#### Returns
+
+`TreeSet`\<`K`\>
+
+A new TreeSet.
+ *
+
+#### Remarks
+
+Time O(n+m) with ordered merge when possible, otherwise O(n log m).
+
+#### Example
+
+```ts
+// Find exclusive elements
+ console.log([...a.difference(b)]); // [1, 2];
+```
+
+***
+
 ### entries()
 
 ```ts
 entries(): IterableIterator<[K, K]>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1868](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1868)
 
 Iterate over `[value, value]` pairs (native Set convention).
 
@@ -394,7 +428,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:2719](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2719)
+Defined in: [data-structures/binary-tree/tree-set.ts:2926](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2926)
 
 Test whether all values satisfy a predicate.
 
@@ -434,7 +468,7 @@ Time O(n), Space O(1)
 filter(callbackfn, thisArg?): TreeSet<K>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:2506](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2506)
 
 Create a new TreeSet containing only values that satisfy the predicate.
 
@@ -475,7 +509,7 @@ Time O(n log n) expected, Space O(n)
 find(callbackfn, thisArg?): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3347](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3347)
 
 Find the first value that satisfies a predicate.
 
@@ -516,7 +550,7 @@ Time O(n), Space O(1)
 first(): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3843](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3843)
 
 Smallest key in the set.
 
@@ -565,7 +599,7 @@ Smallest key in the set.
 floor(key): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4377](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4377)
 
 Largest key that is <= the given key.
 
@@ -601,7 +635,7 @@ Largest key that is <= the given key.
 forEach(cb, thisArg?): void;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:2080](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2080)
 
 Visit each value in ascending order.
 
@@ -641,7 +675,7 @@ Callback follows native Set convention: `(value, value2, set)`.
 getByRank(k): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4955](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4955)
 
 Returns the element at the k-th position in tree order (0-indexed).
 
@@ -679,7 +713,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 getRank(key): number;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4973](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4973)
 
 Returns the 0-based rank of a key (number of elements that precede it in tree order).
 
@@ -720,7 +754,7 @@ Time O(log n). Requires `enableOrderStatistic: true`.
 has(key): boolean;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:807](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L807)
 
 Test whether a key exists.
 
@@ -758,7 +792,7 @@ Expected time O(log n)
 higher(key): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4553](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4553)
 
 Smallest key that is > the given key.
 
@@ -786,13 +820,89 @@ Smallest key that is > the given key.
 
 ***
 
+### intersection()
+
+```ts
+intersection(other): TreeSet<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5234](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5234)
+
+Return a new TreeSet containing only elements present in both sets.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys (converted to Set for fast lookup if not a TreeSet).
+
+#### Returns
+
+`TreeSet`\<`K`\>
+
+A new TreeSet.
+ *
+
+#### Remarks
+
+Time O(n+m) with ordered merge when possible, otherwise O(n log m).
+
+#### Example
+
+```ts
+// Find common elements
+ console.log([...a.intersection(b)]); // [3, 4, 5];
+```
+
+***
+
+### isDisjointFrom()
+
+```ts
+isDisjointFrom(other): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5324](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5324)
+
+Check whether this set and the other share no common elements.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys (converted to Set for fast lookup if not a TreeSet).
+
+#### Returns
+
+`boolean`
+
+`true` if sets are disjoint.
+ *
+
+#### Remarks
+
+Time O(min(n,m)), can short-circuit on first overlap.
+
+#### Example
+
+```ts
+// Check disjoint
+ console.log(a.isDisjointFrom(new TreeSet([8, 9]))); // true;
+```
+
+***
+
 ### isEmpty()
 
 ```ts
 isEmpty(): boolean;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:304](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L304)
 
 Whether the set is empty.
 
@@ -811,13 +921,89 @@ Whether the set is empty.
 
 ***
 
+### isSubsetOf()
+
+```ts
+isSubsetOf(other): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5291](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5291)
+
+Check whether every element in this set is also in the other.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys (converted to Set for fast lookup if not a TreeSet).
+
+#### Returns
+
+`boolean`
+
+`true` if this is a subset of other.
+ *
+
+#### Remarks
+
+Time O(n).
+
+#### Example
+
+```ts
+// Check subset
+ console.log(new TreeSet([3, 4]).isSubsetOf(a)); // true;
+```
+
+***
+
+### isSupersetOf()
+
+```ts
+isSupersetOf(other): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5308](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5308)
+
+Check whether every element in the other set is also in this set.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys.
+
+#### Returns
+
+`boolean`
+
+`true` if this is a superset of other.
+ *
+
+#### Remarks
+
+Time O(m).
+
+#### Example
+
+```ts
+// Check superset
+ console.log(a.isSupersetOf(new TreeSet([2, 3]))); // true;
+```
+
+***
+
 ### keys()
 
 ```ts
 keys(): IterableIterator<K>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1456](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1456)
 
 Iterate over keys in ascending order.
 
@@ -843,7 +1029,7 @@ Iterate over keys in ascending order.
 last(): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3897](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3897)
 
 Largest key in the set.
 
@@ -870,7 +1056,7 @@ Largest key in the set.
 lower(key): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4729](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4729)
 
 Largest key that is < the given key.
 
@@ -907,7 +1093,7 @@ map<MK>(
 thisArg?): TreeSet<MK>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:2288](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2288)
 
 Create a new TreeSet by mapping each value to a new key.
 
@@ -960,7 +1146,7 @@ Time O(n log n) expected, Space O(n)
 pollFirst(): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3953](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3953)
 
 Remove and return the smallest key.
 
@@ -989,7 +1175,7 @@ Remove and return the smallest key.
 pollLast(): K | undefined;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4011](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4011)
 
 Remove and return the largest key.
 
@@ -1017,7 +1203,7 @@ Remove and return the largest key.
 print(): void;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3764](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3764)
 
 Print a human-friendly representation.
 
@@ -1047,7 +1233,7 @@ Time O(n), Space O(n)
 rangeByRank(start, end): K[];
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:5010](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5010)
 
 Returns elements by rank range (0-indexed, inclusive on both ends).
 
@@ -1097,7 +1283,7 @@ Time O(log n + k). Requires `enableOrderStatistic: true`.
 rangeSearch(range, options?): K[];
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:4919](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L4919)
 
 Return all keys in a given range.
 
@@ -1150,7 +1336,7 @@ Inclusive/exclusive bounds (defaults to inclusive).
 reduce<A>(callbackfn, initialValue): A;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:2720](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L2720)
 
 Reduce values into a single accumulator.
 
@@ -1197,7 +1383,7 @@ Time O(n), Space O(1)
 some(callbackfn, thisArg?): boolean;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3136](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3136)
 
 Test whether any value satisfies a predicate.
 
@@ -1231,13 +1417,51 @@ Time O(n), Space O(1)
 
 ***
 
+### symmetricDifference()
+
+```ts
+symmetricDifference(other): TreeSet<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5270](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5270)
+
+Return a new TreeSet containing elements in either set but not both.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys.
+
+#### Returns
+
+`TreeSet`\<`K`\>
+
+A new TreeSet.
+ *
+
+#### Remarks
+
+Time O(n+m).
+
+#### Example
+
+```ts
+// Find symmetric difference
+ console.log([...a.symmetricDifference(b)]); // [1, 2, 6, 7];
+```
+
+***
+
 ### toArray()
 
 ```ts
 toArray(): K[];
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:3559](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L3559)
 
 Materialize the set into an array of keys.
 
@@ -1261,13 +1485,51 @@ Time O(n), Space O(n)
 
 ***
 
+### union()
+
+```ts
+union(other): TreeSet<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-set.ts:5219](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L5219)
+
+Return a new TreeSet containing all elements from both sets.
+
+#### Parameters
+
+##### other
+
+`Iterable`\<`K`\>
+
+Any iterable of keys.
+
+#### Returns
+
+`TreeSet`\<`K`\>
+
+A new TreeSet.
+ *
+
+#### Remarks
+
+When both sets share the same comparator, uses O(n+m) merge. Otherwise O(m log n).
+
+#### Example
+
+```ts
+// Merge two sets
+ console.log([...a.union(b)]); // [1, 2, 3, 4, 5, 6, 7];
+```
+
+***
+
 ### values()
 
 ```ts
 values(): IterableIterator<K>;
 ```
 
-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)
+Defined in: [data-structures/binary-tree/tree-set.ts:1662](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-set.ts#L1662)
 
 Iterate over values in ascending order.