Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided a value, returns an updated corrected sample standard deviation; otherwise, returns the current corrected sample standard deviation.

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

corrected sample standard deviation

Type declaration

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

    • Parameters

      • Optional x: undefined | number

      Returns number | null

Functions

Export assignment incrstdev

  • Returns an accumulator function which incrementally computes a corrected sample standard deviation.

    Parameters

    • Optional mu: undefined | number

      known mean

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrstdev();

var s = accumulator();
// returns null

s = accumulator( 2.0 );
// returns 0.0

s = accumulator( -5.0 );
// returns ~4.95

s = accumulator();
// returns ~4.95