Class KeyMultiSet<K, I, L>

MultiSet that transforms keys.

Type Parameters

K
Input key type.
I
Indexable key type.
L = K
Lookup key type.

Hierarchy (View Summary)

KeyMultiSet
- NameMultiSet

Index

Constructors

Accessors

Methods

add count multiplicities remove

Constructors

constructor

new KeyMultiSet<K, I, L = K>(keyOf: (key: K | L) => I): KeyMultiSet<I, L>
Constructor.
Type Parameters
- K
- I
- L = K
Parameters
- keyOf: (key: K | L) => I
  Function to transform input key to indexable key.
Returns KeyMultiSet<I, L>
- Defined in pkg/util/src/key-map.ts:147

Accessors

dimension

get dimension(): number
Number of distinct keys.

Returns number
- Defined in pkg/util/src/key-map.ts:155

size

get size(): number
Number of values.

Returns number
- Defined in pkg/util/src/key-map.ts:158

Methods

add

add(key: K): number
Add a key.
Parameters
- key: K
Returns number
Number of occurrences after the operation.
- Defined in pkg/util/src/key-map.ts:169

count

count(key: K | L): number
Count occurrences of a key.
Parameters
- key: K | L
Returns number
- Defined in pkg/util/src/key-map.ts:161

multiplicities

multiplicities(): IterableIterator<[key: K, count: number]>
Iterate over key and number of occurrences.

Returns IterableIterator<[key: K, count: number]>
- Defined in pkg/util/src/key-map.ts:198

remove

remove(key: K): number
Remove a key. No-op if key does not exist.
Parameters
- key: K
Returns number
Number of occurrences after the operation.
- Defined in pkg/util/src/key-map.ts:181