feat: add assert/is-almost-equal-array

PR-URL: #7690

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

Author: anandkaranubc

lib/node_modules/@stdlib/assert/is-almost-equal-array/README.md

@@ -0,0 +1,113 @@
+<!--
+
+@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.
+
+-->
+
+# isAlmostEqualArray
+
+> Test if two arguments are both generic arrays and contain respective elements which are [approximately equal][@stdlib/assert/is-almost-equal] within a specified number of ULPs (units in the last place).
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isAlmostEqualArray = require( '@stdlib/assert/is-almost-equal-array' );
+```
+
+#### isAlmostEqualArray( v1, v2, maxULP )
+
+Tests if two arguments are both generic arrays and contain respective elements which are [approximately equal][@stdlib/assert/is-almost-equal] within a specified number of ULPs (units in the last place).
+
+```javascript
+var EPS = require( '@stdlib/constants/float64/eps' );
+
+var x = [ 1.0, 2.0 ];
+var y = [ 1.0+EPS, 2.0 ];
+
+var bool = isAlmostEqualArray( x, y, 0 );
+// returns false
+
+bool = isAlmostEqualArray( x, y, 1 );
+// returns true
+
+bool = isAlmostEqualArray( x, [ -1.0, 2.0 ], 1 );
+// returns false
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The function returns `false` if either input value is a generic array containing `NaN`.
+-   The function does not distinguish between `-0` and `+0`, treating them as equal.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var isAlmostEqualArray = require( '@stdlib/assert/is-almost-equal-array' );
+
+var x = [ 1.0, 2.0, 3.0 ];
+var y = [ 1.0, 2.0, 3.0 ];
+var out = isAlmostEqualArray( x, y, 0 );
+// returns true
+
+x = [ -0.0, 0.0, -0.0 ];
+y = [ 0.0, -0.0, 0.0 ];
+out = isAlmostEqualArray( x, y, 1 );
+// returns true
+
+x = [ NaN, NaN, NaN ];
+y = [ NaN, NaN, NaN ];
+out = isAlmostEqualArray( x, y, 0 );
+// returns 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">
+
+[@stdlib/assert/is-almost-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-equal
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/assert/is-almost-equal-array/benchmark/benchmark.length.js

@@ -0,0 +1,96 @@
+/**
+* @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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pow = require( '@stdlib/math/base/special/pow' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var isAlmostEqualArray = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = zeroTo( len );
+	var y = zeroTo( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var bool;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			bool = isAlmostEqualArray( x, y, 1 );
+			if ( typeof bool !== 'boolean' ) {
+				b.fail( 'should return a boolean' );
+			}
+		}
+		b.toc();
+		if ( !isBoolean( bool ) ) {
+			b.fail( 'should return a boolean' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/assert/is-almost-equal-array/docs/repl.txt

@@ -0,0 +1,43 @@
+
+{{alias}}( v1, v2, maxULP )
+    Tests if two arguments are both generic arrays and contain respective
+    elements which are approximately equal within a specified number of ULPs
+    (units in the last place).
+
+    The function returns `false` if either input value is a generic array
+    containing `NaN`.
+
+    The function does not distinguish between `-0` and `+0`, treating them as
+    equal.
+
+    Parameters
+    ----------
+    v1: any
+        First input value.
+
+    v2: any
+        Second input value.
+
+    maxULP: integer
+        Maximum allowed ULP difference.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether two arguments are approximately equal.
+
+    Examples
+    --------
+    > var x = [ 1.0, 2.0, 3.0 ];
+    > var y = [ 1.0, 2.0, 3.0 ];
+    > var bool = {{alias}}( x, y, 0 )
+    true
+
+    > x = [ NaN, NaN, NaN ];
+    > y = [ NaN, NaN, NaN ];
+    > bool = {{alias}}( x, y, 1 )
+    false
+
+    See Also
+    --------
+

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

@@ -0,0 +1,53 @@
+/*
+* @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
+
+/**
+* Tests if two arguments are both generic arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).
+*
+* ## Notes
+*
+* -   The function returns `false` if either input value is a generic array containing `NaN`.
+* -   The function does not distinguish between `-0` and `+0`, treating them as equal.
+*
+* @param v1 - first input value
+* @param v2 - second input value
+* @param maxULP - maximum allowed ULP difference
+* @returns boolean indicating whether two arguments are approximately equal
+*
+* @example
+* var x = [ 1.0, 2.0, 3.0 ];
+* var y = [ 1.0, 2.0, 3.0 ];
+*
+* var out = isAlmostEqualArray( x, y, 0 );
+* // returns true
+*
+* @example
+* var x = [ 1.0, 2.0, 3.0 ];
+* var y = [ 1.0, 2.0, 4.0 ];
+*
+* var out = isAlmostEqualArray( x, y, 1 );
+* // returns false
+*/
+declare function isAlmostEqualArray( v1: any, v2: any, maxULP: number ): boolean;
+
+
+// EXPORTS //
+
+export = isAlmostEqualArray;

lib/node_modules/@stdlib/assert/is-almost-equal-array/docs/types/test.ts

@@ -0,0 +1,49 @@
+/*
+* @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 isAlmostEqualArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isAlmostEqualArray( 3.14, 3.14, 1 ); // $ExpectType boolean
+	isAlmostEqualArray( null, null, 1 ); // $ExpectType boolean
+	isAlmostEqualArray( 'beep', 'boop', 1 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided a third argument which is not a number...
+{
+	isAlmostEqualArray( 3.14, 3.14, '1' ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, true ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, false ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, null ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, undefined ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, [] ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, {} ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isAlmostEqualArray(); // $ExpectError
+	isAlmostEqualArray( 3.14 ); // $ExpectError
+	isAlmostEqualArray( 3.14, 3.14 ); // $ExpectError
+	isAlmostEqualArray( 'beep', 'beep', 2, {} ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-almost-equal-array/examples/index.js

@@ -0,0 +1,39 @@
+/**
+* @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';
+
+var isAlmostEqualArray = require( './../lib' );
+
+var x = [ 1.0, 2.0, 3.0 ];
+var y = [ 1.0, 2.0, 3.0 ];
+var out = isAlmostEqualArray( x, y, 0 );
+console.log( out );
+// => true
+
+x = [ -0.0, 0.0, -0.0 ];
+y = [ 0.0, -0.0, 0.0 ];
+out = isAlmostEqualArray( x, y, 1 );
+console.log( out );
+// => true
+
+x = [ NaN, NaN, NaN ];
+y = [ NaN, NaN, NaN ];
+out = isAlmostEqualArray( x, y, 0 );
+console.log( out );
+// => false