About stdlib...

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!

incrminmaxabs

Compute minimum and maximum absolute values incrementally.

Installation

npm install @stdlib/stats-incr-minmaxabs

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var incrminmaxabs = require( '@stdlib/stats-incr-minmaxabs' );

incrminmaxabs( [out] )

Returns an accumulator function which incrementally computes minimum and maximum absolute values.

var accumulator = incrminmaxabs();

By default, the returned accumulator function returns the minimum and maximum absolute values as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

var Float64Array = require( '@stdlib/array-float64' );

var accumulator = incrminmaxabs( new Float64Array( 2 ) );

accumulator( [x] )

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

var accumulator = incrminmaxabs();

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 [ 1.0, 7.0 ]

mm = accumulator( -5.0 );
// returns [ 1.0, 7.0 ]

mm = accumulator();
// returns [ 1.0, 7.0 ]

Notes

• Input values are not type checked. If provided 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.

Examples

var randu = require( '@stdlib/random-base-randu' );
var incrminmaxabs = require( '@stdlib/stats-incr-minmaxabs' );

var accumulator;
var v;
var i;

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

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

---

See Also

• @stdlib/stats-incr/maxabs: compute a maximum absolute value incrementally.
• @stdlib/stats-incr/minabs: compute a minimum absolute value incrementally.
• @stdlib/stats-incr/minmax: compute a minimum and maximum incrementally.
• @stdlib/stats-incr/mminmaxabs: compute moving minimum and maximum absolute values incrementally.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.