Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -20,6 +20,7 @@
 
 ##### Features
 
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305) - refactor namespace to export subnamespaces
 -   [`81b48ae`](https://github.com/stdlib-js/stdlib/commit/81b48aeb9d5d2b16fe039f9db7e710c95a35585f) - update namespace TypeScript declarations [(##2621)](#2621)
 
 </section>
@@ -30,6 +31,18 @@
 
 ##### BREAKING CHANGES
 
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305): refactor namespace to export subnamespaces
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305): APIs renamed and/or moved to subnamespaces 
+
+    -   To migrate, users should consult the list of exports to determine
+    which properties moved where. Double-precision APIs moved to the
+    `float64` namespace and single-precision APIs moved to the `float32`
+    namespace. The following properties were renamed:
+    - complexCtors => ctors
+    - complexDataType => dtype
+    - complexDataTypes => dtypes
+    - complexPromotionRules => promotionRules
+
 -   [`7381394`](https://github.com/stdlib-js/stdlib/commit/738139479cf29cbe123d7c5028024983ba11b3bd): remove `complex/reviver-float64` 
 
     -   To migrate, users should update their require/import paths to use
@@ -1671,6 +1684,18 @@ This release closes the following issue:
 
 ### BREAKING CHANGES
 
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305): refactor namespace to export subnamespaces
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305): APIs renamed and/or moved to subnamespaces 
+
+    -   To migrate, users should consult the list of exports to determine
+    which properties moved where. Double-precision APIs moved to the
+    `float64` namespace and single-precision APIs moved to the `float32`
+    namespace. The following properties were renamed:
+    - complexCtors => ctors
+    - complexDataType => dtype
+    - complexDataTypes => dtypes
+    - complexPromotionRules => promotionRules
+
 -   [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): convert `complex/float64` to a namespace
 -   [`d9edc48`](https://github.com/stdlib-js/stdlib/commit/d9edc482b619ce39d6d2b0ed172e85e7cb295ba4): `complex/float64` converted to a namespace 
 
@@ -1851,6 +1876,7 @@ A total of 6 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`565a2ff`](https://github.com/stdlib-js/stdlib/commit/565a2ffe3aa2c7260109cbacf85bf6029c12e305) - **feat:** refactor namespace to export subnamespaces _(by Athan Reines)_
 -   [`ea241a3`](https://github.com/stdlib-js/stdlib/commit/ea241a32e7bbd7f346ff993d932adbd1857108e1) - **feat:** add `assert` to namespace _(by Athan Reines)_
 -   [`69eecad`](https://github.com/stdlib-js/stdlib/commit/69eecadd785a9ba5732e2d136b8755cad6341fd0) - **feat:** add `complex/float32/base/assert` namespace _(by Athan Reines)_
 -   [`c89d08c`](https://github.com/stdlib-js/stdlib/commit/c89d08c3733ca6b6f1fab8d8ebc95663b8190b5e) - **feat:** add `assert` to namespace _(by Athan Reines)_

README.md

@@ -72,67 +72,12 @@ var o = ns;
 // returns {...}
 ```
 
-The namespace constains complex number constructors.
+The namespace contains the following APIs:
 
-<!-- <toc keywords="+data, +structure, +types"> -->
-
-<div class="namespace-toc">
-
--   <span class="signature">[`base`][@stdlib/complex/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) complex number functions.</span>
--   <span class="signature">[`complex( real, imag[, dtype] )`][@stdlib/complex/cmplx]</span><span class="delimiter">: </span><span class="description">create a complex number.</span>
--   <span class="signature">[`complexCtors( dtype )`][@stdlib/complex/ctors]</span><span class="delimiter">: </span><span class="description">complex number constructors.</span>
--   <span class="signature">[`complexDataType( value )`][@stdlib/complex/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of a complex number.</span>
--   <span class="signature">[`complexDataTypes()`][@stdlib/complex/dtypes]</span><span class="delimiter">: </span><span class="description">list of complex number data types.</span>
--   <span class="signature">[`complexPromotionRules( [dtype1, dtype2] )`][@stdlib/complex/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the complex number data type with the smallest size and closest "kind" to which data types can be **safely** cast.</span>
-
-</div>
+<!-- <toc pattern="*"> -->
 
 <!-- </toc> -->
 
-```javascript
-var z = ns.complex( 5.0, 3.0 );
-// returns <Complex128>
-
-var str = z.toString();
-// returns '5 + 3i'
-
-z = ns.complex( 5.0, 3.0, 'float32' );
-// returns <Complex64>
-
-z = new ns.Complex64( 5.0, 3.0 );
-// returns <Complex64>
-```
-
-In addition, the namespace contains the following functions:
-
-<!-- <toc keywords="-data, -structure, -types"> -->
-
-<div class="namespace-toc">
-
--   <span class="signature">[`conj( z )`][@stdlib/complex/float64/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a double-precision complex floating-point number.</span>
--   <span class="signature">[`conjf( z )`][@stdlib/complex/float32/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a single-precision complex floating-point number.</span>
--   <span class="signature">[`imag( z )`][@stdlib/complex/float64/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a double-precision complex floating-point number.</span>
--   <span class="signature">[`imagf( z )`][@stdlib/complex/float32/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a single-precision complex floating-point number.</span>
--   <span class="signature">[`real( z )`][@stdlib/complex/float64/real]</span><span class="delimiter">: </span><span class="description">return the real component of a double-precision complex floating-point number.</span>
--   <span class="signature">[`realf( z )`][@stdlib/complex/float32/real]</span><span class="delimiter">: </span><span class="description">return the real component of a single-precision complex floating-point number.</span>
--   <span class="signature">[`reim( z )`][@stdlib/complex/float64/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a double-precision complex floating-point number.</span>
--   <span class="signature">[`reimf( z )`][@stdlib/complex/float32/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a single-precision complex floating-point number.</span>
--   <span class="signature">[`reviveComplex( key, value )`][@stdlib/complex/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized complex number.</span>
-
-</div>
-
-<!-- </toc> -->
-
-```javascript
-var z = ns.complex( 5.0, 3.0 );
-var str = z.toString();
-// returns '5 + 3i'
-
-var v = ns.conj( z );
-str = v.toString();
-// returns '5 - 3i'
-```
-
 </section>
 
 <!-- /.usage -->
@@ -236,40 +181,6 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex/main/LICENSE
 
-<!-- <toc-links> -->
-
-[@stdlib/complex/float64/conj]: https://github.com/stdlib-js/complex/tree/main/float64/conj
-
-[@stdlib/complex/float32/conj]: https://github.com/stdlib-js/complex/tree/main/float32/conj
-
-[@stdlib/complex/float64/imag]: https://github.com/stdlib-js/complex/tree/main/float64/imag
-
-[@stdlib/complex/float32/imag]: https://github.com/stdlib-js/complex/tree/main/float32/imag
-
-[@stdlib/complex/float64/real]: https://github.com/stdlib-js/complex/tree/main/float64/real
-
-[@stdlib/complex/float32/real]: https://github.com/stdlib-js/complex/tree/main/float32/real
-
-[@stdlib/complex/float64/reim]: https://github.com/stdlib-js/complex/tree/main/float64/reim
-
-[@stdlib/complex/float32/reim]: https://github.com/stdlib-js/complex/tree/main/float32/reim
-
-[@stdlib/complex/reviver]: https://github.com/stdlib-js/complex/tree/main/reviver
-
-[@stdlib/complex/base]: https://github.com/stdlib-js/complex/tree/main/base
-
-[@stdlib/complex/cmplx]: https://github.com/stdlib-js/complex/tree/main/cmplx
-
-[@stdlib/complex/ctors]: https://github.com/stdlib-js/complex/tree/main/ctors
-
-[@stdlib/complex/dtype]: https://github.com/stdlib-js/complex/tree/main/dtype
-
-[@stdlib/complex/dtypes]: https://github.com/stdlib-js/complex/tree/main/dtypes
-
-[@stdlib/complex/promotion-rules]: https://github.com/stdlib-js/complex/tree/main/promotion-rules
-
-<!-- </toc-links> -->
-
 </section>
 
 <!-- /.links -->

lib/index.js

@@ -55,148 +55,58 @@ setReadOnly( ns, 'base', require( './../base' ) );
 setReadOnly( ns, 'complex', require( './../cmplx' ) );
 
 /**
-* @name complexCtors
+* @name ctors
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/complex/ctors}
 */
-setReadOnly( ns, 'complexCtors', require( './../ctors' ) );
+setReadOnly( ns, 'ctors', require( './../ctors' ) );
 
 /**
-* @name complexDataType
+* @name dtype
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/complex/dtype}
 */
-setReadOnly( ns, 'complexDataType', require( './../dtype' ) );
+setReadOnly( ns, 'dtype', require( './../dtype' ) );
 
 /**
-* @name complexDataTypes
+* @name dtypes
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/complex/dtypes}
 */
-setReadOnly( ns, 'complexDataTypes', require( './../dtypes' ) );
+setReadOnly( ns, 'dtypes', require( './../dtypes' ) );
 
 /**
-* @name conjf
+* @name float32
 * @memberof ns
 * @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float32/conj}
-*/
-setReadOnly( ns, 'conjf', require( './../float32/conj' ) );
-
-/**
-* @name Complex64
-* @memberof ns
-* @readonly
-* @constructor
-* @see {@link module:@stdlib/complex/float32/ctor}
-*/
-setReadOnly( ns, 'Complex64', require( './../float32/ctor' ) );
-
-/**
-* @name imagf
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float32/imag}
-*/
-setReadOnly( ns, 'imagf', require( './../float32/imag' ) );
-
-/**
-* @name realf
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float32/real}
-*/
-setReadOnly( ns, 'realf', require( './../float32/real' ) );
-
-/**
-* @name reimf
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float32/reim}
-*/
-setReadOnly( ns, 'reimf', require( './../float32/reim' ) );
-
-/**
-* @name reviveComplex64
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float32/reviver}
-*/
-setReadOnly( ns, 'reviveComplex64', require( './../float32/reviver' ) );
-
-/**
-* @name conj
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float64/conj}
-*/
-setReadOnly( ns, 'conj', require( './../float64/conj' ) );
-
-/**
-* @name Complex128
-* @memberof ns
-* @readonly
-* @constructor
-* @see {@link module:@stdlib/complex/float64/ctor}
-*/
-setReadOnly( ns, 'Complex128', require( './../float64/ctor' ) );
-
-/**
-* @name imag
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float64/imag}
-*/
-setReadOnly( ns, 'imag', require( './../float64/imag' ) );
-
-/**
-* @name real
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float64/real}
-*/
-setReadOnly( ns, 'real', require( './../float64/real' ) );
-
-/**
-* @name reim
-* @memberof ns
-* @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float64/reim}
+* @type {Namespace}
+* @see {@link module:@stdlib/complex/float32}
 */
-setReadOnly( ns, 'reim', require( './../float64/reim' ) );
+setReadOnly( ns, 'float32', require( './../float32' ) );
 
 /**
-* @name reviveComplex128
+* @name float64
 * @memberof ns
 * @readonly
-* @type {Function}
-* @see {@link module:@stdlib/complex/float64/reviver}
+* @type {Namespace}
+* @see {@link module:@stdlib/complex/float64}
 */
-setReadOnly( ns, 'reviveComplex128', require( './../float64/reviver' ) );
+setReadOnly( ns, 'float64', require( './../float64' ) );
 
 /**
-* @name complexPromotionRules
+* @name promotionRules
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/complex/promotion-rules}
 */
-setReadOnly( ns, 'complexPromotionRules', require( './../promotion-rules' ) );
+setReadOnly( ns, 'promotionRules', require( './../promotion-rules' ) );
 
 /**
 * @name reviveComplex

package.json

@@ -38,6 +38,7 @@
   "dependencies": {
     "@stdlib/array": "github:stdlib-js/array#main",
     "@stdlib/assert": "github:stdlib-js/assert#main",
+    "@stdlib/math": "github:stdlib-js/math#main",
     "@stdlib/number": "github:stdlib-js/number#main",
     "@stdlib/string": "github:stdlib-js/string#main",
     "@stdlib/types": "github:stdlib-js/types#main",
@@ -46,7 +47,6 @@
   "devDependencies": {
     "@stdlib/bench": "github:stdlib-js/bench#main",
     "@stdlib/constants": "github:stdlib-js/constants#main",
-    "@stdlib/math": "github:stdlib-js/math#main",
     "@stdlib/random": "github:stdlib-js/random#main",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",