Skip to content

clamp

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

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/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var clamp = require( '@stdlib/math/base/special/clamp' );

var opts = {
    'dtype': 'float64'
};
var min = discreteUniform( 100, 0, 10, opts );
var max = discreteUniform( 100, 5, 15, opts );
var v = discreteUniform( 100, -20, 20, opts );

logEachMap( 'clamp(%d,%d,%d) => %d', v, min, max, clamp );

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

See Also