time-to-botec/squiggle/node_modules/@stdlib/stats/incr/minabs
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

incrminabs

Compute a minimum absolute value incrementally.

Usage

var incrminabs = require( '@stdlib/stats/incr/minabs' );

incrminabs()

Returns an accumulator function which incrementally computes a minimum absolute value.

var accumulator = incrminabs();

accumulator( [x] )

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

var accumulator = incrminabs();

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 incrminabs = require( '@stdlib/stats/incr/minabs' );

var accumulator;
var v;
var i;

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

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