Class MultiMap<K, V>

Container that associates a key with multiple distinct values.

Type Parameters

K
V

Hierarchy (view full)

KeyMultiMap<K, V, K>
- MultiMap

Index

Constructors

Accessors

Methods

[iterator] add associations count list remove

Constructors

constructor

new MultiMap<K, V>(): MultiMap<K, V>
Type Parameters
- K
- V
Returns MultiMap<K, V>
Overrides KeyMultiMap.constructor
- Defined in pkg/util/src/key-map.ts:131

Accessors

dimension

get dimension(): number
Number of distinct keys.

Returns number
Inherited from KeyMultiMap.dimension
- Defined in pkg/util/src/key-map.ts:61

size

get size(): number
Number of values.

Returns number
Inherited from KeyMultiMap.size
- Defined in pkg/util/src/key-map.ts:64

Methods

[iterator]

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

Returns IterableIterator<[key: K, value: V]>
Inherited from KeyMultiMap.[iterator]
- Defined in pkg/util/src/key-map.ts:120

add

add(key, value): 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.
Inherited from KeyMultiMap.add
- Defined in pkg/util/src/key-map.ts:81

associations

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

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

count

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

list

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

remove

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

Generated using TypeDoc