min

Return the minimum value.

Installation

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

Usage

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

min( x, y )

Returns the minimum value.

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

v = min( +0.0, -0.0 );
// returns -0.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

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 );
}

C APIs

Usage

#include "stdlib/math/base/special/min.h"

stdlib_base_min( x, y )

Returns the minimum value.

double out = stdlib_base_min( 4.2, 3.14 );
// returns 3.14

out = stdlib_base_min( 0.0, -0.0 );
// returns -0.0

The function accepts the following arguments:

• x: [in] double input value.
• y: [in] double input value.

double stdlib_base_min( const double x, const double y );

Examples

#include "stdlib/math/base/special/min.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
    double x;
    double y;
    double v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        y = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        v = stdlib_base_min( x, y );
        printf( "x: %lf, y: %lf, min(x, y): %lf\n", x, y, v );
    }
}

See Also

• @stdlib/math-base/special/max: return the maximum value.
• @stdlib/math-base/special/minabs: return the minimum absolute value.
• @stdlib/math-base/special/minn: 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.