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

min

Return the minimum value.

Usage

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

min( [x[, y[, ...args]]] )

Returns the minimum value.

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

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

v = min( 4.2, 3.14, -1.0, 6.8 );
// returns -1.0

If any argument is NaN, the function returns NaN.

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

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

If not provided any arguments, the function returns +infinity.

var v = min();
// returns Infinity

Notes

• When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, min() = +infinity.

Examples

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

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

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