@stdlib/assert-is-same-complex64
v0.2.2
Published
Test if two arguments are both single-precision complex floating-point numbers and have the same value.
Downloads
28
Readme
isSameComplex64
Test if two arguments are both single-precision complex floating-point numbers and have the same value.
Installation
npm install @stdlib/assert-is-same-complex64
Usage
var isSameComplex64 = require( '@stdlib/assert-is-same-complex64' );
isSameComplex64( v1, v2 )
Tests if two arguments are both single-precision complex floating-point numbers and have the same value.
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var x = new Complex64( 1.0, 2.0 );
var y = new Complex64( 1.0, 2.0 );
var bool = isSameComplex64( x, y );
// returns true
Notes
- In contrast to the strict equality operator
===
, the function distinguishes between+0
and-0
and treatsNaNs
as the same value.
Examples
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var isSameComplex64 = require( '@stdlib/assert-is-same-complex64' );
var x = new Complex64( 1.0, 2.0 );
var y = new Complex64( 1.0, 2.0 );
var out = isSameComplex64( x, y );
// returns true
x = new Complex64( 0.0, -0.0 );
y = new Complex64( -0.0, 0.0 );
out = isSameComplex64( x, y );
// returns false
x = new Complex64( NaN, NaN );
y = new Complex64( NaN, NaN );
out = isSameComplex64( x, y );
// returns true
See Also
@stdlib/assert-is-complex64
: test if a value is a 64-bit complex number.@stdlib/assert-is-same-complex128
: test if two arguments are both double-precision complex floating-point numbers and have the same value.@stdlib/assert-is-same-value
: test if two arguments are the same value.
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.
Copyright
Copyright © 2016-2024. The Stdlib Authors.