Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided input values, the accumulator function returns an updated mean error. If not provided input values, the accumulator function returns the current mean error.

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

input value

param

input value

returns

mean error or null

Type declaration

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

    • Parameters

      • Optional x: undefined | number
      • Optional y: undefined | number

      Returns number | null

Functions

Export assignment incrmme

  • Returns an accumulator function which incrementally computes a moving mean error.

    Notes
    • The W parameter defines the number of values over which to compute the moving mean error.
    • 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 = incrmme( 3 );

var m = accumulator();
// returns null

m = accumulator( 2.0, 3.0 );
// returns 1.0

m = accumulator( -5.0, 2.0 );
// returns 4.0

m = accumulator( 3.0, 2.0 );
// returns ~2.33

m = accumulator( 5.0, -2.0 );
// returns ~-0.33

m = accumulator();
// returns ~-0.33