@stdlib/math-base-special-fast-min NPM

min

$NPM version$ $Build Status$ $Coverage Status$

Return the minimum value.

Installation

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

Usage

var min = require( '@stdlib/math-base-special-fast-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/math-base-special-fast-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/fast/min.h"

stdlib_base_fast_min( x, y )

Returns the minimum value.

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

out = stdlib_base_fast_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_fast_min( const double x, const double y );

Examples

#include "stdlib/math/base/special/fast/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 ) * 10000.0 ) - 5000.0;
        y = ( ( (double)rand() / (double)RAND_MAX ) * 10000.0 ) - 5000.0;
        v = stdlib_base_fast_min( x, y );
        printf( "x: %lf, y: %lf, min(x, y): %lf\n", x, y, v );
    }
}

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.