Skip to content
/ assert Public

is-almost-equal-complex128array

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

is-almost-equal-complex128array

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

isAlmostEqualComplex128Array

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).

Usage

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

isAlmostEqualComplex128Array( v1, v2, maxULP )

Tests 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).

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

Notes

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

Examples

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