About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
pdifff
Return the positive difference between
x
andy
.
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
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( void ) {
const 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 );
}
}
See Also
-
@stdlib/math-base/special/pdiff
: return the positive difference betweenx
andy
.
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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.