Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero

Test if two single-precision floating-point numbers are the same value.
https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero

assert assertion equal is isequal issame issamevalue isstrictequal javascript node node-js nodejs same stdlib strict type util utilities utility utils

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README 

        



  

    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



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



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



## Installation



```bash

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][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] 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



```javascript

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.



```javascript

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.



```javascript

var bool = ( NaN === NaN );

// returns false



bool = isSameValueZerof( NaN, NaN );

// returns true

```



In contrast to the [SameValue Algorithm][@stdlib/number/float32/base/assert/is-same-value] (as specified in ECMAScript 5), the function does not distinguish between `+0` and `-0`.



```javascript

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



```javascript

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



```c

#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.



```c

#include 



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.



```c

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

```



### Examples



```c

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

#include 

#include 



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][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/number-float32-base-assert-is-same-value-zero.svg

[npm-url]: https://npmjs.org/package/@stdlib/number-float32-base-assert-is-same-value-zero



[test-image]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float32-base-assert-is-same-value-zero/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/number-float32-base-assert-is-same-value-zero?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/tree/deno

[deno-readme]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/tree/umd

[umd-readme]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/tree/esm

[esm-readme]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value-zero/blob/main/branches.md



[@stdlib/number/float32/base/assert/is-same-value]: https://github.com/stdlib-js/number-float32-base-assert-is-same-value