feat: add complex/float64/base/assert/is-almost-equal

PR-URL: #7620
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]>

Author: anandkaranubc

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/README.md

@@ -0,0 +1,158 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+# isAlmostEqual
+
+> Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
+
+<!-- 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 isAlmostEqual = require( '@stdlib/complex/float64/base/assert/is-almost-equal' );
+```
+
+#### isAlmostEqual( z1, z2, maxULP )
+
+Tests whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
+
+```javascript
+var EPS = require( '@stdlib/constants/float64/eps' );
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+var z1 = new Complex128( 1.0, 3.0 );
+var z2 = new Complex128( 1.0+EPS, 3.0 );
+
+var out = isAlmostEqual( z1, z2, 0 );
+// returns false
+
+out = isAlmostEqual( z1, z2, 1 );
+// returns true
+```
+
+The function returns `false` if either input value has a `NaN` real or imaginary component.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+
+var z1 = new Complex128( NaN, 3.0 );
+var z2 = new Complex128( 1.0, 3.0 );
+
+var out = isAlmostEqual( z1, z2, 1 );
+// returns false
+
+out = isAlmostEqual( z2, z1, 1 );
+// returns false
+
+z1 = new Complex128( NaN, NaN );
+z2 = new Complex128( NaN, NaN );
+
+out = isAlmostEqual( z1, z2, 1 );
+// returns false
+```
+
+The function does not distinguish between `-0` and `+0`, treating them as equal.
+
+```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 = isAlmostEqual( z1, z2, 0 );
+// 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 EPS = require( '@stdlib/constants/float64/eps' );
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+var isAlmostEqual = require( '@stdlib/complex/float64/base/assert/is-almost-equal' );
+
+var z1 = new Complex128( 1.0, 3.0+EPS );
+var z2 = new Complex128( 1.0+EPS, 3.0 );
+console.log( isAlmostEqual( z1, z2, 1 ) );
+// => true
+
+z1 = new Complex128( 1.0, 3.0+EPS );
+z2 = new Complex128( 1.0+EPS+EPS, 3.0 );
+console.log( isAlmostEqual( z1, z2, 1 ) );
+// => false
+
+z1 = new Complex128( 0.0, 0.0 );
+z2 = new Complex128( -0.0, 0.0 );
+console.log( isAlmostEqual( z1, z2, 0 ) );
+// => true
+
+z1 = new Complex128( NaN, 0.0 );
+z2 = new Complex128( 1.0, 0.0 );
+console.log( isAlmostEqual( z1, z2, 1 ) );
+// => false
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/benchmark/benchmark.js

@@ -0,0 +1,63 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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 isAlmostEqual = 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 = isAlmostEqual( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
+		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-almost-equal/docs/repl.txt

@@ -0,0 +1,45 @@
+
+{{alias}}( z1, z2, maxULP )
+    Tests whether two double-precision complex floating-point numbers are
+    approximately equal within a specified number of ULPs (units in the last
+    place).
+
+    The function returns `false` if either input value has a `NaN` real or
+    imaginary component.
+
+    The function does not distinguish between `-0` and `+0`, treating them as
+    equal.
+
+    Parameters
+    ----------
+    z1: Complex128
+        First complex number.
+
+    z2: Complex128
+        Second complex number.
+
+    maxULP: number
+        Maximum allowed ULP difference.
+
+    Returns
+    -------
+    out: boolean
+        Boolean indicating whether two double-precision complex floating-point
+        numbers are approximately equal within a specified number of ULPs.
+
+    Examples
+    --------
+    > var re1 = 1.0;
+    > var im1 = 3.0;
+    > var re2 = 1.0 + {{alias:@stdlib/constants/float64/eps}};
+    > var im2 = 3.0;
+    > var z1 = new {{alias:@stdlib/complex/float64/ctor}}( re1, im1 );
+    > var z2 = new {{alias:@stdlib/complex/float64/ctor}}( re2, im2 );
+    > var v = {{alias}}( z1, z2, 0 )
+    false
+    > v = {{alias}}( z1, z2, 1 )
+    true
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/docs/types/index.d.ts

@@ -0,0 +1,54 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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 approximately equal within a specified number of ULPs (units in the last place).
+*
+* ## Notes
+*
+* -   The function returns `false` if either input value has a `NaN` real or imaginary component.
+* -   The function does not distinguish between `-0` and `+0`, treating them as equal.
+*
+* @param z1 - first complex number
+* @param z2 - second complex number
+* @param maxULP - maximum allowed ULP difference
+* @returns boolean indicating whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs
+*
+* @example
+* var EPS = require( '@stdlib/constants/float64/eps' );
+* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+*
+* var z1 = new Complex128( 1.0, 3.0 );
+* var z2 = new Complex128( 1.0+EPS, 3.0 );
+*
+* var bool = isAlmostEqual( z1, z2, 0 );
+* // returns false
+*
+* bool = isAlmostEqual( z1, z2, 1 );
+* // returns true
+*/
+declare function isAlmostEqual( z1: Complex128, z2: Complex128, maxULP: number ): boolean;
+
+
+// EXPORTS //
+
+export = isAlmostEqual;

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/docs/types/test.ts

@@ -0,0 +1,68 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+import Complex128 = require( '@stdlib/complex/float64/ctor' );
+import isAlmostEqual = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	const z1 = new Complex128( 5.0, 3.0 );
+	const z2 = new Complex128( 5.0, 3.0 );
+
+	isAlmostEqual( z1, z2, 1 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided a first argument that is not a complex number...
+{
+	const z2 = new Complex128( 5.0, 3.0 );
+
+	isAlmostEqual( 'abc', z2, 1 ); // $ExpectError
+	isAlmostEqual( 123, z2, 1 ); // $ExpectError
+	isAlmostEqual( true, z2, 1 ); // $ExpectError
+	isAlmostEqual( false, z2, 1 ); // $ExpectError
+	isAlmostEqual( [], z2, 1 ); // $ExpectError
+	isAlmostEqual( {}, z2, 1 ); // $ExpectError
+	isAlmostEqual( ( x: number ): number => x, z2, 1 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument that is not a complex number...
+{
+	const z1 = new Complex128( 5.0, 3.0 );
+
+	isAlmostEqual( z1, 'abc', 1 ); // $ExpectError
+	isAlmostEqual( z1, 123, 1 ); // $ExpectError
+	isAlmostEqual( z1, true, 1 ); // $ExpectError
+	isAlmostEqual( z1, false, 1 ); // $ExpectError
+	isAlmostEqual( z1, [], 1 ); // $ExpectError
+	isAlmostEqual( z1, {}, 1 ); // $ExpectError
+	isAlmostEqual( z1, ( x: number ): number => x, 1 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const z1 = new Complex128( 5.0, 3.0 );
+	const z2 = new Complex128( 5.0, 3.0 );
+
+	isAlmostEqual(); // $ExpectError
+	isAlmostEqual( z1 ); // $ExpectError
+	isAlmostEqual( z1, z2 ); // $ExpectError
+	isAlmostEqual( z1, z2, 1, 1 ); // $ExpectError
+}