fix: rename function

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: anandkaranubc

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

@@ -18,7 +18,7 @@ limitations under the License.
 
 -->
 
-# isAlmostEqualValue
+# isAlmostEqual
 
 > Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
 
@@ -37,10 +37,10 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var isAlmostEqualValue = require( '@stdlib/complex/float64/base/assert/is-almost-equal-value' );
+var isAlmostEqual = require( '@stdlib/complex/float64/base/assert/is-almost-equal' );
 ```
 
-#### isAlmostEqualValue( z1, z2, maxULP )
+#### 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).
 
@@ -51,10 +51,10 @@ 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 = isAlmostEqualValue( z1, z2, 0 );
+var out = isAlmostEqual( z1, z2, 0 );
 // returns false
 
-out = isAlmostEqualValue( z1, z2, 1 );
+out = isAlmostEqual( z1, z2, 1 );
 // returns true
 ```
 
@@ -66,16 +66,16 @@ var Complex128 = require( '@stdlib/complex/float64/ctor' );
 var z1 = new Complex128( NaN, 3.0 );
 var z2 = new Complex128( 1.0, 3.0 );
 
-var out = isAlmostEqualValue( z1, z2, 1 );
+var out = isAlmostEqual( z1, z2, 1 );
 // returns false
 
-out = isAlmostEqualValue( z2, z1, 1 );
+out = isAlmostEqual( z2, z1, 1 );
 // returns false
 
 z1 = new Complex128( NaN, NaN );
 z2 = new Complex128( NaN, NaN );
 
-out = isAlmostEqualValue( z1, z2, 1 );
+out = isAlmostEqual( z1, z2, 1 );
 // returns false
 ```
 
@@ -87,7 +87,7 @@ 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 = isAlmostEqualValue( z1, z2, 0 );
+var out = isAlmostEqual( z1, z2, 0 );
 // returns true
 ```
 
@@ -114,26 +114,26 @@ var out = isAlmostEqualValue( z1, z2, 0 );
 ```javascript
 var EPS = require( '@stdlib/constants/float64/eps' );
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var isAlmostEqualValue = require( '@stdlib/complex/float64/base/assert/is-almost-equal-value' );
+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( isAlmostEqualValue( z1, z2, 1 ) );
+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( isAlmostEqualValue( z1, z2, 1 ) );
+console.log( isAlmostEqual( z1, z2, 1 ) );
 // => false
 
 z1 = new Complex128( 0.0, 0.0 );
 z2 = new Complex128( -0.0, 0.0 );
-console.log( isAlmostEqualValue( z1, z2, 0 ) );
+console.log( isAlmostEqual( z1, z2, 0 ) );
 // => true
 
 z1 = new Complex128( NaN, 0.0 );
 z2 = new Complex128( 1.0, 0.0 );
-console.log( isAlmostEqualValue( z1, z2, 1 ) );
+console.log( isAlmostEqual( z1, z2, 1 ) );
 // => false
 ```
 

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

@@ -25,7 +25,7 @@ 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 isAlmostEqualValue = require( './../lib' );
+var isAlmostEqual = require( './../lib' );
 
 
 // MAIN //
@@ -49,7 +49,7 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = isAlmostEqualValue( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
+		v = isAlmostEqual( z1[ i%z1.length ], z2[ i%z2.length ], 1 );
 		if ( typeof v !== 'boolean' ) {
 			b.fail( 'should return a boolean' );
 		}

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal-value/docs/repl.txt renamed to lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/docs/repl.txt

@@ -40,15 +40,15 @@ import 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 = isAlmostEqualValue( z1, z2, 0 );
+* var bool = isAlmostEqual( z1, z2, 0 );
 * // returns false
 *
-* bool = isAlmostEqualValue( z1, z2, 1 );
+* bool = isAlmostEqual( z1, z2, 1 );
 * // returns true
 */
-declare function isAlmostEqualValue( z1: Complex128, z2: Complex128, maxULP: number ): boolean;
+declare function isAlmostEqual( z1: Complex128, z2: Complex128, maxULP: number ): boolean;
 
 
 // EXPORTS //
 
-export = isAlmostEqualValue;
+export = isAlmostEqual;

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

@@ -17,7 +17,7 @@
 */
 
 import Complex128 = require( '@stdlib/complex/float64/ctor' );
-import isAlmostEqualValue = require( './index' );
+import isAlmostEqual = require( './index' );
 
 
 // TESTS //
@@ -27,42 +27,42 @@ import isAlmostEqualValue = require( './index' );
 	const z1 = new Complex128( 5.0, 3.0 );
 	const z2 = new Complex128( 5.0, 3.0 );
 
-	isAlmostEqualValue( z1, z2, 1 ); // $ExpectType boolean
+	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 );
 
-	isAlmostEqualValue( 'abc', z2, 1 ); // $ExpectError
-	isAlmostEqualValue( 123, z2, 1 ); // $ExpectError
-	isAlmostEqualValue( true, z2, 1 ); // $ExpectError
-	isAlmostEqualValue( false, z2, 1 ); // $ExpectError
-	isAlmostEqualValue( [], z2, 1 ); // $ExpectError
-	isAlmostEqualValue( {}, z2, 1 ); // $ExpectError
-	isAlmostEqualValue( ( x: number ): number => x, z2, 1 ); // $ExpectError
+	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 );
 
-	isAlmostEqualValue( z1, 'abc', 1 ); // $ExpectError
-	isAlmostEqualValue( z1, 123, 1 ); // $ExpectError
-	isAlmostEqualValue( z1, true, 1 ); // $ExpectError
-	isAlmostEqualValue( z1, false, 1 ); // $ExpectError
-	isAlmostEqualValue( z1, [], 1 ); // $ExpectError
-	isAlmostEqualValue( z1, {}, 1 ); // $ExpectError
-	isAlmostEqualValue( z1, ( x: number ): number => x, 1 ); // $ExpectError
+	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 );
 
-	isAlmostEqualValue(); // $ExpectError
-	isAlmostEqualValue( z1 ); // $ExpectError
-	isAlmostEqualValue( z1, z2 ); // $ExpectError
-	isAlmostEqualValue( z1, z2, 1, 1 ); // $ExpectError
+	isAlmostEqual(); // $ExpectError
+	isAlmostEqual( z1 ); // $ExpectError
+	isAlmostEqual( z1, z2 ); // $ExpectError
+	isAlmostEqual( z1, z2, 1, 1 ); // $ExpectError
 }

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

@@ -20,24 +20,24 @@
 
 var EPS = require( '@stdlib/constants/float64/eps' );
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var isAlmostEqualValue = require( './../lib' );
+var isAlmostEqual = require( './../lib' );
 
 var z1 = new Complex128( 1.0, 3.0+EPS );
 var z2 = new Complex128( 1.0+EPS, 3.0 );
-console.log( isAlmostEqualValue( z1, z2, 1 ) );
+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( isAlmostEqualValue( z1, z2, 1 ) );
+console.log( isAlmostEqual( z1, z2, 1 ) );
 // => false
 
 z1 = new Complex128( 0.0, 0.0 );
 z2 = new Complex128( -0.0, 0.0 );
-console.log( isAlmostEqualValue( z1, z2, 0 ) );
+console.log( isAlmostEqual( z1, z2, 0 ) );
 // => true
 
 z1 = new Complex128( NaN, 0.0 );
 z2 = new Complex128( 1.0, 0.0 );
-console.log( isAlmostEqualValue( z1, z2, 1 ) );
+console.log( isAlmostEqual( z1, z2, 1 ) );
 // => false

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal-value/examples/index.js renamed to lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/examples/index.js

@@ -21,20 +21,20 @@
 /**
 * Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).
 *
-* @module @stdlib/complex/float64/base/assert/is-almost-equal-value
+* @module @stdlib/complex/float64/base/assert/is-almost-equal
 *
 * @example
 * var EPS = require( '@stdlib/constants/float64/eps' );
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var isAlmostEqualValue = require( '@stdlib/complex/float64/base/assert/is-almost-equal-value' );
+* var isAlmostEqual = require( '@stdlib/complex/float64/base/assert/is-almost-equal' );
 *
 * var z1 = new Complex128( 1.0, 3.0 );
 * var z2 = new Complex128( 1.0+EPS, 3.0 );
 *
-* var bool = isAlmostEqualValue( z1, z2, 0 );
+* var bool = isAlmostEqual( z1, z2, 0 );
 * // returns false
 *
-* bool = isAlmostEqualValue( z1, z2, 1 );
+* bool = isAlmostEqual( z1, z2, 1 );
 * // returns true
 */
 

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal-value/lib/index.js renamed to lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/lib/index.js

@@ -20,6 +20,7 @@
 
 // MODULES //
 
+// TODO: Update the import path to the correct package once the package is renamed.
 var isAlmostEqualValueF64 = require( '@stdlib/number/float64/base/assert/is-almost-equal-value' );
 var reim = require( '@stdlib/complex/float64/reim' );
 
@@ -46,13 +47,13 @@ var reim = require( '@stdlib/complex/float64/reim' );
 * var z1 = new Complex128( 1.0, 3.0 );
 * var z2 = new Complex128( 1.0+EPS, 3.0 );
 *
-* var bool = isAlmostEqualValue( z1, z2, 0 );
+* var bool = isAlmostEqual( z1, z2, 0 );
 * // returns false
 *
-* bool = isAlmostEqualValue( z1, z2, 1 );
+* bool = isAlmostEqual( z1, z2, 1 );
 * // returns true
 */
-function isAlmostEqualValue( z1, z2, maxULP ) {
+function isAlmostEqual( z1, z2, maxULP ) {
 	var parts1 = reim( z1 );
 	var parts2 = reim( z2 );
 	return (
@@ -64,4 +65,4 @@ function isAlmostEqualValue( z1, z2, maxULP ) {
 
 // EXPORTS //
 
-module.exports = isAlmostEqualValue;
+module.exports = isAlmostEqual;

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal-value/lib/main.js renamed to lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/lib/main.js

@@ -1,5 +1,5 @@
 {
-  "name": "@stdlib/complex/float64/base/assert/is-almost-equal-value",
+  "name": "@stdlib/complex/float64/base/assert/is-almost-equal",
   "version": "0.0.0",
   "description": "Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).",
   "license": "Apache-2.0",