Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/incr/mcv/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 incrmcv

  • incrmcv(W: number, mean?: undefined | number): accumulator

  • Returns an accumulator function which incrementally computes a moving coefficient of variation (CV).

    Notes
    • The W parameter defines the number of values over which to compute the moving coefficient of variation.
    • As W values are needed to fill the window buffer, the first W-1 returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
    throws

    first argument must be a positive integer

    Parameters

    • W: number

      window size

    • Optional mean: undefined | number

      mean value

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmcv( 3 );

var cv = accumulator();
// returns null

cv = accumulator( 2.0 );
// returns 0.0

cv = accumulator( 1.0 );
// returns ~0.47

cv = accumulator( 3.0 );
// returns 0.5

cv = accumulator( 7.0 );
// returns ~0.83

cv = accumulator();
// returns ~0.83

    Example

    var accumulator = incrmcv( 3, 2.0 );