Package Exports

@stdlib/stats-iter-max

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-iter-max) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

itermax

Compute the maximum value of all iterated values.

Installation

npm install @stdlib/stats-iter-max

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 );

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.

License

See LICENSE.

@stdlib/stats-iter-max