feat: add complex/float64/base/assert/is-same-value-zero

Ref: #2260

lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value-zero/README.md

@@ -0,0 +1,247 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# isSameValueZero
+
+> Test whether two double-precision complex floating-point numbers are the same value.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isSameValueZero = require( '@stdlib/complex/float64/base/assert/is-same-value-zero' );
+```
+
+#### isSameValueZero( z1, z2 )
+
+Tests whether two double-precision complex floating-point numbers are the same value.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+var z1 = new Complex128( 5.0, 3.0 );
+var z2 = new Complex128( 5.0, 3.0 );
+
+var out = isSameValueZero( z1, z2 );
+// returns true
+```
+
+In contrast to the strict equality operator `===`, the function treats `NaNs` as the same value.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+var z1 = new Complex128( NaN, NaN );
+var z2 = new Complex128( NaN, NaN );
+
+var out = isSameValueZero( z1, z2 );
+// returns true
+```
+
+In contrast to the [SameValue Algorithm][@stdlib/complex/float64/base/assert/is-same-value] (as specified in ECMAScript 5), the function does not distinguish between `+0` and `-0`.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+var z1 = new Complex128( -0.0, 0.0 );
+var z2 = new Complex128( 0.0, -0.0 );
+
+var out = isSameValueZero( z1, z2 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+var isSameValueZero = require( '@stdlib/complex/float64/base/assert/is-same-value-zero' );
+
+var z1 = new Complex128( 5.0, 3.0 );
+var z2 = new Complex128( 5.0, 3.0 );
+var out = isSameValueZero( z1, z2 );
+// returns true
+
+z1 = new Complex128( -5.0, -3.0 );
+z2 = new Complex128( 5.0, 3.0 );
+out = isSameValueZero( z1, z2 );
+// returns false
+
+z1 = new Complex128( NaN, 3.0 );
+z2 = new Complex128( NaN, 3.0 );
+out = isSameValueZero( z1, z2 );
+// returns true
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/complex/float64/base/assert/is_same_value_zero.h"
+```
+
+#### stdlib_base_complex128_is_same_value_zero( z1, z2 )
+
+Tests whether two double-precision complex floating-point numbers are the same value.
+
+```c
+#include "stdlib/complex/float64/ctor.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_same_value_zero( 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.
+
+```c
+bool stdlib_base_complex128_is_same_value_zero( const stdlib_complex128_t z1, const stdlib_complex128_t z2 );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/complex/float64/base/assert/is_same_value_zero.h"
+#include "stdlib/complex/float64/ctor.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_same_value_zero( z[ i ], z[ i ] );
+        printf( "Same value? %s\n", ( v ) ? "True" : "False" );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/complex/float64/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-same-value
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value-zero/benchmark/benchmark.js

@@ -0,0 +1,63 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+var randu = require( '@stdlib/random/base/randu' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var isSameValueZero = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var z1;
+	var z2;
+	var v;
+	var i;
+
+	z1 = [
+		new Complex128( randu(), randu() ),
+		new Complex128( randu(), randu() )
+	];
+	z2 = [
+		new Complex128( randu(), randu() ),
+		new Complex128( randu(), randu() ),
+		z1[ 0 ],
+		z1[ 1 ]
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = isSameValueZero( z1[ i%z1.length ], z2[ i%z2.length ] );
+		if ( typeof v !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( v ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value-zero/docs/repl.txt

@@ -0,0 +1,31 @@
+
+{{alias}}( z1, z2 )
+    Tests whether two double-precision complex floating-point numbers are the
+    same value.
+
+    The function differs from the `===` operator in that the function treats
+    `NaNs` as the same value.
+
+    Parameters
+    ----------
+    z1: Complex128
+        First complex number.
+
+    z2: Complex128
+        Second complex number.
+
+    Returns
+    -------
+    out: boolean
+        Result.
+
+    Examples
+    --------
+    > var z1 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 );
+    > var z2 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 );
+    > var v = {{alias}}( z1, z2 )
+    true
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/complex/float64/base/assert/is-same-value-zero/docs/types/index.d.ts

@@ -0,0 +1,48 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+import Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+/**
+* Tests whether two double-precision complex floating-point numbers are the same value.
+*
+* ## Notes
+*
+* -   In contrast to the strict equality operator `===`, `NaNs` are treated as the same value.
+*
+* @param z1 - first complex number
+* @param z2 - second complex number
+* @returns boolean indicating if both complex numbers are the same value
+*
+* @example
+* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+*
+* var z1 = new Complex128( 5.0, 3.0 );
+* var z2 = new Complex128( 5.0, 3.0 );
+*
+* var v = isSameValueZero( z1, z2 );
+* // returns true
+*/
+declare function isSameValueZero( z1: Complex128, z2: Complex128 ): boolean;
+
+
+// EXPORTS //
+
+export = isSameValueZero;