remove: remove complex/base/assert/is-equal

This commit removes `@stdlib/complex/base/assert/is-equal` in favor of `@stdlib/complex/float64/base/assert/is-equal`. BREAKING CHANGE: remove `complex/base/assert/is-equal` To migrate, users should update their require/import paths to use `@stdlib/complex/float64/base/assert/is-equal` which provides the same API and implementation. Ref: #2260
stdlib-js · May 25, 2024 · 0be60c5 · 0be60c5
1 parent 55df587
commit 0be60c5
Show file tree

Hide file tree

Showing 22 changed files with 21 additions and 102 deletions.
diff --git a/lib/node_modules/@stdlib/complex/base/assert/README.md b/lib/node_modules/@stdlib/complex/base/assert/README.md
@@ -45,7 +45,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
--   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are equal.</span>
+-   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are equal.</span>
 -   <span class="signature">[`isEqualf( z1, z2 )`][@stdlib/complex/base/assert/is-equalf]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are equal.</span>
 -   <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are not equal.</span>
 -   <span class="signature">[`isNotEqualf( z1, z2 )`][@stdlib/complex/base/assert/is-not-equalf]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are not equal.</span>
@@ -103,7 +103,7 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
-[@stdlib/complex/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert/is-equal
+[@stdlib/complex/float64/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-equal
 
 [@stdlib/complex/base/assert/is-equalf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base/assert/is-equalf
 

diff --git a/lib/node_modules/@stdlib/complex/base/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/base/assert/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /* eslint-disable max-lines */
 
-import isEqual = require( '@stdlib/complex/base/assert/is-equal' );
+import isEqual = require( '@stdlib/complex/float64/base/assert/is-equal' );
 import isEqualf = require( '@stdlib/complex/base/assert/is-equalf' );
 import isNotEqual = require( '@stdlib/complex/base/assert/is-not-equal' );
 import isNotEqualf = require( '@stdlib/complex/base/assert/is-not-equalf' );

diff --git a/lib/node_modules/@stdlib/complex/base/assert/lib/index.js b/lib/node_modules/@stdlib/complex/base/assert/lib/index.js
@@ -18,15 +18,6 @@
 
 'use strict';
 
-/*
-* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
-*/
-
-// MODULES //
-
-var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
-
-
 // MAIN //
 
 /**
@@ -36,78 +27,6 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
 */
 var ns = {};
 
-/**
-* @name isEqual
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-equal}
-*/
-setReadOnly( ns, 'isEqual', require( '@stdlib/complex/base/assert/is-equal' ) );
-
-/**
-* @name isEqualf
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-equalf}
-*/
-setReadOnly( ns, 'isEqualf', require( '@stdlib/complex/base/assert/is-equalf' ) );
-
-/**
-* @name isNotEqual
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-not-equal}
-*/
-setReadOnly( ns, 'isNotEqual', require( '@stdlib/complex/base/assert/is-not-equal' ) );
-
-/**
-* @name isNotEqualf
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-not-equalf}
-*/
-setReadOnly( ns, 'isNotEqualf', require( '@stdlib/complex/base/assert/is-not-equalf' ) );
-
-/**
-* @name isSameValue
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-same-value}
-*/
-setReadOnly( ns, 'isSameValue', require( '@stdlib/complex/base/assert/is-same-value' ) );
-
-/**
-* @name isSameValueZero
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-same-value-zero}
-*/
-setReadOnly( ns, 'isSameValueZero', require( '@stdlib/complex/base/assert/is-same-value-zero' ) );
-
-/**
-* @name isSameValueZerof
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-same-value-zerof}
-*/
-setReadOnly( ns, 'isSameValueZerof', require( '@stdlib/complex/base/assert/is-same-value-zerof' ) );
-
-/**
-* @name isSameValuef
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/base/assert/is-same-valuef}
-*/
-setReadOnly( ns, 'isSameValuef', require( '@stdlib/complex/base/assert/is-same-valuef' ) );
-
 
 // EXPORTS //
 

diff --git a/...ib/complex/base/assert/is-equal/README.md → ...ex/float64/base/assert/is-equal/README.md b/...ib/complex/base/assert/is-equal/README.md → ...ex/float64/base/assert/is-equal/README.md
@@ -37,7 +37,7 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var isEqual = require( '@stdlib/complex/base/assert/is-equal' );
+var isEqual = require( '@stdlib/complex/float64/base/assert/is-equal' );
 ```
 
 #### isEqual( z1, z2 )
@@ -76,7 +76,7 @@ var out = isEqual( z1, z2 );
 
 ```javascript
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var isEqual = require( '@stdlib/complex/base/assert/is-equal' );
+var isEqual = require( '@stdlib/complex/float64/base/assert/is-equal' );
 
 var z1 = new Complex128( 5.0, 3.0 );
 var z2 = new Complex128( 5.0, 3.0 );
@@ -121,7 +121,7 @@ out = isEqual( z1, z2 );
 ### Usage
 
 ```c
-#include "stdlib/complex/base/assert/is_equal.h"
+#include "stdlib/complex/float64/base/assert/is_equal.h"
 ```
 
 #### stdlib_base_complex128_is_equal( z1, z2 )
@@ -166,7 +166,7 @@ bool stdlib_base_complex128_is_equal( const stdlib_complex128_t z1, const stdlib
 ### Examples
 
 ```c
-#include "stdlib/complex/base/assert/is_equal.h"
+#include "stdlib/complex/float64/base/assert/is_equal.h"
 #include "stdlib/complex/float64/ctor.h"
 #include <stdbool.h>
 #include <stdio.h>

diff --git a/...se/assert/is-equal/benchmark/benchmark.js → ...se/assert/is-equal/benchmark/benchmark.js b/...se/assert/is-equal/benchmark/benchmark.js → ...se/assert/is-equal/benchmark/benchmark.js
diff --git a/...omplex/base/assert/is-equal/docs/repl.txt → ...loat64/base/assert/is-equal/docs/repl.txt b/...omplex/base/assert/is-equal/docs/repl.txt → ...loat64/base/assert/is-equal/docs/repl.txt
@@ -17,8 +17,8 @@
 
     Examples
     --------
-    > var z1 = new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 );
-    > var z2 = new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 );
+    > 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
 

diff --git a/...ase/assert/is-equal/docs/types/index.d.ts → ...ase/assert/is-equal/docs/types/index.d.ts b/...ase/assert/is-equal/docs/types/index.d.ts → ...ase/assert/is-equal/docs/types/index.d.ts
diff --git a/...x/base/assert/is-equal/docs/types/test.ts → ...4/base/assert/is-equal/docs/types/test.ts b/...x/base/assert/is-equal/docs/types/test.ts → ...4/base/assert/is-equal/docs/types/test.ts
diff --git a/.../base/assert/is-equal/examples/c/Makefile → .../base/assert/is-equal/examples/c/Makefile b/.../base/assert/is-equal/examples/c/Makefile → .../base/assert/is-equal/examples/c/Makefile
diff --git a/...base/assert/is-equal/examples/c/example.c → ...base/assert/is-equal/examples/c/example.c b/...base/assert/is-equal/examples/c/example.c → ...base/assert/is-equal/examples/c/example.c
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-#include "stdlib/complex/base/assert/is_equal.h"
+#include "stdlib/complex/float64/base/assert/is_equal.h"
 #include "stdlib/complex/float64/ctor.h"
 #include <stdbool.h>
 #include <stdio.h>

diff --git a/...ex/base/assert/is-equal/examples/index.js → ...64/base/assert/is-equal/examples/index.js b/...ex/base/assert/is-equal/examples/index.js → ...64/base/assert/is-equal/examples/index.js
diff --git a/...ude/stdlib/complex/base/assert/is_equal.h → ...ib/complex/float64/base/assert/is_equal.h b/...ude/stdlib/complex/base/assert/is_equal.h → ...ib/complex/float64/base/assert/is_equal.h
@@ -16,8 +16,8 @@
 * limitations under the License.
 */
 
-#ifndef STDLIB_COMPLEX_BASE_ASSERT_IS_EQUAL_H
-#define STDLIB_COMPLEX_BASE_ASSERT_IS_EQUAL_H
+#ifndef STDLIB_COMPLEX_FLOAT64_BASE_ASSERT_IS_EQUAL_H
+#define STDLIB_COMPLEX_FLOAT64_BASE_ASSERT_IS_EQUAL_H
 
 #include "stdlib/complex/float64/ctor.h"
 #include <stdbool.h>
@@ -38,4 +38,4 @@ bool stdlib_base_complex128_is_equal( const stdlib_complex128_t z1, const stdlib
 }
 #endif
 
-#endif // !STDLIB_COMPLEX_BASE_ASSERT_IS_EQUAL_H
+#endif // !STDLIB_COMPLEX_FLOAT64_BASE_ASSERT_IS_EQUAL_H
diff --git a/...complex/base/assert/is-equal/lib/index.js → ...float64/base/assert/is-equal/lib/index.js b/...complex/base/assert/is-equal/lib/index.js → ...float64/base/assert/is-equal/lib/index.js
@@ -21,11 +21,11 @@
 /**
 * Test whether two double-precision complex floating-point numbers are equal.
 *
-* @module @stdlib/complex/base/assert/is-equal
+* @module @stdlib/complex/float64/base/assert/is-equal
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var isEqual = require( '@stdlib/complex/base/assert/is-equal' );
+* var isEqual = require( '@stdlib/complex/float64/base/assert/is-equal' );
 *
 * var z1 = new Complex128( 5.0, 3.0 );
 * var z2 = new Complex128( 5.0, 3.0 );

diff --git a/.../complex/base/assert/is-equal/lib/main.js → .../float64/base/assert/is-equal/lib/main.js b/.../complex/base/assert/is-equal/lib/main.js → .../float64/base/assert/is-equal/lib/main.js
diff --git a/...omplex/base/assert/is-equal/manifest.json → ...loat64/base/assert/is-equal/manifest.json b/...omplex/base/assert/is-equal/manifest.json → ...loat64/base/assert/is-equal/manifest.json
diff --git a/...complex/base/assert/is-equal/package.json → ...float64/base/assert/is-equal/package.json b/...complex/base/assert/is-equal/package.json → ...float64/base/assert/is-equal/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@stdlib/complex/base/assert/is-equal",
+  "name": "@stdlib/complex/float64/base/assert/is-equal",
   "version": "0.0.0",
   "description": "Test whether two double-precision complex floating-point numbers are equal.",
   "license": "Apache-2.0",

diff --git a/...b/complex/base/assert/is-equal/src/main.c → ...x/float64/base/assert/is-equal/src/main.c b/...b/complex/base/assert/is-equal/src/main.c → ...x/float64/base/assert/is-equal/src/main.c
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-#include "stdlib/complex/base/assert/is_equal.h"
+#include "stdlib/complex/float64/base/assert/is_equal.h"
 #include "stdlib/complex/reim.h"
 #include "stdlib/complex/float64/ctor.h"
 #include <stdbool.h>

diff --git a/...complex/base/assert/is-equal/test/test.js → ...float64/base/assert/is-equal/test/test.js b/...complex/base/assert/is-equal/test/test.js → ...float64/base/assert/is-equal/test/test.js
diff --git a/lib/node_modules/@stdlib/error/tools/id2pkg/data/data.csv b/lib/node_modules/@stdlib/error/tools/id2pkg/data/data.csv
@@ -1600,7 +1600,7 @@
 "0GW",@stdlib/cli/ctor
 "0GX",@stdlib/cli-ctor
 "0GZ",@stdlib/cli
-"1pY",@stdlib/complex/base/assert/is-equal
+"1pY",@stdlib/complex/float64/base/assert/is-equal
 "1pZ",@stdlib/complex-base-assert-is-equal
 "1pa",@stdlib/complex/base/assert/is-equalf
 "1pb",@stdlib/complex-base-assert-is-equalf

diff --git a/lib/node_modules/@stdlib/error/tools/id2pkg/data/data.json b/lib/node_modules/@stdlib/error/tools/id2pkg/data/data.json
diff --git a/lib/node_modules/@stdlib/error/tools/pkg2id/data/data.csv b/lib/node_modules/@stdlib/error/tools/pkg2id/data/data.csv
@@ -6996,7 +6996,7 @@
 "@stdlib/assert-is-same-float32array",1pV
 "@stdlib/assert/is-same-float64array",1pW
 "@stdlib/assert-is-same-float64array",1pX
-"@stdlib/complex/base/assert/is-equal",1pY
+"@stdlib/complex/float64/base/assert/is-equal",1pY
 "@stdlib/complex-base-assert-is-equal",1pZ
 "@stdlib/complex/base/assert/is-equalf",1pa
 "@stdlib/complex-base-assert-is-equalf",1pb

diff --git a/lib/node_modules/@stdlib/error/tools/pkg2id/data/data.json b/lib/node_modules/@stdlib/error/tools/pkg2id/data/data.json