Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided a value, returns an updated arithmetic mean; otherwise, returns the current arithmetic mean.

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

arithmetic mean of squared absolute values

Type declaration

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

    • Parameters

      • Optional x: undefined | number

      Returns number | null

Functions

Export assignment incrmmeanabs2

  • Returns an accumulator function which incrementally computes a moving arithmetic mean of squared absolute values.

    Notes
    • The W parameter defines the number of values over which to compute the moving mean.
    • 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

    must provide a positive integer

    Parameters

    • W: number

      window size

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmmeanabs2( 3 );

var m = accumulator();
// returns null

m = accumulator( 2.0 );
// returns 4.0

m = accumulator( -5.0 );
// returns 14.5

m = accumulator( 3.0 );
// returns ~12.67

m = accumulator( 5.0 );
// returns ~19.67

m = accumulator();
// returns ~19.67