Test if two arguments are both Complex128Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).
npm install @stdlib/assert-is-almost-equal-complex128arrayWe 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...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if two arguments are both [Complex128Arrays][@stdlib/array/complex128] and contain respective elements which are [approximately equal][@stdlib/assert/is-almost-equal] within a specified number of ULPs (units in the last place).
``bash`
npm install @stdlib/assert-is-almost-equal-complex128array
`javascript`
var isAlmostEqualComplex128Array = require( '@stdlib/assert-is-almost-equal-complex128array' );
#### isAlmostEqualComplex128Array( v1, v2, maxULP )
Tests if two arguments are both [Complex128Arrays][@stdlib/array/complex128] and contain respective elements which are [approximately equal][@stdlib/assert/is-almost-equal] within a specified number of ULPs (units in the last place).
`javascript
var EPS = require( '@stdlib/constants-float64-eps' );
var Complex128Array = require( '@stdlib/array-complex128' );
var x = new Complex128Array( [ 1.0, 2.0 ] );
var y = new Complex128Array( [ 1.0+EPS, 2.0 ] );
var bool = isAlmostEqualComplex128Array( x, y, 0 );
// returns false
bool = isAlmostEqualComplex128Array( x, y, 1 );
// returns true
bool = isAlmostEqualComplex128Array( x, [ 1.0, 2.0 ], 1 );
// returns false
`
- The function returns false if either input value is a Complex128Array containing NaN.-0
- The function does not distinguish between and +0, treating them as equal.
`javascript
var Complex128Array = require( '@stdlib/array-complex128' );
var isAlmostEqualComplex128Array = require( '@stdlib/assert-is-almost-equal-complex128array' );
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var out = isAlmostEqualComplex128Array( x, y, 0 );
console.log( out );
// => true
x = new Complex128Array( [ -0.0, 0.0, -0.0, 0.0 ] );
y = new Complex128Array( [ 0.0, -0.0, 0.0, -0.0 ] );
out = isAlmostEqualComplex128Array( x, y, 1 );
console.log( out );
// => true
x = new Complex128Array( [ NaN, NaN, NaN, NaN ] );
y = new Complex128Array( [ NaN, NaN, NaN, NaN ] );
out = isAlmostEqualComplex128Array( x, y, 0 );
console.log( out );
// => false
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-almost-equal-complex128array.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-almost-equal-complex128array
[test-image]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-almost-equal-complex128array/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-almost-equal-complex128array?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/assert-is-almost-equal-complex128array/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-almost-equal-complex128array/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-almost-equal-complex128array/main/LICENSE
[@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/array-complex128
[@stdlib/assert/is-almost-equal]: https://www.npmjs.com/package/@stdlib/assert-is-almost-equal