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

    0.0.5 • Public • Published

    pdifff

    NPM version Build Status Coverage Status dependencies

    Return the positive difference between x and y.

    Installation

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

    Usage

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

    pdifff( x, y )

    Returns the positive difference between x and y if x < y; otherwise, returns 0.

    var v = pdifff( 4.15, 3.15 );
    // returns 1.0
    
    v = pdifff( 3.14, 4.2 );
    // returns +0.0
    
    v = pdifff( -0.0, +0.0 );
    // returns +0.0

    If any argument is NaN, the function returns NaN.

    var v = pdifff( 4.2, NaN );
    // returns NaN
    
    v = pdifff( NaN, 3.14 );
    // returns NaN
    
    v = pdifff( NaN, NaN );
    // returns NaN

    Notes

    • This function is the equivalent of fdimf in the C/C++ standard library.

    Examples

    var minstd = require( '@stdlib/random-base-minstd-shuffle' );
    var pdifff = require( '@stdlib/math-base-special-pdifff' );
    
    var x;
    var y;
    var v;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        x = minstd();
        y = minstd();
        v = pdifff( x, y );
        console.log( 'pdifff(%d,%d) = %d', x, y, v );
    }

    C APIs

    Installation

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

    Usage

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

    stdlib_base_pdifff( x, y )

    Returns the positive difference between x and y (single-precision).

    float v = stdlib_base_pdifff( 4.0f, 3.0f );
    // returns 1.0f

    The function accepts the following arguments:

    • x: [in] float input value.
    • y: [in] float input value.
    float stdlib_base_pdifff( const float x, const float y );

    Examples

    #include "stdlib/math/base/special/pdifff.h"
    #include <stdio.h>
    
    int main() {
        float x[] = { 3.0f, 4.0f, 6.0f, 5.0f };
    
        float y;
        int i;
        for ( i = 0; i < 4; i += 2 ) {
            y = stdlib_base_pdifff( x[ i ], x[ i+1 ] );
            printf( "pdifff(%f, %f) = %f\n", x[ i ], x[ i+1 ], 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-pdifff

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    12

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    50.8 kB

    Total Files

    16

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser