Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/incr/minmaxabs/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 absolute minimum and maximum values. If not provided a value, the accumulator function returns the current minimum and maximum values.

Notes

  • If provided NaN, the minimum and maximum 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 incrminmaxabs

  • Returns an accumulator function which incrementally computes minimum and maximum absolute values.

    Parameters

    • Optional out: ArrayLike<number>

      output array

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrminmaxabs();
    
    var mm = accumulator();
    // returns null
    
    mm = accumulator( 2.0 );
    // returns [ 2.0, 2.0 ]
    
    mm = accumulator( -5.0 );
    // returns [ 2.0, 5.0 ]
    
    mm = accumulator( 3.0 );
    // returns [ 2.0, 5.0 ]
    
    mm = accumulator( 5.0 );
    // returns [ 2.0, 5.0 ]
    
    mm = accumulator();
    // returns [ 2.0, 5.0 ]