@stdlib/math-base-special-ramp
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Ramp Function

    NPM version Build Status Coverage Status dependencies

    Evaluate the ramp function.

    The ramp function is defined as

    Ramp function.

    or, alternatively, in terms of the max function

    Ramp function alternative definition.

    Installation

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

    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-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

    Installation

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

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

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/math-base-special-ramp

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    26

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    63.7 kB

    Total Files

    18

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser