Package Exports

@stdlib/assert-is-almost-equal
@stdlib/assert-is-almost-equal/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-almost-equal) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About stdlib...

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!

isAlmostEqual

Test if two arguments are approximately equal within a specified number of ULPs (units in the last place).

Installation

npm install @stdlib/assert-is-almost-equal

Usage

var isAlmostEqual = require( '@stdlib/assert-is-almost-equal' );

isAlmostEqual( a, b, maxULP )

Tests if two arguments are approximately equal within a specified number of ULPs (units in the last place).

var EPS = require( '@stdlib/constants-float64-eps' );

var bool = isAlmostEqual( 1.0, 1.0+EPS, 1 );
// returns true

bool = isAlmostEqual( '', '', 0 );
// returns true

bool = isAlmostEqual( {}, {}, 1 );
// returns false

The function returns false if either input value is NaN or, in the case of complex numbers, if either the real or imaginary component is NaN.

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var bool = isAlmostEqual( NaN, 1.0, 1 );
// returns false

bool = isAlmostEqual( NaN, NaN, 1 );
// returns false

var z1 = new Complex128( NaN, 3.0 );
var z2 = new Complex128( 1.0, 3.0 );

bool = isAlmostEqual( z1, z2, 1 );
// returns false

z1 = new Complex128( NaN, NaN );
z2 = new Complex128( NaN, NaN );

bool = isAlmostEqual( z1, z2, 1 );
// returns false

The function does not distinguish between -0 and +0, treating them as equal.

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var bool = isAlmostEqual( 0.0, -0.0, 0 );
// returns true

var z1 = new Complex128( 0.0, 0.0 );
var z2 = new Complex128( -0.0, -0.0 );

bool = isAlmostEqual( z1, z2, 0 );
// returns true

Examples

var EPS = require( '@stdlib/constants-float64-eps' );
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var isAlmostEqual = require( '@stdlib/assert-is-almost-equal' );

console.log( isAlmostEqual( true, true, 0 ) );
// => true

console.log( isAlmostEqual( true, false, 1 ) );
// => false

console.log( isAlmostEqual( 'beep', 'beep', 1 ) );
// => true

console.log( isAlmostEqual( 1.0, 1.0+EPS, 1 ) );
// => true

console.log( isAlmostEqual( null, null, 0 ) );
// => true

console.log( isAlmostEqual( 0.0, -0.0, 0 ) );
// => true

console.log( isAlmostEqual( NaN, NaN, 1 ) );
// => false

var z1 = new Complex128( 1.0, 3.0+EPS );
var z2 = new Complex128( 1.0+EPS, 3.0 );
console.log( isAlmostEqual( z1, z2, 1 ) );
// => true

console.log( isAlmostEqual( {}, {}, 1 ) );
// => false

console.log( isAlmostEqual( [], [], 1 ) );
// => false

console.log( isAlmostEqual( isAlmostEqual, isAlmostEqual, 0 ) );
// => true

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

License

See LICENSE.

@stdlib/assert-is-almost-equal