time-to-botec/squiggle/node_modules/@stdlib/stats/incr/min

incrmin

Compute a minimum value incrementally.

Usage

var incrmin = require( '@stdlib/stats/incr/min' );

incrmin()

Returns an accumulator function which incrementally computes a minimum value.

var accumulator = incrmin();

accumulator( [x] )

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

var accumulator = incrmin();

var min = accumulator( 2.0 );
// returns 2.0

min = accumulator( 1.0 );
// returns 1.0

min = accumulator( 3.0 );
// returns 1.0

min = accumulator();
// returns 1.0

Notes

• Input values are not type checked. If provided NaN, the accumulated value is 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 incrmin = require( '@stdlib/stats/incr/min' );

var accumulator;
var v;
var i;

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

// For each simulated datum, update the min...
for ( i = 0; i < 100; i++ ) {
    v = randu() * 100.0;
    accumulator( v );
}
console.log( accumulator() );