time-to-botec/squiggle/node_modules/@stdlib/math/base/special/minmax/README.md

minmax

Return the minimum and maximum values.

Usage

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

minmax( [out,] x[, y[, ...args]] )

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 ]

v = minmax( 4.2, 3.14, -1.0, 6.8 );
// returns [ -1.0, 6.8 ]

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 ]

By default, the function returns minimum and maximum values as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

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

var out = new Float64Array( 2 );

var v = minmax( out, 5.0, 3.0, -2.0, 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] );
}