Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

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

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

minimum value

Type declaration

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

    • Parameters

      • Optional x: undefined | number

      Returns number | null

Functions

Export assignment incrmin

  • Returns an accumulator function which incrementally computes a minimum value.

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmin();

var v = accumulator();
// returns null

v = accumulator( 2.0 );
// returns 2.0

v = accumulator( -3.0 );
// returns -3.0

v = accumulator( 4.0 );
// returns -3.0

v = accumulator();
// returns -3.0