stdlib-js
<summary>
About stdlib...
</summary>
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
incrminmax
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Compute a minimum and maximum incrementally.
bash
npm install @stdlib/stats-incr-minmax
javascript
var incrminmax = require( '@stdlib/stats-incr-minmax' );
#### incrminmax( [out] )
Returns an accumulator function which incrementally computes a minimum and maximum.
javascript
var accumulator = incrminmax();
By default, the returned accumulator function returns the minimum and maximum as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
javascript
var Float64Array = require( '@stdlib/array-float64' );
var accumulator = incrminmax( new Float64Array( 2 ) );
#### accumulator( [x] )
If provided an input value x, the accumulator function returns updated minimum and maximum values. If not provided an input value x, the accumulator function returns the current minimum and maximum values.
javascript
var accumulator = incrminmax();
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 [ -7.0, 3.0 ]
mm = accumulator( -5.0 );
// returns [ -7.0, 3.0 ]
mm = accumulator();
// returns [ -7.0, 3.0 ]
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.
javascript
var randu = require( '@stdlib/random-base-randu' );
var incrminmax = require( '@stdlib/stats-incr-minmax' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrminmax();
// For each simulated datum, update the minimum and maximum...
for ( i = 0; i < 100; i++ ) {
v = randu() * 100.0;
accumulator( v );
}
console.log( accumulator() );
@stdlib/stats-incr/max][@stdlib/stats/incr/max]: compute a maximum value incrementally.
- [@stdlib/stats-incr/min][@stdlib/stats/incr/min]: compute a minimum value incrementally.
- [@stdlib/stats-incr/mminmax][@stdlib/stats/incr/mminmax]: compute a moving minimum and maximum incrementally.
- [@stdlib/stats-incr/range][@stdlib/stats/incr/range]: compute a range incrementally.
