time-to-botec/squiggle/node_modules/@stdlib/math/base/utils/absolute-difference/README.md

Absolute Difference

Compute the absolute difference of two real numbers.

The absolute difference of two real numbers is defined as the absolute value of their difference.

Usage

var absdiff = require( '@stdlib/math/base/utils/absolute-difference' );

absdiff( x, y )

Computes the absolute difference of two real numbers.

var d = absdiff( 2.0, 5.0 );
// returns 3.0

d = absdiff( -1.0, 3.14 );
// returns ~4.14

d = absdiff( 10.1, -2.05 );
// returns ~12.15

d = absdiff( -0.0, 0.0 );
// returns +0.0

d = absdiff( NaN, 5.0 );
// returns NaN

d = absdiff( 5.0, NaN );
// returns NaN

d = absdiff( Infinity, Infinity );
// returns NaN

d = absdiff( -Infinity, -Infinity );
// returns NaN

d = absdiff( Infinity, -Infinity );
// returns Infinity

d = absdiff( -Infinity, Infinity );
// returns Infinity

Examples

var randu = require( '@stdlib/random/base/randu' );
var absdiff = require( '@stdlib/math/base/utils/absolute-difference' );

var x;
var y;
var d;
var i;

for ( i = 0; i < 100; i++ ) {
    x = (randu()*1.0e4) - 1.0e2;
    y = (randu()*1.0e4) - 1.0e2;
    d = absdiff( x, y );
    console.log( 'x = %d. y = %d. |x-y| = %d.', x, y, d );
}