minmax

Return the minimum and maximum values.

Installation

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

Usage

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

minmax( x, y )

Returns the minimum and maximum values in a single pass.

var v = minmax( 4.2, 3.14 );
// returns [ 3.14, 4.2 ]

v = minmax( +0.0, -0.0 );
// returns [ -0.0, +0.0 ]

If any argument is NaN, the function returns NaN for both the minimum value and the maximum value.

var v = minmax( 4.2, NaN );
// returns [ NaN, NaN ]

v = minmax( NaN, 3.14 );
// returns [ NaN, NaN ]

minmax.assign( x, y, out, stride, offset )

Returns the minimum and maximum values in a single pass and assigns results to a provided output array.

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

var out = new Float64Array( 2 );

var v = minmax.assign( 5.0, -2.0, out, 1, 0 );
// returns <Float64Array>[ -2.0, 5.0 ]

var bool = ( v === out );
// returns true

Examples

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

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

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

See Also

• @stdlib/math-base/special/max: return the maximum value.
• @stdlib/math-base/special/min: return the minimum value.
• @stdlib/math-base/special/minmaxabs: return the minimum and maximum absolute values.

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.