https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero
Test whether two single-precision complex floating-point numbers are the same value.
https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero
assert base cmplx compare comparison complex eq equal equality javascript math mathematics node node-js nodejs number same stdlib test validate
Last synced: 20 days ago
JSON representation
Test whether two single-precision complex floating-point numbers are the same value.
- Host: GitHub
- URL: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-07-16T10:42:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T11:01:18.000Z (7 months ago)
- Last Synced: 2024-11-11T07:52:14.815Z (6 months ago)
- Topics: assert, base, cmplx, compare, comparison, complex, eq, equal, equality, javascript, math, mathematics, node, node-js, nodejs, number, same, stdlib, test, validate
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 219 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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 whether two single-precision complex floating-point numbers are the same value.
## Installation
```bash
npm install @stdlib/complex-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/complex-float32-base-assert-is-same-value-zero' );
```
#### isSameValueZerof( z1, z2 )
Tests whether two single-precision complex floating-point numbers are the same value.
```javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var z1 = new Complex64( 5.0, 3.0 );
var z2 = new Complex64( 5.0, 3.0 );
var out = isSameValueZerof( z1, z2 );
// returns true
```
In contrast to the strict equality operator `===`, the function treats `NaNs` as the same value.
```javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var z1 = new Complex64( NaN, NaN );
var z2 = new Complex64( NaN, NaN );
var out = isSameValueZerof( z1, z2 );
// returns true
```
In contrast to the [SameValue Algorithm][@stdlib/complex/float32/base/assert/is-same-value] (as specified in ECMAScript 5), the function does not distinguish between `+0` and `-0`.
```javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var z1 = new Complex64( -0.0, 0.0 );
var z2 = new Complex64( 0.0, -0.0 );
var out = isSameValueZerof( z1, z2 );
// returns true
```
## Examples
```javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var isSameValueZerof = require( '@stdlib/complex-float32-base-assert-is-same-value-zero' );
var z1 = new Complex64( 5.0, 3.0 );
var z2 = new Complex64( 5.0, 3.0 );
var out = isSameValueZerof( z1, z2 );
// returns true
z1 = new Complex64( -5.0, -3.0 );
z2 = new Complex64( 5.0, 3.0 );
out = isSameValueZerof( z1, z2 );
// returns false
z1 = new Complex64( NaN, 3.0 );
z2 = new Complex64( NaN, 3.0 );
out = isSameValueZerof( z1, z2 );
// returns true
```
* * *
## C APIs
### Usage
```c
#include "stdlib/complex/float32/base/assert/is_same_value_zero.h"
```
#### stdlib_base_complex64_is_same_value_zero( z1, z2 )
Tests whether two single-precision complex floating-point numbers are the same value.
```c
#include "stdlib/complex/float32/ctor.h"
#include
stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 2.0f );
stdlib_complex64_t z2 = stdlib_complex64( 5.0f, 2.0f );
bool v = stdlib_base_complex64_is_same_value_zero( z1, z2 );
```
The function accepts the following arguments:
- **z1**: `[in] stdlib_complex64_t` first single-precision complex floating-point number.
- **z2**: `[in] stdlib_complex64_t` second single-precision complex floating-point number.
```c
bool stdlib_base_complex64_is_same_value_zero( const stdlib_complex64_t z1, const stdlib_complex64_t z2 );
```
### Examples
```c
#include "stdlib/complex/float32/base/assert/is_same_value_zero.h"
#include "stdlib/complex/float32/ctor.h"
#include
#include
int main( void ) {
const stdlib_complex64_t z[] = {
stdlib_complex64( 5.0f, 2.0f ),
stdlib_complex64( -2.0f, 1.0f ),
stdlib_complex64( 0.0f, -0.0f ),
stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
};
bool v;
int i;
for ( i = 0; i < 4; i++ ) {
v = stdlib_base_complex64_is_same_value_zero( z[ i ], z[ 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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/complex-float32-base-assert-is-same-value-zero.svg
[npm-url]: https://npmjs.org/package/@stdlib/complex-float32-base-assert-is-same-value-zero
[test-image]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/complex-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/complex-float32-base-assert-is-same-value-zero/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/complex-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/complex-float32-base-assert-is-same-value-zero/tree/deno
[deno-readme]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/tree/umd
[umd-readme]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/tree/esm
[esm-readme]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex-float32-base-assert-is-same-value-zero/main/LICENSE
[@stdlib/complex/float32/base/assert/is-same-value]: https://github.com/stdlib-js/complex-float32-base-assert-is-same-value