time-to-botec/js/node_modules/@stdlib/math/base/special/clamp/README.md

clamp

Restrict a double-precision floating-point number to a specified range.

Usage

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

clamp( v, min, max )

Restricts a double-precision floating-point number to a specified range.

var v = clamp( 3.14, 0.0, 5.0 );
// returns 3.14

v = clamp( -3.14, 0.0, 5.0 );
// returns 0.0

v = clamp( 10.0, 0.0, 5.0 );
// returns 5.0

v = clamp( -0.0, 0.0, 5.0 );
// returns 0.0

v = clamp( 0.0, -3.14, -0.0 );
// returns -0.0

If provided NaN for any argument, the function returns NaN.

var v = clamp( NaN, 0.0, 5.0 );
// returns NaN

v = clamp( 0.0, NaN, 5.0 );
// returns NaN

v = clamp( 3.14, 0.0, NaN );
// returns NaN

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var clamp = require( '@stdlib/math/base/special/clamp' );

var min;
var max;
var v;
var i;

for ( i = 0; i < 100; i++ ) {
    min = discreteUniform( 0.0, 10.0 );
    max = discreteUniform( 5.0, 15.0 );
    v = discreteUniform( -20.0, 20.0 );
    console.log( 'clamp(%d,%d,%d) => %d', v, min, max, clamp( v, min, max ) );
}

---

C APIs

Usage

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

stdlib_base_clamp( v, min, max )

Restricts a double-precision floating-point number to a specified range.

double y = stdlib_base_clamp( -3.14, 0.0, 5.0 );
// returns 0.0

The function accepts the following arguments:

• v: [in] double input value.
• min: [in] double minimum value.
• max: [in] double maximum value.

double stdlib_base_clamp( const double v, const double min, const double max );

Examples

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

int main() {
    double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };

    double y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_clamp( x[ i ], -3.0, 3.0 );
        printf( "clamp(%lf, %lf, %lf) = %lf\n", x[ i ], -3.0, 3.0, y );
    }
}