Class KeyMultiSet<K, I, L>

MultiSet that transforms keys.

K: input key type. I: indexable key type. L: lookup key type.

Type Parameters

K
I
L = K

Hierarchy

KeyMultiSet

Index

Constructors

Accessors

Methods

add count multiplicities remove

Constructors

constructor

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

Accessors

dimension

get dimension(): number
Number of distinct keys.

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

size

get size(): number
Number of values.

Returns number
- Defined in packages/util/src/key-map.ts:161

Methods

add

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

count

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

multiplicities

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

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

remove

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

Generated using TypeDoc