time-to-botec/js/node_modules/@stdlib/stats/incr/range/README.md

incrrange

Compute a range incrementally.

The range is defined as the difference between the maximum and minimum values.

Usage

var incrrange = require( '@stdlib/stats/incr/range' );

incrrange()

Returns an accumulator function which incrementally computes a range.

var accumulator = incrrange();

accumulator( [x] )

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

var accumulator = incrrange();

var range = accumulator( -2.0 );
// returns 0.0

range = accumulator( 1.0 );
// returns 3.0

range = accumulator( 3.0 );
// returns 5.0

range = accumulator();
// returns 5.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 incrrange = require( '@stdlib/stats/incr/range' );

var accumulator;
var v;
var i;

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

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