@stdlib/math-base-utils-absolute-difference
v0.3.3TypeScript
Compute the absolute difference of two real numbers.
0/weekUpdated 3 days agoApache-2.0Unpacked: 32.5 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-utils-absolute-differenceWe 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 Difference
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [absolute difference][absolute-difference] of two real numbers.
The [absolute difference][absolute-difference] of two real numbers is defined as the absolute value of their difference.
Installation
``bash`
npm install @stdlib/math-base-utils-absolute-difference
Usage
`javascript`
var absdiff = require( '@stdlib/math-base-utils-absolute-difference' );
#### absdiff( x, y )
Computes the [absolute difference][absolute-difference] of two real numbers.
`javascript
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
`javascript
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 );
}
`
*
See Also
- [@stdlib/math-base/utils/relative-difference][@stdlib/math/base/utils/relative-difference]: compute the relative difference of two real numbers.
- [@stdlib/math-base/utils/float64-epsilon-difference][@stdlib/math/base/utils/float64-epsilon-difference]: compute the relative difference of two real numbers in units of double-precision floating-point epsilon.
*
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-utils-absolute-difference.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-utils-absolute-difference
[test-image]: https://github.com/stdlib-js/math-base-utils-absolute-difference/actions/workflows/test.yml/badge.svg?branch=v0.3.3
[test-url]: https://github.com/stdlib-js/math-base-utils-absolute-difference/actions/workflows/test.yml?query=branch:v0.3.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-utils-absolute-difference/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-utils-absolute-difference?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-utils-absolute-difference/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-utils-absolute-difference/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-utils-absolute-difference/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-utils-absolute-difference/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-utils-absolute-difference/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-utils-absolute-difference/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-utils-absolute-difference/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-utils-absolute-difference/main/LICENSE
[absolute-difference]: https://en.wikipedia.org/wiki/Absolute_difference
[@stdlib/math/base/utils/relative-difference]: https://www.npmjs.com/package/@stdlib/math-base-utils-relative-difference
[@stdlib/math/base/utils/float64-epsilon-difference]: https://www.npmjs.com/package/@stdlib/math-base-utils-float64-epsilon-difference