Class KeyMultiMap<K, V, I, L>

MultiMap that transforms keys.

Type Parameters

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

Hierarchy (View Summary)

KeyMultiMap
- MultiMap
- NameMultiMap

Implements

Iterable<[key: K, value: V]>

Index

Constructors

Accessors

Methods

[iterator] add associations count list remove

Constructors

constructor

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

Accessors

dimension

get dimension(): number
Number of distinct keys.

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

size

get size(): number
Number of values.

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

Methods

[iterator]

"[iterator]"(): IterableIterator<[key: K, value: V], any, any>
Iterate over key-value pairs.

Returns IterableIterator<[key: K, value: V], any, any>
Implementation of Iterable.[iterator]
- Defined in pkg/util/src/key-map.ts:120

add

add(key: K, value: V): number
Add a key-value pair. Values are stored in a Set, so duplicates are skipped.
Parameters
- key: K
- value: V
Returns number
count(key) after the operation.
- Defined in pkg/util/src/key-map.ts:81

associations

associations(): IterableIterator<[key: K, values: ReadonlySet<V>], any, any>
Iterate over key and associated values.

Returns IterableIterator<[key: K, values: ReadonlySet<V>], any, any>
- Defined in pkg/util/src/key-map.ts:115

count

count(key: K | L): number
Count values associated with a key.
Parameters
- key: K | L
Returns number
- Defined in pkg/util/src/key-map.ts:67

list

list(key: K | L): ReadonlySet<V>
List values associated with a key.
Parameters
- key: K | L
Returns ReadonlySet<V>
- Defined in pkg/util/src/key-map.ts:72

remove

remove(key: K | L, value: V): number
Remove a key-value pair. No-op if key-value does not exist.
Parameters
- key: K | L
- value: V
Returns number
count(key) after the operation.
- Defined in pkg/util/src/key-map.ts:99