Interface ReducedMap<K, V, U>

An [[OrderedMap]] that memoizes partial combinations of sub-elements to support efficient, incremental reduction of continuously mutating datasets.

Type Parameters

Hierarchy

OrderedMap<K, V>
- ReducedMap

Index

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of elements in the Map.

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>
Inherited from OrderedMap.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from OrderedMap.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:21

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from OrderedMap.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25

entries

entries(): IterableIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>
Inherited from OrderedMap.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

firstEntry

firstEntry(): [K, V]
Returns [K, V]
Inherited from OrderedMap.firstEntry
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:6

firstKey

firstKey(): K
Returns K
Inherited from OrderedMap.firstKey
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:4

firstValue

firstValue(): V
Returns V
Inherited from OrderedMap.firstValue
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:5

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      
      value: V
      
      key: K
      
      map: Map<K, V>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from OrderedMap.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key): V
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from OrderedMap.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:34

getEntry

getEntry(index): [K, V]
Parameters
- index: number
Returns [K, V]
Inherited from OrderedMap.getEntry
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:3

has

has(key): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from OrderedMap.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

keys(): IterableIterator<K>
Returns an iterable of keys in the map

Returns IterableIterator<K>
Inherited from OrderedMap.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

lastEntry

lastEntry(): [K, V]
Returns [K, V]
Inherited from OrderedMap.lastEntry
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:9

lastKey

lastKey(): K
Returns K
Inherited from OrderedMap.lastKey
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:7

lastValue

lastValue(): V
Returns V
Inherited from OrderedMap.lastValue
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:8

nextEntry(key): [K, V]
Parameters
- key: K
Returns [K, V]
Inherited from OrderedMap.nextEntry
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:12

nextKey

nextKey(key): K
Parameters
- key: K
Returns K
Inherited from OrderedMap.nextKey
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:10

nextValue

nextValue(key): V
Parameters
- key: K
Returns V
Inherited from OrderedMap.nextValue
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:11

previousEntry(key): [K, V]
Parameters
- key: K
Returns [K, V]
Inherited from OrderedMap.previousEntry
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:15

previousKey

previousKey(key): K
Parameters
- key: K
Returns K
Inherited from OrderedMap.previousKey
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:13

previousValue

previousValue(key): V
Parameters
- key: K
Returns V
Inherited from OrderedMap.previousValue
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:14

reduced

reduced(identity, accumulator, combiner): U
Returns the reduction of this ReducedMap, combining all contained elements with the given accumulator and combiner functions, recomputing only what has changed since the last invocation of reduced. Stores partial computations to accelerate repeated reduction of continuously mutating datasets.
Parameters
- identity: U
- accumulator: ((result, element) => U)
  - - (result, element): U
    - Parameters
      
      result: U
      
      element: V
      
      Returns U
- combiner: ((result, result2) => U)
  - - (result, result2): U
    - Parameters
      
      result: U
      
      result2: U
      
      Returns U
Returns U
- Defined in swim-core/swim-util/lib/main/OrderedMap.d.ts:30

set

set(key, value): ReducedMap<K, V, U>
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: K
- value: V
Returns ReducedMap<K, V, U>
Inherited from OrderedMap.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:42

values

values(): IterableIterator<V>
Returns an iterable of values in the map

Returns IterableIterator<V>
Inherited from OrderedMap.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Interface ReducedMap<K, V, U>

Type Parameters

K

V

U

Hierarchy

Index

Properties

Methods

Properties

Readonly [toStringTag]

Readonly size

Returns

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

key: K

Returns boolean

entries

Returns IterableIterator<[K, V]>

firstEntry

Returns [K, V]

firstKey

Returns K

firstValue

Returns V

forEach

Parameters

callbackfn: ((value, key, map) => void)

Parameters

value: V

key: K

map: Map<K, V>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: K

Returns V

getEntry

Parameters

index: number

Returns [K, V]

has

Parameters

key: K

Returns boolean

keys

Returns IterableIterator<K>

lastEntry

Returns [K, V]

lastKey

Returns K

lastValue

Returns V

nextEntry

Parameters

key: K

Returns [K, V]

nextKey

Parameters

key: K

Returns K

nextValue

Parameters

key: K

Returns V

previousEntry

Parameters

key: K

Returns [K, V]

previousKey

Parameters

key: K

Returns K

`Readonly` [toStringTag]

`Readonly` size

`Optional` thisArg: any