@stdlib/stats-incr-max NPM

incrmax

Compute a maximum value incrementally.

Installation

npm install @stdlib/stats-incr-max

Usage

var incrmax = require( '@stdlib/stats-incr-max' );

incrmax()

Returns an accumulator function which incrementally computes a maximum value.

var accumulator = incrmax();

accumulator( [x] )

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

var accumulator = incrmax();

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

var accumulator;
var v;
var i;

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

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

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.