@stdlib/math-base-special-max v0.2.1

max

Return the maximum value.

Installation

npm install @stdlib/math-base-special-max

Usage

var max = require( '@stdlib/math-base-special-max' );

max( x, y )

Returns the maximum value.

var v = max( 4.2, 3.14 );
// returns 4.2

v = max( +0.0, -0.0 );
// returns +0.0

If any argument is NaN, the function returns NaN.

var v = max( 4.2, NaN );
// returns NaN

v = max( NaN, 3.14 );
// returns NaN

Examples

var minstd = require( '@stdlib/random-base-minstd-shuffle' );
var max = require( '@stdlib/math-base-special-max' );

var x;
var y;
var v;
var i;

for ( i = 0; i < 100; i++ ) {
    x = minstd();
    y = minstd();
    v = max( x, y );
    console.log( 'max(%d,%d) = %d', x, y, v );
}

See Also

• @stdlib/math-base/special/maxabs: return the maximum absolute value.
• @stdlib/math-base/special/maxn: return the maximum value.
• @stdlib/math-base/special/min: return the minimum value.

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.