isAlmostEqualArray

Test if two arguments are both generic arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).

Installation

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

Usage

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

isAlmostEqualArray( v1, v2, maxULP )

Tests if two arguments are both generic arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).

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

var x = [ 1.0, 2.0 ];
var y = [ 1.0+EPS, 2.0 ];

var bool = isAlmostEqualArray( x, y, 0 );
// returns false

bool = isAlmostEqualArray( x, y, 1 );
// returns true

bool = isAlmostEqualArray( x, [ -1.0, 2.0 ], 1 );
// returns false

Notes

• The function returns false if either input value is a generic array containing NaN.
• The function does not distinguish between -0 and +0, treating them as equal.

Examples

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

var x = [ 1.0, 2.0, 3.0 ];
var y = [ 1.0, 2.0, 3.0 ];
var out = isAlmostEqualArray( x, y, 0 );
// returns true

x = [ -0.0, 0.0, -0.0 ];
y = [ 0.0, -0.0, 0.0 ];
out = isAlmostEqualArray( x, y, 1 );
// returns true

x = [ NaN, NaN, NaN ];
y = [ NaN, NaN, NaN ];
out = isAlmostEqualArray( x, y, 0 );
// returns false

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.

Copyright

Copyright © 2016-2026. The Stdlib Authors.