data-structure-typed 2.5.3 → 2.6.1

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

@@ -103,7 +103,7 @@ const mmap = new TreeMultiMap(players, { toEntryFn: p => [p.score, p.items] });
 get comparator(): Comparator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:5021](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5021)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5413](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5413)
 
 Expose comparator for advanced usage/testing (read-only).
 
@@ -147,7 +147,7 @@ Time O(1), Space O(1)
 get totalSize(): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:580](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L580)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:616](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L616)
 
 Total number of values across all buckets (Σ bucket.length).
 
@@ -180,7 +180,7 @@ Time O(n), Space O(1)
 iterator: Iterator<[K, V[]]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1897](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1897)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2029](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2029)
 
 Iterates over all entries as [key, bucket] pairs.
 
@@ -206,7 +206,7 @@ Iterable.[iterator]
 add(key, value): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1239](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1239)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1326](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1326)
 
 Append a single value.
 
@@ -249,7 +249,7 @@ Time O(log n), Space O(1)
 ceiling(key): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2896](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2896)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3126](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3126)
 
 Returns the entry with the smallest key >= given key.
 
@@ -288,7 +288,7 @@ Time O(log n), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:490](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L490)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:520](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L520)
 
 Removes all entries from the map.
 
@@ -320,7 +320,7 @@ Time O(1), Space O(1)
 clone(): TreeMultiMap<K, V, R>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:5013](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5013)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5405](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5405)
 
 Deep copy
 
@@ -349,7 +349,7 @@ Deep copy
 count(key): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:534](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L534)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:567](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L567)
 
 Bucket length for a key (missing => 0).
 
@@ -387,7 +387,7 @@ Time O(log n), Space O(1)
 delete(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1733](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1733)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1856](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1856)
 
 Deletes a key and its entire bucket.
 
@@ -429,7 +429,7 @@ deleteValue(
    eq?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1825](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1825)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1954](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1954)
 
 Delete a single occurrence of a value from a key's bucket.
 
@@ -479,7 +479,7 @@ deleteValues(
    eq?): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1877](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1877)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2009](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2009)
 
 Delete all occurrences of a value from a key's bucket.
 
@@ -521,13 +521,49 @@ Time O(log n + m), Space O(1) where m is bucket size
 
 ***
 
+### entries()
+
+```ts
+entries(): IterableIterator<[K, V[]]>;
+```
+
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2472](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2472)
+
+Iterate over all `[key, values[]]` entries (Map-compatible).
+
+#### Returns
+
+`IterableIterator`\<\[`K`, `V`[]\]\>
+
+#### Remarks
+
+Time O(n), Space O(1) per step.
+
+ *
+
+#### Example
+
+```ts
+// Iterate over entries
+ const mm = new TreeMultiMap<number, string>();
+    mm.set(1, 'a');
+    mm.set(1, 'b');
+    mm.set(2, 'c');
+    console.log([...mm.entries()]); // [
+ //      [1, ['a', 'b']],
+ //      [2, ['c']]
+ //    ];
+```
+
+***
+
 ### entriesOf()
 
 ```ts
 entriesOf(key): IterableIterator<[K, V]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2330](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2330)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2521](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2521)
 
 Iterates over all entries for a specific key.
 
@@ -565,7 +601,7 @@ Time O(log n + m), Space O(1) where m is bucket size
 filter(predicate): TreeMultiMap<K, V, R>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4003](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4003)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4317](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4317)
 
 Creates a new map with entries that pass the predicate.
 
@@ -605,7 +641,7 @@ Time O(n), Space O(n)
 first(): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2511](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2511)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2714](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2714)
 
 Returns the entry with the smallest key.
 
@@ -637,7 +673,7 @@ Time O(log n), Space O(1)
 flatEntries(): IterableIterator<[K, V]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2423](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2423)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2620](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2620)
 
 Iterates over all [key, value] pairs (flattened from buckets).
 
@@ -670,7 +706,7 @@ Time O(T), Space O(1) where T is totalSize
 floor(key): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:3096](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3096)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3341](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3341)
 
 Returns the entry with the largest key <= given key.
 
@@ -709,7 +745,7 @@ Time O(log n), Space O(1)
 forEach(callback): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:3807](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3807)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4106](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4106)
 
 Executes a callback for each entry.
 
@@ -749,7 +785,7 @@ Time O(n), Space O(1)
 get(key): V[] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1051](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1051)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1123](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1123)
 
 Live bucket reference (do not auto-delete key if bucket becomes empty via mutation).
 
@@ -787,7 +823,7 @@ Time O(log n), Space O(1)
 getByRank(k): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4923](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4923)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5294](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5294)
 
 Creates a shallow clone of this map.
 
@@ -825,7 +861,7 @@ Time O(n log n), Space O(n)
 getRank(key): number;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4942](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4942)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5313](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5313)
 
 Get the rank of a key in sorted order
 
@@ -861,7 +897,7 @@ Get the rank of a key in sorted order
 has(key): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:816](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L816)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:870](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L870)
 
 Whether the map contains the given key.
 
@@ -902,7 +938,7 @@ hasEntry(
    eq?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1778](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1778)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1904](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1904)
 
 Check if a specific value exists in a key's bucket.
 
@@ -948,7 +984,7 @@ Time O(log n + m), Space O(1) where m is bucket size
 higher(key): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:3256](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3256)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3513](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3513)
 
 Returns the entry with the smallest key > given key.
 
@@ -986,7 +1022,7 @@ Time O(log n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:298](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L298)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:313](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L313)
 
 Whether the map is empty.
 
@@ -1015,7 +1051,7 @@ Time O(1), Space O(1)
 keys(): IterableIterator<K>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2092](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2092)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2239](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2239)
 
 Iterates over all keys.
 
@@ -1047,7 +1083,7 @@ Time O(n), Space O(1)
 last(): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2598](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2598)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2807](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2807)
 
 Returns the entry with the largest key.
 
@@ -1079,7 +1115,7 @@ Time O(log n), Space O(1)
 lower(key): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:3416](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3416)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3685](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3685)
 
 Returns the entry with the largest key < given key.
 
@@ -1117,7 +1153,7 @@ Time O(log n), Space O(1)
 map<V2>(mapper): TreeMultiMap<K, V2, R>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4199](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4199)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4528](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4528)
 
 Creates a new map by transforming each entry.
 
@@ -1161,7 +1197,7 @@ Time O(n log n), Space O(n)
 pollFirst(): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2648](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2648)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2860](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2860)
 
 Removes and returns the entry with the smallest key.
 
@@ -1195,7 +1231,7 @@ Time O(log n), Space O(1)
 pollLast(): [K, V[]] | undefined;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2697](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2697)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2912](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2912)
 
 Removes and returns the entry with the largest key.
 
@@ -1228,7 +1264,7 @@ Time O(log n), Space O(1)
 print(): void;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:3613](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3613)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:3897](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L3897)
 
 Prints the internal tree structure (for debugging).
 
@@ -1259,7 +1295,7 @@ Time O(n), Space O(n)
 rangeByRank(start, end): [K, V[]][];
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4972](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4972)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5349](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5349)
 
 Get elements by rank range
 
@@ -1305,7 +1341,7 @@ Get elements by rank range
 rangeSearch<C>(range, callback?): ReturnType<C>[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4748](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4748)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:5119](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L5119)
 
 Searches for entries within a key range.
 
@@ -1355,7 +1391,7 @@ Time O(log n + k), Space O(k) where k is result size
 reduce<U>(callback, initialValue): U;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4398](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4398)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4742](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4742)
 
 Reduces all entries to a single value.
 
@@ -1406,7 +1442,7 @@ Time O(n), Space O(1)
 set(entry, value?): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1477](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1477)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1582](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1582)
 
 Alias for compatibility with existing TreeMultiMap semantics.
 
@@ -1449,7 +1485,7 @@ Time O(log n), Space O(1) for single value; O(log n + m) for bucket append
 set(key, value): boolean;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:1478](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1478)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:1583](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L1583)
 
 Alias for compatibility with existing TreeMultiMap semantics.
 
@@ -1491,7 +1527,7 @@ Time O(log n), Space O(1) for single value; O(log n + m) for bucket append
 setMany(keysNodesEntriesOrRaws): boolean[];
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:4585](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4585)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:4944](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L4944)
 
 Sets multiple entries at once.
 
@@ -1528,7 +1564,7 @@ Time O(m log n), Space O(m) where m is input size
 values(): IterableIterator<V[]>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2284)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2446](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2446)
 
 Iterates over all buckets.
 
@@ -1560,7 +1596,7 @@ Time O(n), Space O(1)
 valuesOf(key): IterableIterator<V>;
 ```
 
-Defined in: [data-structures/binary-tree/tree-multi-map.ts:2376](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2376)
+Defined in: [data-structures/binary-tree/tree-multi-map.ts:2570](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/binary-tree/tree-multi-map.ts#L2570)
 
 Iterates over all values for a specific key.