time-to-botec/squiggle/node_modules/@stdlib/stats/iter/max/README.md

itermax

Compute the maximum value of all iterated values.

Usage

var itermax = require( '@stdlib/stats/iter/max' );

itermax( iterator )

Computes the maximum value of all iterated values.

var array2iterator = require( '@stdlib/array/to-iterator' );

var arr = array2iterator( [ 1.0, -2.0, 3.0, -4.0 ] );

var m = itermax( arr );
// returns 3.0

Notes

• If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.

Examples

var runif = require( '@stdlib/random/iter/uniform' );
var itermax = require( '@stdlib/stats/iter/max' );

// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
    'seed': 1234,
    'iter': 100
});

// Compute the maximum value:
var m = itermax( rand );
// returns <number>

console.log( 'Max: %d.', m );