@stdlib/number-float64-base-assert-is-same-value v0.2.1

isSameValue

Test if two double-precision floating-point numbers are the same value.

Installation

npm install @stdlib/number-float64-base-assert-is-same-value

Usage

var isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );

isSameValue( a, b )

Tests if two double-precision floating-point numbers a and b are the same value.

var bool = isSameValue( 3.14, 3.14 );
// returns true

bool = isSameValue( 5.0, 3.0 );
// returns false

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

var bool = ( 0.0 === -0.0 );
// returns true

bool = isSameValue( 0.0, -0.0 );
// returns false

bool = isSameValue( -0.0, -0.0 );
// returns true

bool = ( NaN === NaN );
// returns false

bool = isSameValue( NaN, NaN );
// returns true

Notes

• The function implements the SameValue Algorithm as specified in ECMAScript 5.

Examples

var isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );

var bool = isSameValue( 3.14, 3.14 );
// returns true

bool = isSameValue( 0.0, 0.0 );
// returns true

bool = isSameValue( -0.0, 0.0 );
// returns false

bool = isSameValue( NaN, NaN );
// returns true

C APIs

Usage

#include "stdlib/number/float64/base/assert/is_same_value.h"

stdlib_base_float64_is_same_value( a, b )

Tests if two double-precision floating-point numbers a and b are the same value.

#include <stdbool.h>

bool v = stdlib_base_float64_is_same_value( 3.14, 3.14 );
// returns true

v = stdlib_base_float64_is_same_value( 0.0, -0.0 );
// returns false

The function accepts the following arguments:

• a: [in] double first input value.
• b: [in] double second input value.

bool stdlib_base_float64_is_same_value( const double a, const double b );

Examples

#include "stdlib/number/float64/base/assert/is_same_value.h"
#include <stdbool.h>
#include <stdio.h>

int main( void ) {
    const double a[] = {
        5.0,
        -2.0,
        0.0,
        0.0/0.0
    };
    const double b[] = {
        5.0,
        2.0,
        -0.0,
        0.0/0.0
    };

    bool v;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = stdlib_base_float64_is_same_value( a[ i ], b[ 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.