Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-02)
+## Unreleased (2025-06-09)
 
 <section class="features">
 
@@ -34,6 +34,7 @@ This release closes the following issue:
 
 <details>
 
+-   [`568a25d`](https://github.com/stdlib-js/stdlib/commit/568a25d9a472197659a97d53e7c27cbe455f1bbe) - **docs:** update examples for `complex/float32/base/mul` [(#7290)](https://github.com/stdlib-js/stdlib/pull/7290) _(by Shabareesh Shetty)_
 -   [`b228bf3`](https://github.com/stdlib-js/stdlib/commit/b228bf31d96eacac782648edf8c29141d094a59b) - **docs:** update comments _(by Athan Reines)_
 -   [`3b08499`](https://github.com/stdlib-js/stdlib/commit/3b08499dcdae21f946e61da757c0c21da2e8f9ed) - **docs:** change package naming and examples for `complex/float32/base/mul` [(#7167)](https://github.com/stdlib-js/stdlib/pull/7167) _(by Shabareesh Shetty)_
 -   [`a1e230f`](https://github.com/stdlib-js/stdlib/commit/a1e230f29297caa89880e9c194c615a0400fb7bc) - **chore:** clean up cppcheck-suppress comments _(by Karan Anand)_

CONTRIBUTORS

@@ -22,6 +22,7 @@ AlyAbdelmoneim <[email protected]>
 Aman Bhansali <[email protected]>
 AmanBhadkariya <[email protected]>
 Amit Jimiwal <[email protected]>
+Annamalai Prabu <[email protected]>
 Anshu Kumar <[email protected]>
 Anshu Kumar <[email protected]>
 Anudeep Sanapala <[email protected]>
@@ -38,6 +39,7 @@ Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
 Deep Trivedi <[email protected]>
+Deepak Singh <[email protected]>
 Desh Deepak Kant <[email protected]>
 Dev Goel <[email protected]>
 Dhanyabad behera <[email protected]>
@@ -53,6 +55,7 @@ Frank Kovacs <[email protected]>
 GK Bishnoi <[email protected]>
 GURU PRASAD SHARMA <[email protected]>
 Gaurav <[email protected]>
+Gautam Kaushik <[email protected]>
 Gautam sharma <[email protected]>
 Girish Garg <[email protected]>
 Golden Kumar <[email protected]>
@@ -118,6 +121,7 @@ Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
+Pierre Forstmann <[email protected]>
 Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>

README.md

@@ -75,20 +75,12 @@ Multiples two single-precision complex floating-point numbers.
 
 ```javascript
 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 );
 var z2 = new Complex64( -2.0, 1.0 );
 
 var v = mul( z1, z2 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns -13.0
-
-var im = imagf( v );
-// returns -1.0
+// returns <Complex64>[ -13.0, -1.0 ]
 ```
 
 #### mul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )

dist/index.js.map

@@ -36,23 +36,12 @@ interface Mul {
 	*
 	* @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 = mul( z1, z2 );
-	* // returns <Complex64>
-	*
-	* var re = realf( out );
-	* // returns -13.0
-	*
-	* var im = imagf( out );
-	* // returns -1.0
+	* // returns <Complex64>[ -13.0, -1.0 ]
 	*/
 	( z1: Complex64, z2: Complex64 ): Complex64;
 
@@ -115,23 +104,12 @@ interface Mul {
 *
 * @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 = mul( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns -13.0
-*
-* var im = imagf( out );
-* // returns -1.0
+* // returns <Complex64>[ -13.0, -1.0 ]
 *
 * @example
 * var Float32Array = require( '@stdlib/array-float32' );

docs/types/index.d.ts

@@ -25,24 +25,13 @@
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 * var mul = require( '@stdlib/complex-float32-base-mul' );
 *
 * var z1 = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*
 * var z2 = new Complex64( -2.0, 1.0 );
-* // returns <Complex64>
 *
 * var out = mul( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns -13.0
-*
-* var im = imagf( out );
-* // returns -1.0
+* // returns <Complex64>[ -13.0, -1.0 ]
 */
 
 // MODULES //

lib/index.js

@@ -37,23 +37,12 @@ var imagf = require( '@stdlib/complex-float32-imag' );
 *
 * @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 = mul( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns -13.0
-*
-* var im = imagf( out );
-* // returns -1.0
+* // returns <Complex64>[ -13.0, -1.0 ]
 */
 function mul( z1, z2 ) {
 	var re1 = realf( z1 );

lib/main.js

@@ -36,23 +36,12 @@ var addon = require( './../src/addon.node' );
 *
 * @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 = mul( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns -13.0
-*
-* var im = imagf( out );
-* // returns -1.0
+* // returns <Complex64>[ -13.0, -1.0 ]
 */
 function mul( z1, z2 ) {
 	var v = addon( z1, z2 );