@stdlib/complex-base-assert-is-equal v0.2.1

isEqual

Test whether two double-precision complex floating-point numbers are equal.

Installation

npm install @stdlib/complex-base-assert-is-equal

Usage

var isEqual = require( '@stdlib/complex-base-assert-is-equal' );

isEqual( z1, z2 )

Tests whether two double-precision complex floating-point numbers are equal.

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

var z1 = new Complex128( 5.0, 3.0 );
var z2 = new Complex128( 5.0, 3.0 );

var out = isEqual( z1, z2 );
// returns true

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var isEqual = require( '@stdlib/complex-base-assert-is-equal' );

var z1 = new Complex128( 5.0, 3.0 );
var z2 = new Complex128( 5.0, 3.0 );
var out = isEqual( z1, z2 );
// returns true

z1 = new Complex128( -5.0, -3.0 );
z2 = new Complex128( 5.0, 3.0 );
out = isEqual( z1, z2 );
// returns false

z1 = new Complex128( NaN, 3.0 );
z2 = new Complex128( NaN, 3.0 );
out = isEqual( z1, z2 );
// returns false

C APIs

Usage

#include "stdlib/complex/base/assert/is_equal.h"

stdlib_base_complex128_is_equal( z1, z2 )

Tests whether double-precision complex floating-point numbers are equal.

#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_equal( 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_equal( const stdlib_complex128_t z1, const stdlib_complex128_t z2 );

Examples

#include "stdlib/complex/base/assert/is_equal.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_equal( z[ i ], z[ i ] );
        printf( "Equal? %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.