Ramp Function

Evaluate the ramp function.

The ramp function is defined as

upper R left-parenthesis x right-parenthesis equals StartLayout Enlarged left-brace 1st Row 1st Column x 2nd Column if x greater-than-or-equal-to 0 2nd Row 1st Column 0 2nd Column if x less-than 0 EndLayout

or, alternatively, in terms of the max function

upper R left-parenthesis x right-parenthesis equals max left-parenthesis x comma 0 right-parenthesis

Usage

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

ramp( x )

Evaluates the ramp function.

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

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

v = ramp( NaN );
// returns NaN

Examples

var linspace = require( '@stdlib/array/base/linspace' );
var ramp = require( '@stdlib/math/base/special/ramp' );

var x = linspace( -10.0, 10.0, 101 );

var i;
for ( i = 0; i < x.length; i++ ) {
    console.log( 'R(%d) = %d', x[ i ], ramp( x[ i ] ) );
}

C APIs

Usage

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

stdlib_base_ramp( x )

Evaluates the ramp function.

double y = stdlib_base_ramp( 3.0 );
// returns 3.0

The function accepts the following arguments:

  • x: [in] double input value.
double stdlib_base_ramp( const double x );

Examples

#include "stdlib/math/base/special/ramp.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_ramp( x[ i ] );
        printf( "R(%lf) = %lf\n", x[ i ], y );
    }
}
Did you find this page helpful?