data-structure-typed 2.5.1 → 2.5.2

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/2f6ceb3aee852228efc88b111e19c0809753e805/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/8292cb978daf85ebe846186c7c7572aece04fb7b/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/2f6ceb3aee852228efc88b111e19c0809753e805/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/8292cb978daf85ebe846186c7c7572aece04fb7b/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/2f6ceb3aee852228efc88b111e19c0809753e805/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/8292cb978daf85ebe846186c7c7572aece04fb7b/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:398](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L398)
+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)
 
 Add a key to the set (no-op if already present).
 
@@ -151,7 +151,7 @@ Expected time O(log n)
 ceiling(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2832](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2832)
+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)
 
 Smallest key that is >= the given key.
 
@@ -195,7 +195,7 @@ Smallest key that is >= the given key.
 clear(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:837](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L837)
+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)
 
 Remove all keys.
 
@@ -222,7 +222,7 @@ Remove all keys.
 clone(): TreeSet<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3483](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L3483)
+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)
 
 Creates a shallow clone of this set.
 
@@ -254,7 +254,7 @@ Time O(n log n), Space O(n)
 delete(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:700](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L700)
+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)
 
 Delete a key.
 
@@ -295,7 +295,7 @@ Expected time O(log n)
 entries(): IterableIterator<[K, K]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1243](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1243)
+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)
 
 Iterate over `[value, value]` pairs (native Set convention).
 
@@ -323,7 +323,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:1951](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1951)
+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)
 
 Test whether all values satisfy a predicate.
 
@@ -363,7 +363,7 @@ Time O(n), Space O(1)
 filter(callbackfn, thisArg?): TreeSet<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1671](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1671)
+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)
 
 Create a new TreeSet containing only values that satisfy the predicate.
 
@@ -404,7 +404,7 @@ Time O(n log n) expected, Space O(n)
 find(callbackfn, thisArg?): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2232](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2232)
+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)
 
 Find the first value that satisfies a predicate.
 
@@ -445,7 +445,7 @@ Time O(n), Space O(1)
 first(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2574](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2574)
+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)
 
 Smallest key in the set.
 
@@ -494,7 +494,7 @@ Smallest key in the set.
 floor(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2954](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2954)
+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)
 
 Largest key that is <= the given key.
 
@@ -530,7 +530,7 @@ Largest key that is <= the given key.
 forEach(cb, thisArg?): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1385](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1385)
+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)
 
 Visit each value in ascending order.
 
@@ -546,7 +546,7 @@ Callback follows native Set convention: `(value, value2, set)`.
 
 ##### thisArg?
 
-`any`
+`unknown`
 
 #### Returns
 
@@ -564,13 +564,92 @@ Callback follows native Set convention: `(value, value2, set)`.
 
 ***
 
+### getByRank()
+
+```ts
+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)
+
+Returns the element at the k-th position in tree order (0-indexed).
+
+#### Parameters
+
+##### k
+
+`number`
+
+#### Returns
+
+`K` \| `undefined`
+
+#### Remarks
+
+Time O(log n). Requires `enableOrderStatistic: true`.
+
+ *
+
+#### Example
+
+```ts
+// Find k-th element in a TreeSet
+ const set = new TreeSet<number>([30, 10, 50, 20, 40], { enableOrderStatistic: true });
+      console.log(set.getByRank(0)); // 10;
+      console.log(set.getByRank(2)); // 30;
+      console.log(set.getRank(30)); // 2;
+```
+
+***
+
+### getRank()
+
+```ts
+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)
+
+Returns the 0-based rank of a key (number of elements that precede it in tree order).
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`number`
+
+#### Remarks
+
+Time O(log n). Requires `enableOrderStatistic: true`.
+ *
+
+#### Example
+
+```ts
+// Get the rank of a key in sorted order
+ const tree = new TreeSet<number>(
+        [10, 20, 30, 40, 50],
+        { enableOrderStatistic: true }
+      );
+      console.log(tree.getRank(10)); // 0;  // smallest → rank 0
+      console.log(tree.getRank(30)); // 2;  // 2 elements before 30 in tree order
+      console.log(tree.getRank(50)); // 4;  // largest → rank 4
+      console.log(tree.getRank(25)); // 2;
+```
+
+***
+
 ### has()
 
 ```ts
 has(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:549](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L549)
+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)
 
 Test whether a key exists.
 
@@ -608,7 +687,7 @@ Expected time O(log n)
 higher(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3074](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L3074)
+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)
 
 Smallest key that is > the given key.
 
@@ -642,7 +721,7 @@ Smallest key that is > the given key.
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:234](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L234)
+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)
 
 Whether the set is empty.
 
@@ -667,7 +746,7 @@ Whether the set is empty.
 keys(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:971](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L971)
+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)
 
 Iterate over keys in ascending order.
 
@@ -693,7 +772,7 @@ Iterate over keys in ascending order.
 last(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2614](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2614)
+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)
 
 Largest key in the set.
 
@@ -720,7 +799,7 @@ Largest key in the set.
 lower(key): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3194](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L3194)
+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)
 
 Largest key that is < the given key.
 
@@ -757,7 +836,7 @@ map<MK>(
 thisArg?): TreeSet<MK>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1523](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1523)
+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)
 
 Create a new TreeSet by mapping each value to a new key.
 
@@ -810,7 +889,7 @@ Time O(n log n) expected, Space O(n)
 pollFirst(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2656](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2656)
+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)
 
 Remove and return the smallest key.
 
@@ -839,7 +918,7 @@ Remove and return the smallest key.
 pollLast(): K | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2700](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2700)
+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)
 
 Remove and return the largest key.
 
@@ -867,7 +946,7 @@ Remove and return the largest key.
 print(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2509](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2509)
+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)
 
 Print a human-friendly representation.
 
@@ -891,13 +970,63 @@ Time O(n), Space O(n)
 
 ***
 
+### rangeByRank()
+
+```ts
+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)
+
+Returns elements by rank range (0-indexed, inclusive on both ends).
+
+#### Parameters
+
+##### start
+
+`number`
+
+##### end
+
+`number`
+
+#### Returns
+
+`K`[]
+
+#### Remarks
+
+Time O(log n + k). Requires `enableOrderStatistic: true`.
+
+ *
+
+#### Example
+
+```ts
+// Pagination with rangeByRank
+ const tree = new TreeSet<number>(
+        [10, 20, 30, 40, 50, 60, 70, 80, 90],
+        { enableOrderStatistic: true }
+      );
+      const pageSize = 3;
+
+      // Page 1
+      console.log(tree.rangeByRank(0, pageSize - 1)); // [10, 20, 30];
+      // Page 2
+      console.log(tree.rangeByRank(pageSize, 2 * pageSize - 1)); // [40, 50, 60];
+      // Page 3
+      console.log(tree.rangeByRank(2 * pageSize, 3 * pageSize - 1)); // [70, 80, 90];
+```
+
+***
+
 ### rangeSearch()
 
 ```ts
 rangeSearch(range, options?): K[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:3328](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L3328)
+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)
 
 Return all keys in a given range.
 
@@ -950,7 +1079,7 @@ Inclusive/exclusive bounds (defaults to inclusive).
 reduce<A>(callbackfn, initialValue): A;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1815](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1815)
+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)
 
 Reduce values into a single accumulator.
 
@@ -997,7 +1126,7 @@ Time O(n), Space O(1)
 some(callbackfn, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2091](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2091)
+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)
 
 Test whether any value satisfies a predicate.
 
@@ -1037,7 +1166,7 @@ Time O(n), Space O(1)
 toArray(): K[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:2374](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L2374)
+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)
 
 Materialize the set into an array of keys.
 
@@ -1067,7 +1196,7 @@ Time O(n), Space O(n)
 values(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-set.ts:1107](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/binary-tree/tree-set.ts#L1107)
+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)
 
 Iterate over values in ascending order.
 
@@ -1095,7 +1224,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/2f6ceb3aee852228efc88b111e19c0809753e805/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/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-set.ts#L71)
 
 Create the strict default comparator.