@stdlib/complex-base-assert-is-same-value
v0.2.1
Published
Test whether two double-precision complex floating-point numbers are the same value.
Downloads
11
Readme
isSameValue
Test whether two double-precision complex floating-point numbers are the same value.
Installation
npm install @stdlib/complex-base-assert-is-same-value
Usage
var isSameValue = require( '@stdlib/complex-base-assert-is-same-value' );
isSameValue( z1, z2 )
Tests whether two double-precision complex floating-point numbers are the same value.
var Complex128 = require( '@stdlib/complex-float64' );
var z1 = new Complex128( 5.0, 3.0 );
var z2 = new Complex128( 5.0, 3.0 );
var out = isSameValue( z1, z2 );
// returns true
In contrast to the strict equality operator ===
, the function distinguishes between +0
and -0
and treats NaNs
as the same value.
var Complex128 = require( '@stdlib/complex-float64' );
var z1 = new Complex128( NaN, NaN );
var z2 = new Complex128( NaN, NaN );
var out = isSameValue( z1, z2 );
// returns true
z1 = new Complex128( -0.0, 0.0 );
z2 = new Complex128( 0.0, -0.0 );
out = isSameValue( z1, z2 );
// returns false
Notes
- The function implements the SameValue Algorithm as specified in ECMAScript 5.
Examples
var Complex128 = require( '@stdlib/complex-float64' );
var isSameValue = require( '@stdlib/complex-base-assert-is-same-value' );
var z1 = new Complex128( 5.0, 3.0 );
var z2 = new Complex128( 5.0, 3.0 );
var out = isSameValue( z1, z2 );
// returns true
z1 = new Complex128( -5.0, -3.0 );
z2 = new Complex128( 5.0, 3.0 );
out = isSameValue( z1, z2 );
// returns false
z1 = new Complex128( NaN, 3.0 );
z2 = new Complex128( NaN, 3.0 );
out = isSameValue( z1, z2 );
// returns true
C APIs
Usage
#include "stdlib/complex/base/assert/is_same_value.h"
stdlib_base_complex128_is_same_value( z1, z2 )
Tests whether two double-precision complex floating-point numbers are the same value.
#include "stdlib/complex/float64.h"
#include <stdbool.h>
stdlib_complex128_t z1 = stdlib_complex128( 5.0, 2.0 );
stdlib_complex128_t z2 = stdlib_complex128( 5.0, 2.0 );
bool v = stdlib_base_complex128_is_same_value( z1, z2 );
The function accepts the following arguments:
- z1:
[in] stdlib_complex128_t
first double-precision complex floating-point number. - z2:
[in] stdlib_complex128_t
second double-precision complex floating-point number.
bool stdlib_base_complex128_is_same_value( const stdlib_complex128_t z1, const stdlib_complex128_t z2 );
Examples
#include "stdlib/complex/base/assert/is_same_value.h"
#include "stdlib/complex/float64.h"
#include <stdbool.h>
#include <stdio.h>
int main( void ) {
const stdlib_complex128_t z[] = {
stdlib_complex128( 5.0, 2.0 ),
stdlib_complex128( -2.0, 1.0 ),
stdlib_complex128( 0.0, -0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};
bool v;
int i;
for ( i = 0; i < 4; i++ ) {
v = stdlib_base_complex128_is_same_value( z[ i ], z[ i ] );
printf( "Same value? %s\n", ( v ) ? "True" : "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.
Copyright
Copyright © 2016-2024. The Stdlib Authors.