README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isSameValueZerof

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

Installation

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

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var isSameValueZerof = require( '@stdlib/number-float32-base-assert-is-same-value-zero' );

isSameValueZerof( a, b )

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

var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );

var bool = isSameValueZerof( toFloat32( 3.14 ), toFloat32( 3.14 ) );
// returns true

bool = isSameValueZerof( toFloat32( 5.0 ), toFloat32( 3.0 ) );
// returns false

In contrast to the strict equality operator ===, the function treats NaNs as the same value.

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

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

In contrast to the SameValue Algorithm (as specified in ECMAScript 5), the function does not distinguish between +0 and -0.

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

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

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

Examples

var toFloat32 = require( '@stdlib/number-float64-base-to-float32' );
var isSameValueZerof = require( '@stdlib/number-float32-base-assert-is-same-value-zero' );

var bool = isSameValueZerof( toFloat32( 3.14 ), toFloat32( 3.14 ) );
// returns true

bool = isSameValueZerof( toFloat32( 0.0 ), toFloat32( 0.0 ) );
// returns true

bool = isSameValueZerof( toFloat32( -0.0 ), toFloat32( 0.0 ) );
// returns true

bool = isSameValueZerof( toFloat32( NaN ), toFloat32( NaN ) );
// returns true

---

C APIs

Usage

#include "stdlib/number/float32/base/assert/is_same_value_zero.h"

stdlib_base_float32_is_same_value_zero( a, b )

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

#include <stdbool.h>

bool v = stdlib_base_float32_is_same_value_zero( 3.14f, 3.14f );
// returns true

v = stdlib_base_float32_is_same_value_zero( 0.0f, -0.0f );
// returns true

The function accepts the following arguments:

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

bool stdlib_base_float32_is_same_value_zero( const float a, const float b );

Examples

#include "stdlib/number/float32/base/assert/is_same_value_zero.h"
#include <stdbool.h>
#include <stdio.h>

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

    bool v;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = stdlib_base_float32_is_same_value_zero( 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

---

Copyright

Copyright © 2016-2024. The Stdlib Authors.