data-structure-typed 2.5.0 → 2.5.2

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

@@ -0,0 +1,1591 @@
+[**data-structure-typed**](../README.md)
+
+***
+
+[data-structure-typed](../README.md) / TreeMultiMap
+
+# Class: TreeMultiMap\<K, V, R\>
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:28](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L28)
+
+TreeMultiMap (ordered MultiMap) — key → bucket (Array of values).
+
+Semantics (RFC):
+- Bucketed design: each key appears once; duplicates live in the bucket.
+- `get(key)` returns a **live** bucket reference.
+- Default iteration yields bucket entries: `[K, V[]]`.
+- Navigable operations (`first/last/ceiling/...`) return entry tuples like TreeMap.
+
+## Example
+
+```ts
+// Morris traversal (O(1) space)
+ const tmm = new TreeMultiMap<number>([5, 3, 7]);
+    const result = tmm.morris(n => n.key, 'IN');
+    console.log(result.length); // > 0;
+```
+
+## Type Parameters
+
+### K
+
+`K` = `any`
+
+### V
+
+`V` = `any`
+
+### R
+
+`R` = `any`
+
+## Implements
+
+- `Iterable`\<\[`K`, `V`[]\]\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new TreeMultiMap<K, V, R>(keysNodesEntriesOrRaws?, options?): TreeMultiMap<K, V, R>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:45](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L45)
+
+Creates a new TreeMultiMap.
+
+#### Parameters
+
+##### keysNodesEntriesOrRaws?
+
+`Iterable`\<
+  \| `K`
+  \| `R`
+  \| \[`K` \| `null` \| `undefined`, `V`[] \| `undefined`\]
+  \| `null`
+  \| `undefined`\> = `[]`
+
+Initial entries, or raw elements if `toEntryFn` is provided.
+
+##### options?
+
+`TreeMultiMapOptions`\<`K`, `V`[], `R`\> = `{}`
+
+Configuration options including optional `toEntryFn` to transform raw elements.
+
+#### Returns
+
+`TreeMultiMap`\<`K`, `V`, `R`\>
+
+#### Remarks
+
+Time O(m log m), Space O(m) where m is the number of initial entries
+
+#### Example
+
+```ts
+// Standard usage with entries
+const mmap = new TreeMultiMap([['a', ['x', 'y']], ['b', ['z']]]);
+
+// Using toEntryFn to transform raw objects
+const players = [{ score: 100, items: ['sword'] }, { score: 200, items: ['shield', 'bow'] }];
+const mmap = new TreeMultiMap(players, { toEntryFn: p => [p.score, p.items] });
+```
+
+## Accessors
+
+### comparator
+
+#### Get Signature
+
+```ts
+get comparator(): Comparator<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4533](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4533)
+
+Expose comparator for advanced usage/testing (read-only).
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+`Comparator`\<`K`\>
+
+***
+
+### size
+
+#### Get Signature
+
+```ts
+get size(): number;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:109](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L109)
+
+Number of distinct keys.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+`number`
+
+***
+
+### totalSize
+
+#### Get Signature
+
+```ts
+get totalSize(): number;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:532](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L532)
+
+Total number of values across all buckets (Σ bucket.length).
+
+##### Remarks
+
+Time O(n), Space O(1)
+
+ *
+
+##### Example
+
+```ts
+// Total number of values
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      mm.add(2, 'c');
+      console.log(mm.totalSize); // 3;
+```
+
+##### Returns
+
+`number`
+
+## Methods
+
+### \[iterator\]()
+
+```ts
+iterator: Iterator<[K, V[]]>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1721](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1721)
+
+Iterates over all entries as [key, bucket] pairs.
+
+#### Returns
+
+`Iterator`\<\[`K`, `V`[]\]\>
+
+#### Remarks
+
+Time O(n), Space O(1)
+
+#### Implementation of
+
+```ts
+Iterable.[iterator]
+```
+
+***
+
+### add()
+
+```ts
+add(key, value): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1123](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1123)
+
+Append a single value.
+
+#### Parameters
+
+##### key
+
+`K`
+
+##### value
+
+`V`
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Add key-value pair
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      mm.add(2, 'c');
+      console.log(mm.get(1)); // ['a', 'b'];
+```
+
+***
+
+### ceiling()
+
+```ts
+ceiling(key): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2624](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2624)
+
+Returns the entry with the smallest key >= given key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Least key ≥ target
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(10, 'a');
+      mm.add(20, 'b');
+      mm.add(30, 'c');
+      console.log(mm.ceiling(15)?.[0]); // 20;
+```
+
+***
+
+### clear()
+
+```ts
+clear(): void;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:450](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L450)
+
+Removes all entries from the map.
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Remove all entries
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.clear();
+      console.log(mm.isEmpty()); // true;
+```
+
+***
+
+### clone()
+
+```ts
+clone(): TreeMultiMap<K, V, R>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4525](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4525)
+
+Deep copy
+
+ *
+
+#### Returns
+
+`TreeMultiMap`\<`K`, `V`, `R`\>
+
+#### Example
+
+```ts
+// Deep clone
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      const copy = mm.clone();
+      copy.delete(1);
+      console.log(mm.has(1)); // true;
+```
+
+***
+
+### count()
+
+```ts
+count(key): number;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:490](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L490)
+
+Bucket length for a key (missing => 0).
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`number`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Count values for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      console.log(mm.count(1)); // 2;
+```
+
+***
+
+### delete()
+
+```ts
+delete(key): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1569](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1569)
+
+Deletes a key and its entire bucket.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Remove key
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(2, 'b');
+      mm.delete(1);
+      console.log(mm.has(1)); // false;
+```
+
+***
+
+### deleteValue()
+
+```ts
+deleteValue(
+   key, 
+   value, 
+   eq?): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1653](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1653)
+
+Delete a single occurrence of a value from a key's bucket.
+
+#### Parameters
+
+##### key
+
+`K`
+
+##### value
+
+`V`
+
+##### eq?
+
+(`a`, `b`) => `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(log n + m), Space O(1) where m is bucket size
+
+ *
+
+#### Example
+
+```ts
+// Delete specific value
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      mm.deleteValue(1, 'a');
+      console.log(mm.get(1)); // ['b'];
+```
+
+***
+
+### deleteValues()
+
+```ts
+deleteValues(
+   key, 
+   value, 
+   eq?): number;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1701](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1701)
+
+Delete all occurrences of a value from a key's bucket.
+
+#### Parameters
+
+##### key
+
+`K`
+
+##### value
+
+`V`
+
+##### eq?
+
+(`a`, `b`) => `boolean`
+
+#### Returns
+
+`number`
+
+#### Remarks
+
+Time O(log n + m), Space O(1) where m is bucket size
+
+ *
+
+#### Example
+
+```ts
+// Delete all matching values
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      const count = mm.deleteValues(1, 'a');
+      console.log(count); // 2;
+```
+
+***
+
+### entriesOf()
+
+```ts
+entriesOf(key): IterableIterator<[K, V]>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2110](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2110)
+
+Iterates over all entries for a specific key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`IterableIterator`\<\[`K`, `V`\]\>
+
+#### Remarks
+
+Time O(log n + m), Space O(1) where m is bucket size
+
+ *
+
+#### Example
+
+```ts
+// Get entries for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      console.log([...mm.entriesOf(1)]); // [[1, 'a'], [1, 'b']];
+```
+
+***
+
+### filter()
+
+```ts
+filter(predicate): TreeMultiMap<K, V, R>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3619](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3619)
+
+Creates a new map with entries that pass the predicate.
+
+#### Parameters
+
+##### predicate
+
+(`value`, `key`, `map`) => `boolean`
+
+#### Returns
+
+`TreeMultiMap`\<`K`, `V`, `R`\>
+
+#### Remarks
+
+Time O(n), Space O(n)
+
+ *
+
+#### Example
+
+```ts
+// Filter entries
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(2, 'b');
+      mm.add(3, 'c');
+      const filtered = mm.filter((v, k) => k > 1);
+      console.log([...filtered.keys()]); // [2, 3];
+```
+
+***
+
+### first()
+
+```ts
+first(): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2275](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2275)
+
+Returns the entry with the smallest key.
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// First entry
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(3, 'c');
+      mm.add(1, 'a');
+      console.log(mm.first()?.[0]); // 1;
+```
+
+***
+
+### flatEntries()
+
+```ts
+flatEntries(): IterableIterator<[K, V]>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2195](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2195)
+
+Iterates over all [key, value] pairs (flattened from buckets).
+
+#### Returns
+
+`IterableIterator`\<\[`K`, `V`\]\>
+
+#### Remarks
+
+Time O(T), Space O(1) where T is totalSize
+
+ *
+
+#### Example
+
+```ts
+// All key-value pairs flattened
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      mm.add(2, 'c');
+      console.log([...mm.flatEntries()]); // [[1, 'a'], [1, 'b'], [2, 'c']];
+```
+
+***
+
+### floor()
+
+```ts
+floor(key): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2804](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2804)
+
+Returns the entry with the largest key <= given key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Greatest key ≤ target
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(10, 'a');
+      mm.add(20, 'b');
+      mm.add(30, 'c');
+      console.log(mm.floor(25)?.[0]); // 20;
+```
+
+***
+
+### forEach()
+
+```ts
+forEach(callback): void;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3443](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3443)
+
+Executes a callback for each entry.
+
+#### Parameters
+
+##### callback
+
+(`value`, `key`, `map`) => `void`
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+Time O(n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Iterate entries
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(2, 'b');
+      const keys: number[] = [];
+      mm.forEach((v, k) => keys.push(k));
+      console.log(keys); // [1, 2];
+```
+
+***
+
+### get()
+
+```ts
+get(key): V[] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:955](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L955)
+
+Live bucket reference (do not auto-delete key if bucket becomes empty via mutation).
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`V`[] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Get values for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      console.log(mm.get(1)); // ['a', 'b'];
+```
+
+***
+
+### getByRank()
+
+```ts
+getByRank(k): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4463](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4463)
+
+Creates a shallow clone of this map.
+
+#### Parameters
+
+##### k
+
+`number`
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(n log n), Space O(n)
+
+ *
+
+#### Example
+
+```ts
+// Order-statistic on BST
+ const tree = new TreeMultiMap<number>([30, 10, 50, 20, 40], { enableOrderStatistic: true });
+      console.log(tree.getByRank(0)); // 10;
+      console.log(tree.getByRank(4)); // 50;
+      console.log(tree.getRank(30)); // 2;
+```
+
+***
+
+### getRank()
+
+```ts
+getRank(key): number;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4482](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4482)
+
+Get the rank of a key in sorted order
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`number`
+
+#### Example
+
+```ts
+// Get the rank of a key in sorted order
+ const tree = new TreeMultiMap<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-multi-map.ts:744](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L744)
+
+Whether the map contains the given key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Check key existence
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      console.log(mm.has(1)); // true;
+      console.log(mm.has(2)); // false;
+```
+
+***
+
+### hasEntry()
+
+```ts
+hasEntry(
+   key, 
+   value, 
+   eq?): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1610](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1610)
+
+Check if a specific value exists in a key's bucket.
+
+#### Parameters
+
+##### key
+
+`K`
+
+##### value
+
+`V`
+
+##### eq?
+
+(`a`, `b`) => `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(log n + m), Space O(1) where m is bucket size
+
+ *
+
+#### Example
+
+```ts
+// Check specific key-value
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      console.log(mm.hasEntry(1, 'a')); // true;
+      console.log(mm.hasEntry(1, 'z')); // false;
+```
+
+***
+
+### higher()
+
+```ts
+higher(key): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2948](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2948)
+
+Returns the entry with the smallest key > given key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Least key > target
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(10, 'a');
+      mm.add(20, 'b');
+      console.log(mm.higher(10)?.[0]); // 20;
+```
+
+***
+
+### isEmpty()
+
+```ts
+isEmpty(): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:278](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L278)
+
+Whether the map is empty.
+
+#### Returns
+
+`boolean`
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Check if empty
+ console.log(new TreeMultiMap().isEmpty()); // true;
+```
+
+***
+
+### keys()
+
+```ts
+keys(): IterableIterator<K>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1896](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1896)
+
+Iterates over all keys.
+
+#### Returns
+
+`IterableIterator`\<`K`\>
+
+#### Remarks
+
+Time O(n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Iterate keys
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(3, 'c');
+      mm.add(1, 'a');
+      console.log([...mm.keys()]); // [1, 3];
+```
+
+***
+
+### last()
+
+```ts
+last(): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2354](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2354)
+
+Returns the entry with the largest key.
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Last entry
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(3, 'c');
+      console.log(mm.last()?.[0]); // 3;
+```
+
+***
+
+### lower()
+
+```ts
+lower(key): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3092](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3092)
+
+Returns the entry with the largest key < given key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Greatest key < target
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(10, 'a');
+      mm.add(20, 'b');
+      console.log(mm.lower(20)?.[0]); // 10;
+```
+
+***
+
+### map()
+
+```ts
+map<V2>(mapper): TreeMultiMap<K, V2, R>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3795](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3795)
+
+Creates a new map by transforming each entry.
+
+#### Type Parameters
+
+##### V2
+
+`V2`
+
+#### Parameters
+
+##### mapper
+
+(`value`, `key`, `map`) => \[`K`, `V2`[]\]
+
+#### Returns
+
+`TreeMultiMap`\<`K`, `V2`, `R`\>
+
+#### Remarks
+
+Time O(n log n), Space O(n)
+
+ *
+
+#### Example
+
+```ts
+// Transform values
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      const mapped = mm.map((v, k) => [k, v.map(s => s.toUpperCase())] as [number, string[]]);
+      console.log(mapped.get(1)); // ['A'];
+```
+
+***
+
+### pollFirst()
+
+```ts
+pollFirst(): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2400](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2400)
+
+Removes and returns the entry with the smallest key.
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Remove and return first
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(2, 'b');
+      mm.add(1, 'a');
+      const first = mm.pollFirst();
+      console.log(first?.[0]); // 1;
+      console.log(mm.has(1)); // false;
+```
+
+***
+
+### pollLast()
+
+```ts
+pollLast(): [K, V[]] | undefined;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2445](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2445)
+
+Removes and returns the entry with the largest key.
+
+#### Returns
+
+\[`K`, `V`[]\] \| `undefined`
+
+#### Remarks
+
+Time O(log n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Remove and return last
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(3, 'c');
+      const last = mm.pollLast();
+      console.log(last?.[0]); // 3;
+```
+
+***
+
+### print()
+
+```ts
+print(): void;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3269](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3269)
+
+Prints the internal tree structure (for debugging).
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+Time O(n), Space O(n)
+
+ *
+
+#### Example
+
+```ts
+// Display tree
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      expect(() => mm.print()).not.toThrow();
+```
+
+***
+
+### rangeByRank()
+
+```ts
+rangeByRank(start, end): [K, V[]][];
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4504](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4504)
+
+Get elements by rank range
+
+ *
+
+#### Parameters
+
+##### start
+
+`number`
+
+##### end
+
+`number`
+
+#### Returns
+
+\[`K`, `V`[]\][]
+
+#### Example
+
+```ts
+// Pagination with rangeByRank
+ const tree = new TreeMultiMap<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<C>(range, callback?): ReturnType<C>[];
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4288](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4288)
+
+Searches for entries within a key range.
+
+#### Type Parameters
+
+##### C
+
+`C` *extends* (`node`) => `unknown`
+
+#### Parameters
+
+##### range
+
+`Range`\<`K`\> \| \[`K`, `K`\]
+
+##### callback?
+
+`C`
+
+#### Returns
+
+`ReturnType`\<`C`\>[]
+
+#### Remarks
+
+Time O(log n + k), Space O(k) where k is result size
+
+ *
+
+#### Example
+
+```ts
+// Find keys in range
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(10, 'a');
+      mm.add(20, 'b');
+      mm.add(30, 'c');
+      const result = mm.rangeSearch([15, 25]);
+      console.log(result.length); // 1;
+```
+
+***
+
+### reduce()
+
+```ts
+reduce<U>(callback, initialValue): U;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3974](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L3974)
+
+Reduces all entries to a single value.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### callback
+
+(`accumulator`, `value`, `key`, `map`) => `U`
+
+##### initialValue
+
+`U`
+
+#### Returns
+
+`U`
+
+#### Remarks
+
+Time O(n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Aggregate
+ const mm = new TreeMultiMap<number, number>();
+      mm.add(1, 10);
+      mm.add(2, 20);
+      const sum = mm.reduce((acc, v) => acc + v.reduce((a, b) => a + b, 0), 0);
+      console.log(sum); // 30;
+```
+
+***
+
+### set()
+
+#### Call Signature
+
+```ts
+set(entry, value?): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1337](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1337)
+
+Alias for compatibility with existing TreeMultiMap semantics.
+
+##### Parameters
+
+###### entry
+
+  \| `K`
+  \| \[`K` \| `null` \| `undefined`, `V`[] \| `undefined`\]
+  \| `null`
+  \| `undefined`
+
+###### value?
+
+`V`
+
+##### Returns
+
+`boolean`
+
+##### Remarks
+
+Time O(log n), Space O(1) for single value; O(log n + m) for bucket append
+
+ *
+
+##### Example
+
+```ts
+// Set values for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.set(1, 'a');
+      mm.set(1, 'b');
+      console.log(mm.get(1)); // ['a', 'b'];
+```
+
+#### Call Signature
+
+```ts
+set(key, value): boolean;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1338](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L1338)
+
+Alias for compatibility with existing TreeMultiMap semantics.
+
+##### Parameters
+
+###### key
+
+`K`
+
+###### value
+
+`V`
+
+##### Returns
+
+`boolean`
+
+##### Remarks
+
+Time O(log n), Space O(1) for single value; O(log n + m) for bucket append
+
+ *
+
+##### Example
+
+```ts
+// Set values for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.set(1, 'a');
+      mm.set(1, 'b');
+      console.log(mm.get(1)); // ['a', 'b'];
+```
+
+***
+
+### setMany()
+
+```ts
+setMany(keysNodesEntriesOrRaws): boolean[];
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4141](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L4141)
+
+Sets multiple entries at once.
+
+#### Parameters
+
+##### keysNodesEntriesOrRaws
+
+`Iterable`\<`K` \| \[`K` \| `null` \| `undefined`, `V`[] \| `undefined`\]\>
+
+#### Returns
+
+`boolean`[]
+
+#### Remarks
+
+Time O(m log n), Space O(m) where m is input size
+
+ *
+
+#### Example
+
+```ts
+// Set multiple entries
+ const mm = new TreeMultiMap<number, string>();
+      mm.setMany([[1, ['a']], [2, ['b']]]);
+      console.log(mm.size); // 2;
+```
+
+***
+
+### values()
+
+```ts
+values(): IterableIterator<V[]>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2068](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2068)
+
+Iterates over all buckets.
+
+#### Returns
+
+`IterableIterator`\<`V`[]\>
+
+#### Remarks
+
+Time O(n), Space O(1)
+
+ *
+
+#### Example
+
+```ts
+// Iterate value arrays
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      console.log([...mm.values()]); // [['a', 'b']];
+```
+
+***
+
+### valuesOf()
+
+```ts
+valuesOf(key): IterableIterator<V>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2152](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/binary-tree/tree-multi-map.ts#L2152)
+
+Iterates over all values for a specific key.
+
+#### Parameters
+
+##### key
+
+`K`
+
+#### Returns
+
+`IterableIterator`\<`V`\>
+
+#### Remarks
+
+Time O(log n + m), Space O(1) where m is bucket size
+
+ *
+
+#### Example
+
+```ts
+// Get flat values for key
+ const mm = new TreeMultiMap<number, string>();
+      mm.add(1, 'a');
+      mm.add(1, 'b');
+      console.log([...mm.valuesOf(1)]); // ['a', 'b'];
+```