time-to-botec/squiggle/node_modules/@stdlib/stats/incr/minmaxabs/README.md

incrminmaxabs

Compute minimum and maximum absolute values incrementally.

Usage

var incrminmaxabs = require( '@stdlib/stats/incr/minmaxabs' );

incrminmaxabs( [out] )

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

var accumulator = incrminmaxabs();

By default, the returned accumulator function returns the minimum and maximum absolute values as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

var Float64Array = require( '@stdlib/array/float64' );

var accumulator = incrminmaxabs( new Float64Array( 2 ) );

accumulator( [x] )

If provided an input value x, the accumulator function returns updated minimum and maximum absolute values. If not provided an input value x, the accumulator function returns the current minimum and maximum absolute values.

var accumulator = incrminmaxabs();

var mm = accumulator();
// returns null

mm = accumulator( 2.0 );
// returns [ 2.0, 2.0 ]

mm = accumulator( 1.0 );
// returns [ 1.0, 2.0 ]

mm = accumulator( 3.0 );
// returns [ 1.0, 3.0 ]

mm = accumulator( -7.0 );
// returns [ 1.0, 7.0 ]

mm = accumulator( -5.0 );
// returns [ 1.0, 7.0 ]

mm = accumulator();
// returns [ 1.0, 7.0 ]

Notes

• Input values are not type checked. If provided NaN, the accumulated values are equal to NaN for all future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly before passing the value to the accumulator function.

Examples

var randu = require( '@stdlib/random/base/randu' );
var incrminmaxabs = require( '@stdlib/stats/incr/minmaxabs' );

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrminmaxabs();

// For each simulated datum, update the minimum and maximum absolute values...
for ( i = 0; i < 100; i++ ) {
    v = ( randu()*100.0 ) - 50.0;
    accumulator( v );
}
console.log( accumulator() );