@stdlib/assert-is-same-complex128 NPM

isSameComplex128

Test if two arguments are both double-precision complex floating-point numbers and have the same value.

Installation

npm install @stdlib/assert-is-same-complex128

Usage

var isSameComplex128 = require( '@stdlib/assert-is-same-complex128' );

isSameComplex128( v1, v2 )

Tests if two arguments are both double-precision complex floating-point numbers and have the same value.

var Complex128 = require( '@stdlib/complex-float64' );

var x = new Complex128( 1.0, 2.0 );
var y = new Complex128( 1.0, 2.0 );
var bool = isSameComplex128( x, y );
// returns true

Notes

In contrast to the strict equality operator ===, the function distinguishes between +0 and -0 and treats NaNs as the same value.

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var isSameComplex128 = require( '@stdlib/assert-is-same-complex128' );

var x = new Complex128( 1.0, 2.0 );
var y = new Complex128( 1.0, 2.0 );
var out = isSameComplex128( x, y );
// returns true

x = new Complex128( 0.0, -0.0 );
y = new Complex128( -0.0, 0.0 );
out = isSameComplex128( x, y );
// returns false

x = new Complex128( NaN, NaN );
y = new Complex128( NaN, NaN );
out = isSameComplex128( x, y );
// returns true

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.