Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@stdlib/math-base-special-abs

stdlib-js1.8mApache-2.00.2.2TypeScript support: included

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

stdlib, stdmath, mathematics, math, math.abs, abs, absolute, magnitude, value, number, double, double-precision

readme

<summary> About stdlib... </summary>

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!

Absolute Value

NPM version Build Status Coverage Status

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

The absolute value is defined as

Absolute value

Installation

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

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 randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var abs = require( '@stdlib/math-base-special-abs' );

var rand;
var i;

for ( i = 0; i < 100; i++ ) {
    rand = round( randu() * 100.0 ) - 50.0;
    console.log( 'abs(%d) = %d', rand, abs( rand ) );
}

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

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 © 2016-2024. The Stdlib Authors.