Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/incr/vmr/docs/types/index.d"

Index

Type aliases

Functions

Type aliases

accumulator

accumulator: (x?: undefined | number) => number | null

If provided a value, the accumulator function returns an updated accumulated value. If not provided a value, the accumulator function returns the current accumulated value.

Notes
  • If provided NaN or a value which, when used in computations, results in NaN, the accumulated value is NaN for all future invocations.
param

value

returns

accumulated value or null

Type declaration

    • (x?: undefined | number): number | null

    • Parameters

      • Optional x: undefined | number

      Returns number | null

Functions

Export assignment incrvmr

  • Returns an accumulator function which incrementally computes a variance-to-mean ratio (VMR).

    Parameters

    • Optional mean: undefined | number

      mean value

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrvmr();

var D = accumulator();
// returns null

D = accumulator( 2.0 );
// returns 0.0

D = accumulator( 1.0 );
// returns ~0.33

D = accumulator();
// returns ~0.33

    Example

    var accumulator = incrvmr( 3.14 );