Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided a value, returns an updated geometric mean; otherwise, returns the current geometric 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.
  • If provided a negative value, the accumulated value is NaN for all future invocations.
param

value

returns

geometric mean

Type declaration

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

    • Parameters

      • Optional x: undefined | number

      Returns number | null

Functions

Export assignment incrmgmean

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

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

var v = accumulator();
// returns null

v = accumulator( 2.0 );
// returns 2.0

v = accumulator( 5.0 );
// returns ~3.16

v = accumulator( 3.0 );
// returns ~3.11

v = accumulator( 5.0 );
// returns ~4.22

v = accumulator();
// returns ~4.22