Class MathMap<K>`Alpha`

A DefaultMap with methods for performing basic math operations that mutate the data.

Type Parameters

Hierarchy (View Summary)

DefaultMap<K, V>
- MathMap

Index

Constructors

constructor

new MathMap<K>(
defaultValue: number,
entries?: Iterable<readonly [unknown, unknown], any, any> | null,
): MathMap<K>
Alpha
Create a new DefaultMap with a specified default value.

Time complexity: O(n)

Space complexity: O(n)
Type Parameters
- K
Parameters
- defaultValue: number
  The default value to use for missing keys
- Optionalentries: Iterable<readonly [unknown, unknown], any, any> | null
Returns MathMap<K>
Example
```
const map = new DefaultMap(0);
```
Inherited from DefaultMap.constructor
- Defined in src/map/default-map.ts:39
new MathMap<K>(
defaultValueFunction: (key: K) => number,
entries?: Iterable<readonly [unknown, unknown], any, any> | null,
): MathMap<K>
Alpha
Create a new DefaultMap with a specified function to generate default values.

Time complexity: O(n)

Space complexity: O(n)
Type Parameters
- K
Parameters
- defaultValueFunction: (key: K) => number
- Optionalentries: Iterable<readonly [unknown, unknown], any, any> | null
Returns MathMap<K>
Example
```
const map = new DefaultMap(key => key.toUpperCase());
```
Inherited from DefaultMap.constructor
- Defined in src/map/default-map.ts:54

Properties

`Readonly` `Alpha`[toStringTag]

"[toStringTag]": string

`Readonly` `Alpha`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` `Alpha`[species]

"[species]": MapConstructor

Methods

[iterator]

"[iterator]"(): MapIterator<[K, number]>
Alpha
Returns an iterable of entries in the map.

Returns MapIterator<[K, number]>
Inherited from DefaultMap.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

add

add(key: K, addend: number): number
Alpha
Add an addend to the value for a given key.
Parameters
- key: K
  The key to update the value of
- addend: number
  The value to add to the current value
Returns number
The updated value
Example
```
map.add('a', 1);
```
- Defined in src/map/math-map.ts:25

clear

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

delete

delete(key: K): boolean
Alpha
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 DefaultMap.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

divide

divide(key: K, divisor: number): number
Alpha
Divide the value for a given key by a divisor.
Parameters
- key: K
  The key to update the value of
- divisor: number
  The value to divide the current value by
Returns number
The updated value
Example
```
map.divide('a', 1);
```
- Defined in src/map/math-map.ts:88

entries

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

Returns MapIterator<[K, number]>
Inherited from DefaultMap.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

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

get

get(key: K): number
Alpha
Get the value for a given key, or the default value if it's missing.

Time complexity: O(1)

Space complexity: O(1)
Parameters
- key: K
  The key to get the value for
Returns number
The value for key, or the default value if it's missing
Example
```
map.get('a');
```
Inherited from DefaultMap.get
- Defined in src/map/default-map.ts:79

has

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

keys

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

Returns MapIterator<K>
Inherited from DefaultMap.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

multiply

multiply(key: K, multiplicand: number): number
Alpha
Multiply a multiplicand by the value for a given key.
Parameters
- key: K
  The key to update the value of
- multiplicand: number
  The value to multiply the current value by
Returns number
The updated value
Example
```
map.multiply('a', 1);
```
- Defined in src/map/math-map.ts:67

pow

pow(key: K, exponent: number): number
Alpha
Raise the value for a given key to an exponent.
Parameters
- key: K
  The key to update the value of
- exponent: number
  The exponent to raise the current value to
Returns number
The updated value
Example
```
map.pow('a', 2);
```
- Defined in src/map/math-map.ts:109

root

root(key: K, root: number): number
Alpha
Take the _n_th root of the value for a given key.
Parameters
- key: K
  The key to get the _n_th root of
- root: number
  The root to get
Returns number
The nth root of the value for key
Example
```
map.root('a', 2);
```
- Defined in src/map/math-map.ts:150

set

set(key: K, value: number): this
Alpha
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: number
Returns this
Inherited from DefaultMap.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

sqrt

sqrt(key: K): number
Alpha
Square root of the value for a given key.
Parameters
- key: K
  The key to get the square root of
Returns number
The square root of the value for key
Example
```
map.sqrt('a');
```
- Defined in src/map/math-map.ts:129

subtract

subtract(key: K, subtrahend: number): number
Alpha
Subtract a subtrahend from the value for a given key.
Parameters
- key: K
  The key to update the value of
- subtrahend: number
  The value to subtract from the current value
Returns number
The updated value
Example
```
map.subtract('a', 1);
```
- Defined in src/map/math-map.ts:46

values

values(): MapIterator<number>
Alpha
Returns an iterable of values in the map

Returns MapIterator<number>
Inherited from DefaultMap.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Alpha
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from DefaultMap.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class MathMap<K>Alpha

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MathMap<K>

Example

Type Parameters

Parameters

Returns MathMap<K>

Example

Properties

Readonly Alpha[toStringTag]

Readonly Alphasize

Returns

Static Readonly Alpha[species]

Methods

[iterator]

Returns MapIterator<[K, number]>

add

Parameters

Returns number

Example

clear

Returns void

delete

Parameters

Returns boolean

divide

Parameters

Returns number

Example

entries

Returns MapIterator<[K, number]>

forEach

Parameters

Returns void

get

Parameters

Returns number

Example

has

Parameters

Returns boolean

keys

Returns MapIterator<K>

multiply

Parameters

Returns number

Example

pow

Parameters

Returns number

Example

root

Parameters

Returns number

Example

set

Parameters

Returns this

sqrt

Parameters

Returns number

Example

subtract

Parameters

Returns number

Example

values

Returns MapIterator<number>

StaticgroupBy

Type Parameters

Parameters

Class MathMap<K>`Alpha`

`Readonly` `Alpha`[toStringTag]

`Readonly` `Alpha`size

`Static` `Readonly` `Alpha`[species]

`Static`groupBy