@stdlib/math-base-special-clamp NPM

clamp

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

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

Installation

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

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( void ) {
    const 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 );
    }
}

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.