Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-04)
+## Unreleased (2025-06-08)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`f482c99`](https://github.com/stdlib-js/stdlib/commit/f482c9978e9ff27b9c9bf4afe03a6ee8e79f254a) - **docs:** update examples for `complex/float64/base/mul-add` [(#7267)](https://github.com/stdlib-js/stdlib/pull/7267) _(by Shabareesh Shetty)_
 -   [`8bf8f93`](https://github.com/stdlib-js/stdlib/commit/8bf8f93d8fe5b05cd7de8347abb65255ec3b06aa) - **docs:** change examples for `complex/float64/base/mul-add` [(#7191)](https://github.com/stdlib-js/stdlib/pull/7191) _(by Shabareesh Shetty)_
 -   [`a1e230f`](https://github.com/stdlib-js/stdlib/commit/a1e230f29297caa89880e9c194c615a0400fb7bc) - **chore:** clean up cppcheck-suppress comments _(by Karan Anand)_
 -   [`b957f93`](https://github.com/stdlib-js/stdlib/commit/b957f93bfacfa2b307db9b30a45fa48ce5b4488b) - **docs:** fix description _(by Athan Reines)_

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]>

README.md

@@ -84,13 +84,7 @@ var z3 = new Complex128( 7.0, -8.0 );
 
 // Compute `alpha*x + y`:
 var v = muladd( z1, z2, z3 );
-// returns <Complex128>
-
-var re = real( v );
-// returns -6.0
-
-var im = imag( v );
-// returns -9.0
+// returns <Complex128>[ -6.0, -9.0 ]
 ```
 
 The function supports the following parameters:

dist/index.js.map

@@ -47,26 +47,13 @@ interface MulAdd {
 	*
 	* @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 z3 = new Complex128( 7.0, -8.0 );
-	* // returns <Complex128>
 	*
 	* var out = muladd( z1, z2, z3 );
-	* // returns <Complex128>
-	*
-	* var re = real( out );
-	* // returns -6.0
-	*
-	* var im = imag( out );
-	* // returns -9.0
+	* // returns <Complex128>[ -6.0, -9.0 ]
 	*/
 	( alpha: Complex128, x: Complex128, y: Complex128 ): Complex128;
 
@@ -132,26 +119,13 @@ interface MulAdd {
 *
 * @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 z3 = new Complex128( 7.0, -8.0 );
-* // returns <Complex128>
 *
 * var out = muladd( z1, z2, z3 );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns -6.0
-*
-* var im = imag( out );
-* // returns -9.0
+* // returns <Complex128>[ -6.0, -9.0 ]
 *
 * @example
 * var Float64Array = require( '@stdlib/array-float64' );

docs/types/index.d.ts

@@ -25,27 +25,14 @@
 *
 * @example
 * var Complex128 = require( '@stdlib/complex-float64-ctor' );
-* var real = require( '@stdlib/complex-float64-real' );
-* var imag = require( '@stdlib/complex-float64-imag' );
 * var muladd = require( '@stdlib/complex-float64-base-mul-add' );
 *
 * var z1 = new Complex128( 5.0, 3.0 );
-* // returns <Complex128>
-*
 * var z2 = new Complex128( -2.0, 1.0 );
-* // returns <Complex128>
-*
 * var z3 = new Complex128( 7.0, -8.0 );
-* // returns <Complex128>
 *
 * var out = muladd( z1, z2, z3 );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns -6.0
-*
-* var im = imag( out );
-* // returns -9.0
+* // returns <Complex128>[ -6.0, -9.0 ]
 */
 
 // MODULES //

lib/index.js

@@ -37,26 +37,13 @@ var imag = require( '@stdlib/complex-float64-imag' );
 *
 * @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 z3 = new Complex128( 7.0, -8.0 );
-* // returns <Complex128>
 *
 * var out = muladd( z1, z2, z3 );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns -6.0
-*
-* var im = imag( out );
-* // returns -9.0
+* // returns <Complex128>[ -6.0, -9.0 ]
 */
 function muladd( alpha, x, y ) {
 	var re0 = real( alpha );

lib/main.js

@@ -37,26 +37,13 @@ var addon = require( './../src/addon.node' );
 *
 * @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 z3 = new Complex128( 7.0, -8.0 );
-* // returns <Complex128>
 *
 * var out = muladd( z1, z2, z3 );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns -6.0
-*
-* var im = imag( out );
-* // returns -9.0
+* // returns <Complex128>[ -6.0, -9.0 ]
 */
 function muladd( alpha, x, y ) {
 	var v = addon( alpha, x, y );