Auto-generated commit

stdlib-js · Jul 19, 2024 · 4729d58 · 4729d58
1 parent 7118bd6
commit 4729d58
Show file tree

Hide file tree

Showing 2 changed files with 156 additions and 115 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-07-18)
+## Unreleased (2024-07-19)
 
 <section class="packages">
 
@@ -560,6 +560,41 @@ This release closes the following issue:
 
 <!-- /.package -->
 
+<section class="package" id="math-base-ops-unreleased">
+
+#### [@stdlib/math/base/ops](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628)
+
+</section>
+
+<!-- /.features -->
+
+<section class="breaking-changes">
+
+##### BREAKING CHANGES
+
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations 
+
+    -   To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
+
+</section>
+
+<!-- /.breaking-changes -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="math-base-ops-cadd-unreleased">
 
 #### [@stdlib/math/base/ops/cadd](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/cadd)
@@ -5322,6 +5357,11 @@ This release closes the following issue:
 
 ### BREAKING CHANGES
 
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace TypeScript declarations
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb): update namespace declarations 
+
+    -   To migrate, users should see the guidance found in the relevant commits for namespace refactoring. See issue #2260.
+
 -   [`b82c6f0`](https://github.com/stdlib-js/stdlib/commit/b82c6f020ef6fe6b045fc71ccf773bb18c451303): remove `math/base/ops/cmul` 
 
     -   To migrate, users should update their require/import paths to use
@@ -5423,6 +5463,7 @@ A total of 29 people contributed to this release. Thank you to the following con
 
 <details>
 
+-   [`bd258a3`](https://github.com/stdlib-js/stdlib/commit/bd258a3c2803d841658c7465505966149845a6fb) - **feat:** update namespace TypeScript declarations [(#2628)](https://github.com/stdlib-js/stdlib/pull/2628) _(by stdlib-bot, Athan Reines)_
 -   [`607135f`](https://github.com/stdlib-js/stdlib/commit/607135f297a48a24d8d312a61ddfe98a332b1ca5) - **feat:** add C implementation for `math/base/special/ceilb` [(##2627)](#2627) _(by Gunj Joshi)_
 -   [`d4db8a9`](https://github.com/stdlib-js/stdlib/commit/d4db8a93b0c93cb3392b59ee031ce188399b90a5) - **feat:** add C implementation for `math/base/special/ceil10` [(##2626)](#2626) _(by Gunj Joshi)_
 -   [`5822206`](https://github.com/stdlib-js/stdlib/commit/5822206c2a023cb097ec057ed99b155383db909d) - **fix:** remove unused include in header file [(#2624)](https://github.com/stdlib-js/stdlib/pull/2624) _(by Gunj Joshi)_

diff --git a/base/ops/docs/types/index.d.ts b/base/ops/docs/types/index.d.ts
@@ -20,16 +20,16 @@
 
 /* eslint-disable max-lines */
 
+import caddf = require( '@stdlib/complex/float32/base/add' );
+import cmulf = require( '@stdlib/complex/float32/base/mul' );
+import cadd = require( '@stdlib/complex/float64/base/add' );
+import cmul = require( '@stdlib/complex/float64/base/mul' );
 import add = require( './../../../../base/ops/add' );
 import add3 = require( './../../../../base/ops/add3' );
 import add4 = require( './../../../../base/ops/add4' );
 import add5 = require( './../../../../base/ops/add5' );
 import addf = require( './../../../../base/ops/addf' );
-import cadd = require( '@stdlib/complex/float64/base/add' );
-import caddf = require( '@stdlib/complex/float32/base/add' );
 import cdiv = require( './../../../../base/ops/cdiv' );
-import cmul = require( '@stdlib/complex/float64/base/mul' );
-import cmulf = require( '@stdlib/complex/float32/base/mul' );
 import cneg = require( './../../../../base/ops/cneg' );
 import cnegf = require( './../../../../base/ops/cnegf' );
 import csub = require( './../../../../base/ops/csub' );
@@ -49,6 +49,116 @@ import umuldw = require( './../../../../base/ops/umuldw' );
 * Interface describing the `ops` namespace.
 */
 interface Namespace {
+	/**
+	* Adds two single-precision complex floating-point numbers.
+	*
+	* @param z1 - complex number
+	* @param z2 - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+	* var realf = require( '@stdlib/complex/float32/real' );
+	* var imagf = require( '@stdlib/complex/float32/imag' );
+	*
+	* var z = new Complex64( 5.0, 3.0 );
+	* // returns <Complex64>
+	*
+	* var out = ns.caddf( z, z );
+	* // returns <Complex64>
+	*
+	* var re = realf( out );
+	* // returns 10.0
+	*
+	* var im = imagf( out );
+	* // returns 6.0
+	*/
+	caddf: typeof caddf;
+
+	/**
+	* Multiplies two single-precision complex floating-point numbers.
+	*
+	* @param z1 - complex number
+	* @param z2 - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+	* var realf = require( '@stdlib/complex/float32/real' );
+	* var imagf = require( '@stdlib/complex/float32/imag' );
+	*
+	* var z1 = new Complex64( 5.0, 3.0 );
+	* // returns <Complex64>
+	*
+	* var z2 = new Complex64( -2.0, 1.0 );
+	* // returns <Complex64>
+	*
+	* var out = ns.cmulf( z1, z2 );
+	* // returns <Complex64>
+	*
+	* var re = realf( out );
+	* // returns -13.0
+	*
+	* var im = imagf( out );
+	* // returns -1.0
+	*/
+	cmulf: typeof cmulf;
+
+	/**
+	* Adds two double-precision complex floating-point numbers.
+	*
+	* @param z1 - complex number
+	* @param z2 - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+	* var real = require( '@stdlib/complex/float64/real' );
+	* var imag = require( '@stdlib/complex/float64/imag' );
+	*
+	* var z = new Complex128( 5.0, 3.0 );
+	* // returns <Complex128>
+	*
+	* var out = ns.cadd( z, z );
+	* // returns <Complex128>
+	*
+	* var re = real( out );
+	* // returns 10.0
+	*
+	* var im = imag( out );
+	* // returns 6.0
+	*/
+	cadd: typeof cadd;
+
+	/**
+	* Multiplies two double-precision complex floating-point numbers.
+	*
+	* @param z1 - complex number
+	* @param z2 - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
+	* var real = require( '@stdlib/complex/float64/real' );
+	* var imag = require( '@stdlib/complex/float64/imag' );
+	*
+	* var z1 = new Complex128( 5.0, 3.0 );
+	* // returns <Complex128>
+	*
+	* var z2 = new Complex128( -2.0, 1.0 );
+	* // returns <Complex128>
+	*
+	* var out = ns.cmul( z1, z2 );
+	* // returns <Complex128>
+	*
+	* var re = real( out );
+	* // returns -13.0
+	*
+	* var im = imag( out );
+	* // returns -1.0
+	*/
+	cmul: typeof cmul;
+
 	/**
 	* Computes the sum of two double-precision floating-point numbers `x` and `y`.
 	*
@@ -200,58 +310,6 @@ interface Namespace {
 	*/
 	addf: typeof addf;
 
-	/**
-	* Adds two double-precision complex floating-point numbers.
-	*
-	* @param z1 - complex number
-	* @param z2 - complex number
-	* @returns result
-	*
-	* @example
-	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
-	*
-	* var z = new Complex128( 5.0, 3.0 );
-	* // returns <Complex128>
-	*
-	* var out = ns.cadd( z, z );
-	* // returns <Complex128>
-	*
-	* var re = real( out );
-	* // returns 10.0
-	*
-	* var im = imag( out );
-	* // returns 6.0
-	*/
-	cadd: typeof cadd;
-
-	/**
-	* Adds two single-precision complex floating-point numbers.
-	*
-	* @param z1 - complex number
-	* @param z2 - complex number
-	* @returns result
-	*
-	* @example
-	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
-	*
-	* var z = new Complex64( 5.0, 3.0 );
-	* // returns <Complex64>
-	*
-	* var out = ns.caddf( z, z );
-	* // returns <Complex64>
-	*
-	* var re = realf( out );
-	* // returns 10.0
-	*
-	* var im = imagf( out );
-	* // returns 6.0
-	*/
-	caddf: typeof caddf;
-
 	/**
 	* Divides two double-precision complex floating-point numbers.
 	*
@@ -281,64 +339,6 @@ interface Namespace {
 	*/
 	cdiv: typeof cdiv;
 
-	/**
-	* Multiplies two double-precision complex floating-point numbers.
-	*
-	* @param z1 - complex number
-	* @param z2 - complex number
-	* @returns result
-	*
-	* @example
-	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
-	*
-	* var z1 = new Complex128( 5.0, 3.0 );
-	* // returns <Complex128>
-	*
-	* var z2 = new Complex128( -2.0, 1.0 );
-	* // returns <Complex128>
-	*
-	* var out = ns.cmul( z1, z2 );
-	* // returns <Complex128>
-	*
-	* var re = real( out );
-	* // returns -13.0
-	*
-	* var im = imag( out );
-	* // returns -1.0
-	*/
-	cmul: typeof cmul;
-
-	/**
-	* Multiplies two single-precision complex floating-point numbers.
-	*
-	* @param z1 - complex number
-	* @param z2 - complex number
-	* @returns result
-	*
-	* @example
-	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
-	*
-	* var z1 = new Complex64( 5.0, 3.0 );
-	* // returns <Complex64>
-	*
-	* var z2 = new Complex64( -2.0, 1.0 );
-	* // returns <Complex64>
-	*
-	* var out = ns.cmulf( z1, z2 );
-	* // returns <Complex64>
-	*
-	* var re = realf( out );
-	* // returns -13.0
-	*
-	* var im = imagf( out );
-	* // returns -1.0
-	*/
-	cmulf: typeof cmulf;
-
 	/**
 	* Negates a double-precision complex floating-point number.
 	*