Ramp Function

Evaluate the ramp function.

The ramp function is defined as

$$R(x) = \begin{cases} x & \textrm{if}\ x \geq 0 \\ 0 & \textrm{if}\ x \lt 0\end{cases}$$

or, alternatively, in terms of the max function

$$R(x) = \mathop{\mathrm{max}}( x, 0 )$$

Usage

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

rampf( x )

Evaluates the ramp function.

var v = rampf( 3.14 );
// returns 3.14

v = rampf( -3.14 );
// returns 0.0

v = rampf( NaN );
// returns NaN

Examples

var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var rampf = require( '@stdlib/math/base/special/rampf' );

var opts = {
    'dtype': 'float32'
};
var x = uniform( 101, -10.0, 10.0, opts );

logEachMap( 'R(%0.4f) = %0.4f', x, rampf );

---

C APIs

Usage

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

stdlib_base_rampf( x )

Evaluates the ramp function (single-precision).

float y = stdlib_base_rampf( 3.0f );
// returns 3.0f

The function accepts the following arguments:

• x: [in] float input value.

float stdlib_base_rampf( const float x );

Examples

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

int main( void ) {
    const float x[] = { 3.14f, -3.14f, 0.0f, 0.0f/0.0f };

    float y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_rampf( x[ i ] );
        printf( "R(%f) = %f\n", x[ i ], y );
    }
}

---

See Also

• @stdlib/math/base/special/ramp: evaluate the ramp function.