Skip to content

Latest commit

 

History

History
 
 

README.md

abs

Compute the absolute value of a double-precision floating-point number.

The absolute value is defined as

$$|x| = \begin{cases} x & \textrm{if}\ x \geq 0 \\ -x & \textrm{if}\ x < 0\end{cases}$$

Usage

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

abs( x )

Computes the absolute value of a double-precision floating-point number.

var v = abs( -1.0 );
// returns 1.0

v = abs( 2.0 );
// returns 2.0

v = abs( 0.0 );
// returns 0.0

v = abs( -0.0 );
// returns 0.0

v = abs( NaN );
// returns NaN

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var abs = require( '@stdlib/math/base/special/abs' );

var x = discreteUniform( 100, -100, 100, {
    'dtype': 'float64'
});

logEachMap( 'abs(%d) = %d', x, abs );

C APIs

Usage

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

stdlib_base_abs( x )

Computes the absolute value of a double-precision floating-point number.

double y = stdlib_base_abs( -5.0 );
// returns 5.0

The function accepts the following arguments:

  • x: [in] double input value.
double stdlib_base_abs( const double x );

Examples

#include "stdlib/math/base/special/abs.h"
#include <stdio.h>

int main( void ) {
    const 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_abs( x[ i ] );
        printf( "|%lf| = %lf\n", x[ i ], y );
    }
}

See Also