Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

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

Notes
  • If provided NaN, the arithmetic mean and corrected sample standard deviation values are equal to NaN for all future invocations.
param

input value

returns

output array or null

Type declaration

    • (x?: undefined | number): ArrayLike<number> | null

    • Parameters

      • Optional x: undefined | number

      Returns ArrayLike < number > | null

Functions

Export assignment incrmeanstdev

  • Returns an accumulator function which incrementally computes an arithmetic mean and corrected sample standard deviation.

    Parameters

    • Optional out: ArrayLike<number>

      output array

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmeanstdev();

var ms = accumulator();
// returns null

ms = accumulator( 2.0 );
// returns [ 2.0, 0.0 ]

ms = accumulator( -5.0 );
// returns [ -1.5, ~4.95 ]

ms = accumulator( 3.0 );
// returns [ 0.0, ~4.36 ]

ms = accumulator( 5.0 );
// returns [ 1.25, ~4.35 ]

ms = accumulator();
// returns [ 1.25, ~4.35 ]