Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MathMap<K>

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

alpha

Type Parameters

  • K

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MathMap<K>(defaultValue: number, entries?: null | Iterable<readonly [unknown, unknown]>): MathMap<K>
  • new MathMap<K>(defaultValueFn: ((key: K) => number), entries?: null | Iterable<readonly [unknown, unknown]>): MathMap<K>

  • Create a new DefaultMap with a specified default value.

    Time complexity: O(n)

    Space complexity: O(n)

    example
    const map = new DefaultMap(0);

    Type Parameters

    • K

    Parameters

    • defaultValue: number

      The default value to use for missing keys

    • Optional entries: null | Iterable<readonly [unknown, unknown]>

    Returns MathMap<K>

  • Create a new DefaultMap with a specified function to generate default values.

    Time complexity: O(n)

    Space complexity: O(n)

    example
    const map = new DefaultMap(key => key.toUpperCase());

    Type Parameters

    • K

    Parameters

    • defaultValueFn: ((key: K) => number)

      The function to generate default values

        • (key: K): number

        • Parameters

          • key: K

          Returns number

    • Optional entries: null | Iterable<readonly [unknown, unknown]>

    Returns MathMap<K>

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

  • [iterator](): IterableIterator<[K, number]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[K, number]>

add

  • add(key: K, addend: number): number

  • Add an addend to the value for a given key.

    example
    map.add('a', 1);

    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

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

divide

  • divide(key: K, divisor: number): number

  • Divide the value for a given key by a divisor.

    example
    map.divide('a', 1);

    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

entries

  • entries(): IterableIterator<[K, number]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[K, number]>

forEach

  • forEach(callbackfn: ((value: number, key: K, map: Map<K, number>) => void), thisArg?: any): void

  • Parameters

    • callbackfn: ((value: number, key: K, map: Map<K, number>) => void)
        • (value: number, key: K, map: Map<K, number>): void

        • Parameters

          • value: number
          • key: K
          • map: Map<K, number>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: K): number

  • Get the value for a given key, or the default value if it's missing.

    Time complexity: O(1)

    Space complexity: O(1)

    example
    map.get('a');

    Parameters

    • key: K

      The key to get the value for

    Returns number

    The value for key, or the default value if it's missing

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

keys

  • keys(): IterableIterator<K>

  • Returns an iterable of keys in the map

    Returns IterableIterator<K>

multiply

  • multiply(key: K, multiplicand: number): number

  • Multiply a multiplicand by the value for a given key.

    example
    map.multiply('a', 1);

    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

pow

  • pow(key: K, exponent: number): number

  • Raise the value for a given key to an exponent.

    example
    map.pow('a', 2);

    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

root

  • root(key: K, root: number): number

  • Take the _n_th root of the value for a given key.

    example
    map.root('a', 2);

    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

set

  • set(key: K, value: number): MathMap<K>

  • Parameters

    • key: K
    • value: number

    Returns MathMap<K>

sqrt

  • sqrt(key: K): number

  • Square root of the value for a given key.

    example
    map.sqrt('a');

    Parameters

    • key: K

      The key to get the square root of

    Returns number

    The square root of the value for key

subtract

  • subtract(key: K, subtrahend: number): number

  • Subtract a subtrahend from the value for a given key.

    example
    map.subtract('a', 1);

    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

values

  • values(): IterableIterator<number>

  • Returns an iterable of values in the map

    Returns IterableIterator<number>

Generated using TypeDoc