Package Exports

@stdlib/assert-is-almost-equal-float32array
@stdlib/assert-is-almost-equal-float32array/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-float32array) 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!

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-float32array

Usage

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 false

Notes

The function returns false if either input value is a Float32Array containing NaN.
The function does not distinguish between -0 and +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 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.

@stdlib/assert-is-almost-equal-float32array