Class TreeMultiSet<K, R>

Type Parameters

K = any
R = K

Implements

Iterable<K>

Index

Constructors

constructor

Accessors

comparator distinctSize size

Constructors

constructor

new TreeMultiSet<K, R>(elements?, options?): TreeMultiSet<K, R>
Creates a new TreeMultiSet.
Type Parameters
- K = any
- R = K
Parameters
- elements: Iterable<K, any, any> | Iterable<R, any, any> = []
  Initial elements to add, or raw elements if toElementFn is provided.
- options: TreeMultiSetOptions<K, R> = {}
  Configuration options including optional toElementFn to transform raw elements.
Returns TreeMultiSet<K, R>
Remarks
Time O(m log m), Space O(m) where m is the number of initial elements
Example
```
// Standard usage with elements
const mset = new TreeMultiSet([1, 2, 2, 3]);

// Using toElementFn to transform raw objects
const items = [{ score: 100 }, { score: 200 }, { score: 100 }];
const mset = new TreeMultiSet<number, Item>(items, { toElementFn: item => item.score });
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:33

Accessors

comparator

get comparator(): Comparator<K>
Expose comparator for advanced usage/testing (read-only).

Returns Comparator<K>
Remarks
Time O(1), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:249

distinctSize

get distinctSize(): number
Number of distinct keys.

Returns number
Remarks
Time O(1), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:87

size

get size(): number
Total occurrences (sumCounts).

Returns number
Remarks
Time O(1), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:79

Methods

[iterator]

[iterator](): Iterator<K, any, any>
Expanded iteration (default). Each key is yielded count(key) times.

Returns Iterator<K, any, any>
Remarks
Time O(size), Space O(1) where size is total occurrences
Implementation of Iterable.[iterator]
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:215

add

add(key, n?): boolean
Add n occurrences of key.
Parameters
- key: K
- n: number = 1
Returns boolean
True if the multiset changed.

Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:122

ceiling

ceiling(key): undefined | K
Returns the smallest key >= given key, or undefined.
Parameters
- key: K
Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([10, 20, 30]);
ms.ceiling(15);  // 20
ms.ceiling(20);  // 20
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:330

clear

clear(): void
Remove all elements from the multiset.

Returns void
Remarks
Time O(1), Space O(1)
Example
```
const ms = new TreeMultiSet([1, 2, 2, 3]);
ms.clear();
ms.size;  // 0
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:263

clone

clone(): TreeMultiSet<K, K>
Creates an independent copy of this multiset.

Returns TreeMultiSet<K, K>
Remarks
Time O(n log n), Space O(n)
Example
```
const ms = new TreeMultiSet([1, 1, 2]);
const copy = ms.clone();
copy.add(3);
ms.has(3);  // false (original unchanged)
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:464

count

count(key): number
Returns the count of occurrences for the given key.
Parameters
- key: K
Returns number
Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:112

delete

delete(key, n?): boolean
Delete n occurrences of key (default 1).
Parameters
- key: K
- n: number = 1
Returns boolean
True if any occurrence was removed.

Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:161

deleteAll

deleteAll(key): boolean
Delete all occurrences of the given key.
Parameters
- key: K
Returns boolean
True if any occurrence was removed.

Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:184

entries

entries(): IterableIterator<[K, number], any, any>
Iterates over entries as [key, count] pairs.

Returns IterableIterator<[K, number], any, any>
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:205

filter

filter(predicate): TreeMultiSet<K, K>
Creates a new TreeMultiSet with entries that match the predicate.
Parameters
- predicate: ((key: K, count: number) => boolean)
  - - (key, count): boolean
    - Parameters
      key: K
      count: number
      Returns boolean
Returns TreeMultiSet<K, K>
Remarks
Time O(n log n), Space O(n)
Example
```
const ms = new TreeMultiSet([1, 1, 2, 3, 3, 3]);
const filtered = ms.filter((key, count) => count >= 2);
// TreeMultiSet { 1: 2, 3: 3 }
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:398

first

first(): undefined | K
Returns the smallest key, or undefined if empty.

Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([3, 1, 4]);
ms.first();  // 1
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:277

floor

floor(key): undefined | K
Returns the largest key <= given key, or undefined.
Parameters
- key: K
Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([10, 20, 30]);
ms.floor(25);  // 20
ms.floor(20);  // 20
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:343

forEach

forEach(callback): void
Iterates over distinct keys with their counts.
Parameters
- callback: ((key: K, count: number) => void)
  - - (key, count): void
    - Parameters
      key: K
      count: number
      Returns void
Returns void
Remarks
Time O(n), Space O(1)
Example
```
const ms = new TreeMultiSet([1, 1, 2, 3, 3, 3]);
ms.forEach((key, count) => console.log(`${key}: ${count}`));
// 1: 2, 2: 1, 3: 3
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:384

has

has(key): boolean
Whether the multiset contains the given key.
Parameters
- key: K
Returns boolean
Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:103

higher

higher(key): undefined | K
Returns the smallest key > given key, or undefined.
Parameters
- key: K
Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([10, 20, 30]);
ms.higher(10);  // 20
ms.higher(15);  // 20
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:356

isEmpty

isEmpty(): boolean
Whether the multiset is empty.

Returns boolean
Remarks
Time O(1), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:95

keysDistinct

keysDistinct(): IterableIterator<K, any, any>
Iterates over distinct keys (each key yielded once).

Returns IterableIterator<K, any, any>
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:197

last

last(): undefined | K
Returns the largest key, or undefined if empty.

Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([3, 1, 4]);
ms.last();  // 4
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:288

lower

lower(key): undefined | K
Returns the largest key < given key, or undefined.
Parameters
- key: K
Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([10, 20, 30]);
ms.lower(20);  // 10
ms.lower(15);  // 10
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:369

map

map<K2>(mapper, options?): TreeMultiSet<K2, K2>
Maps keys and counts to a new TreeMultiSet. When multiple keys map to the same new key, counts are merged (added).
Type Parameters
- K2
Parameters
- mapper: ((key: K, count: number) => [K2, number])
  - - (key, count): [K2, number]
    - Parameters
      key: K
      count: number
      Returns [K2, number]
- Optionaloptions: {
  comparator?: Comparator<K2>;
  }
  - Optionalcomparator?: Comparator<K2>
Returns TreeMultiSet<K2, K2>
Remarks
Time O(n log n), Space O(n)
Example
```
const ms = new TreeMultiSet([1, 1, 2, 3, 3, 3]);
const mapped = ms.map((key, count) => [key * 10, count]);
// TreeMultiSet { 10: 2, 20: 1, 30: 3 }
```
Example
```
// Collision: counts merge
const ms = new TreeMultiSet([1, 2, 3]);
const merged = ms.map((key, count) => [key % 2, count]);
// { 0: 1, 1: 2 }  (1 and 3 both map to 1, counts add)
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:440

pollFirst

pollFirst(): undefined | K
Removes all occurrences of the smallest key and returns it.

Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([1, 1, 2, 3]);
ms.pollFirst();  // 1
ms.has(1);       // false
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:300

pollLast

pollLast(): undefined | K
Removes all occurrences of the largest key and returns it.

Returns undefined | K
Remarks
Time O(log n), Space O(1)
Example
```
const ms = new TreeMultiSet([1, 2, 3, 3]);
ms.pollLast();  // 3
ms.has(3);      // false
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:315

print

print(): void
Prints the internal tree structure (for debugging).

Returns void
Remarks
Time O(n), Space O(n)
Example
```
const ms = new TreeMultiSet([1, 2, 3]);
ms.print();
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:499

rangeSearch

rangeSearch<C>(range, callback?): (C extends undefined
? K
: ReturnType<C>)[]
Returns keys within the given range.
Type Parameters
- C extends ((key: K) => any)
Parameters
- range: [K, K]
- Optionalcallback: C
Returns (C extends undefined
? K
: ReturnType<C>)[]
Remarks
Time O(log n + k), Space O(k) where k is result size
Example
```
const ms = new TreeMultiSet([10, 20, 30, 40, 50]);
ms.rangeSearch([15, 45]);  // [20, 30, 40]
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:484

reduce

reduce<U>(callback, initialValue): U
Reduces the multiset to a single value.
Type Parameters
- U
Parameters
- callback: ((accumulator: U, key: K, count: number) => U)
  - - (accumulator, key, count): U
    - Parameters
      accumulator: U
      key: K
      count: number
      Returns U
- initialValue: U
Returns U
Remarks
Time O(n), Space O(1)
Example
```
const ms = new TreeMultiSet([1, 1, 2, 3, 3, 3]);
const total = ms.reduce((acc, key, count) => acc + count, 0);  // 6
```
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:418

setCount

setCount(key, n): boolean
Set count for key to exactly n.
Parameters
- key: K
- n: number
Returns boolean
True if changed.

Remarks
Time O(log n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:139

toArray

toArray(): K[]
Returns an array with all elements (expanded).

Returns K[]
Remarks
Time O(size), Space O(size)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:225

toDistinctArray

toDistinctArray(): K[]
Returns an array with distinct keys only.

Returns K[]
Remarks
Time O(n), Space O(n)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:233

toEntries

toEntries(): [K, number][]
Returns an array of [key, count] entries.

Returns [K, number][]
Remarks
Time O(n), Space O(n)
- Defined in src/data-structures/binary-tree/tree-multi-set.ts:241

Class TreeMultiSet<K, R>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TreeMultiSet<K, R>

Remarks

Example

Accessors

comparator

Returns Comparator<K>

Remarks

distinctSize

Returns number

Remarks

size

Returns number

Remarks

Methods

[iterator]

Returns Iterator<K, any, any>

Remarks

add

Parameters

Returns boolean

Remarks

ceiling

Parameters

Returns undefined | K

Remarks

Example

clear

Returns void

Remarks

Example

clone

Returns TreeMultiSet<K, K>

Remarks

Example

count

Parameters

Returns number

Remarks

delete

Parameters

Returns boolean

Remarks

deleteAll

Parameters

Returns boolean

Remarks

entries

Returns IterableIterator<[K, number], any, any>

Remarks

filter

Parameters

Parameters

Returns boolean

Returns TreeMultiSet<K, K>

Remarks

Example

first

Returns undefined | K

Remarks

Example

floor

Parameters

Returns undefined | K

Remarks

Example

forEach

Parameters

Parameters

Returns void

`Optional`comparator?: Comparator<K2>

Returns (C extends undefined
? K
: ReturnType<C>)[]