@stdlib/math-base-special-fast-abs
v0.3.1TypeScript
Compute an absolute value.
0/weekUpdated 5 days agoApache-2.0Unpacked: 38.7 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-fast-absWe 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!
About stdlib...
Absolute Value
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute an [absolute value][absolute-value].
The [absolute value][absolute-value] is defined as
Installation
``bash`
npm install @stdlib/math-base-special-fast-abs
Usage
`javascript`
var abs = require( '@stdlib/math-base-special-fast-abs' );
#### abs( x )
Computes an [absolute value][absolute-value].
`javascript
var v = abs( -1.0 );
// returns 1.0
v = abs( 2.0 );
// returns 2.0
v = abs( 0.0 );
// returns 0.0
v = abs( NaN );
// returns NaN
`
Notes
- This implementation is not [IEEE 754][ieee754] compliant. If provided -0, the function returns -0.
`javascript`
var v = abs( -0.0 );
// returns -0.0
Examples
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var abs = require( '@stdlib/math-base-special-fast-abs' );
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, -50, 50, opts );
logEachMap( 'abs(%d) = %d', x, abs );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/fast/abs.h"
#### stdlib_base_fast_abs( x )
Computes the absolute value of a double-precision floating-point number.
`c`
double y = stdlib_base_fast_abs( -5.0 );
// returns 5.0
The function accepts the following arguments:
- x: [in] double input value.
`c`
double stdlib_base_fast_abs( const double x );
$3
`c
#include "stdlib/math/base/special/fast/abs.h"
#include
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_fast_abs( x[ i ] );
printf( "|%lf| = %lf\n", x[ i ], y );
}
}
`
*
See Also
- [@stdlib/math-base/special/abs][@stdlib/math/base/special/abs]: compute the absolute value of a double-precision floating-point number.
*
Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-fast-abs.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-fast-abs
[test-image]: https://github.com/stdlib-js/math-base-special-fast-abs/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/math-base-special-fast-abs/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-fast-abs/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-fast-abs?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-base-special-fast-abs/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-fast-abs/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-fast-abs/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-fast-abs/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-fast-abs/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-fast-abs/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-fast-abs/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-fast-abs/main/LICENSE
[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
[@stdlib/math/base/special/abs]: https://www.npmjs.com/package/@stdlib/math-base-special-abs