@stdlib/assert-is-almost-equal-float32array
v0.1.0
Published
Test if two arguments are both Float32Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).
Downloads
58
Readme
isAlmostEqualFloat32Array
Test if two arguments are both Float32Arrays 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-float32arrayUsage
var isAlmostEqualFloat32Array = require( '@stdlib/assert-is-almost-equal-float32array' );isAlmostEqualFloat32Array( v1, v2, maxULP )
Tests if two arguments are both Float32Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).
var EPS = require( '@stdlib/constants-float32-eps' );
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, 2.0 ] );
var y = new Float32Array( [ 1.0+EPS, 2.0 ] );
var bool = isAlmostEqualFloat32Array( x, y, 0 );
// returns false
bool = isAlmostEqualFloat32Array( x, y, 1 );
// returns true
bool = isAlmostEqualFloat32Array( x, [ 1.0, 2.0 ], 1 );
// returns falseNotes
- The function returns
falseif either input value is aFloat32ArraycontainingNaN. - The function does not distinguish between
-0and+0, treating them as equal.
Examples
var Float32Array = require( '@stdlib/array-float32' );
var isAlmostEqualFloat32Array = require( '@stdlib/assert-is-almost-equal-float32array' );
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var out = isAlmostEqualFloat32Array( x, y, 0 );
// returns true
x = new Float32Array( [ -0.0, 0.0, -0.0 ] );
y = new Float32Array( [ 0.0, -0.0, 0.0 ] );
out = isAlmostEqualFloat32Array( x, y, 1 );
// returns true
x = new Float32Array( [ NaN, NaN, NaN ] );
y = new Float32Array( [ NaN, NaN, NaN ] );
out = isAlmostEqualFloat32Array( x, y, 0 );
// returns falseNotice
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.
