min

Return the minimum value.

Usage

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

min( x, y )

Returns the minimum value.

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

Notes

  • The implementation ignores the sign of 0.

    var v = min( +0.0, -0.0 );
    // returns -0.0
    
    v = min( -0.0, +0.0 );
    // returns +0.0
    
  • The implementation does not check for NaN arguments.

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

Examples

var minstd = require( '@stdlib/random/base/minstd-shuffle' );
var min = require( '@stdlib/fastmath/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 );
}