|
||
---|---|---|
.. | ||
docs | ||
lib | ||
package.json | ||
README.md |
incrmaxabs
Compute a maximum absolute value incrementally.
Usage
var incrmaxabs = require( '@stdlib/stats/incr/maxabs' );
incrmaxabs()
Returns an accumulator function
which incrementally computes a maximum absolute value.
var accumulator = incrmaxabs();
accumulator( [x] )
If provided an input value x
, the accumulator function returns an updated maximum absolute value. If not provided an input value x
, the accumulator function returns the current maximum absolute value.
var accumulator = incrmaxabs();
var max = accumulator( 2.0 );
// returns 2.0
max = accumulator( 1.0 );
// returns 2.0
max = accumulator( -3.0 );
// returns 3.0
max = accumulator();
// returns 3.0
Notes
- Input values are not type checked. If provided
NaN
, the accumulated value isNaN
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 incrmaxabs = require( '@stdlib/stats/incr/maxabs' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrmaxabs();
// For each simulated datum, update the maximum absolute value...
for ( i = 0; i < 100; i++ ) {
v = ( randu()*100.0 ) - 50.0;
accumulator( v );
}
console.log( accumulator() );