@stdlib/math-base-special-rampf NPM

Ramp Function

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

Evaluate the ramp function.

or, alternatively, in terms of the max function

Installation

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

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 linspace = require( '@stdlib/array-base-linspace' );
var rampf = require( '@stdlib/math-base-special-rampf' );

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

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

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

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.