Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-01)
+## Unreleased (2025-06-09)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`30c471f`](https://github.com/stdlib-js/stdlib/commit/30c471f4887835a6ca2827fa9ef3cb2abb1756af) - **docs:** update examples for `complex/float32/base/scale` [(#7292)](https://github.com/stdlib-js/stdlib/pull/7292) _(by Shabareesh Shetty)_
 -   [`7475c9d`](https://github.com/stdlib-js/stdlib/commit/7475c9dfd5461211d8071b7073b8958300dd5838) - **feat:** add `complex/float32/base/scale` [(#7156)](https://github.com/stdlib-js/stdlib/pull/7156) _(by Shabareesh Shetty, Athan Reines)_
 
 </details>

CONTRIBUTORS

@@ -22,6 +22,7 @@ AlyAbdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
 AmanBhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
+Annamalai Prabu <apfossdev@gmail.com>
 Anshu Kumar <132515490+anxhukumar@users.noreply.github.com>
 Anshu Kumar <contact.anshukumar@protonmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
@@ -38,6 +39,7 @@ Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
 Deep Trivedi <128926685+thedeeppp@users.noreply.github.com>
+Deepak Singh <78257493+Deepak91168@users.noreply.github.com>
 Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
 Dev Goel <135586571+corsairier@users.noreply.github.com>
 Dhanyabad behera <110620935+dhanyabad11@users.noreply.github.com>
@@ -53,6 +55,7 @@ Frank Kovacs <fran70kk@gmail.com>
 GK Bishnoi <gkishan1kyt@gmail.com>
 GURU PRASAD SHARMA <168292003+GURUPRASADSHARMA@users.noreply.github.com>
 Gaurav <gaurav70380@gmail.com>
+Gautam Kaushik <162317291+Kaushikgtm@users.noreply.github.com>
 Gautam sharma <gautamkrishnasharma1@gmail.com>
 Girish Garg <garggirish2020@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
@@ -118,6 +121,7 @@ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <pranavchiku11@gmail.com>

README.md

@@ -75,19 +75,11 @@ Scales a single-precision complex floating-point number by a real-valued single-
 
 ```javascript
 var Complex64 = require( '@stdlib/complex-float32-ctor' );
-var realf = require( '@stdlib/complex-float32-real' );
-var imagf = require( '@stdlib/complex-float32-imag' );
 
 var c = new Complex64( 5.0, 3.0 );
 
 var v = scale( 5.0, c );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 25.0
-
-var im = imagf( v );
-// returns 15.0
+// returns <Complex64>[ 25.0, 15.0 ]
 ```
 
 The function supports the following parameters:

dist/index.js.map

@@ -36,20 +36,11 @@ interface Scale {
 	*
 	* @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 = scale( 5.0, z );
-	* // returns <Complex64>
-	*
-	* var re = realf( out );
-	* // returns 25.0
-	*
-	* var im = imagf( out );
-	* // returns 15.0
+	* // returns <Complex64>[ 25.0, 15.0 ]
 	*/
 	( alpha: number, z: Complex64 ): Complex64;
 
@@ -108,20 +99,11 @@ interface Scale {
 *
 * @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 = scale( 5.0, z );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 25.0
-*
-* var im = imagf( out );
-* // returns 15.0
+* // returns <Complex64>[ 25.0, 15.0 ]
 *
 * @example
 * var Float32Array = require( '@stdlib/array-float32' );

docs/types/index.d.ts

@@ -25,21 +25,12 @@
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 * var scale = require( '@stdlib/complex-float32-base-scale' );
 *
 * var z = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
 *
 * var out = scale( scalar, z );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 25.0
-*
-* var im = imagf( out );
-* // returns 15.0
+* // returns <Complex64>[ 25.0, 15.0 ]
 */
 
 // MODULES //

lib/index.js

@@ -37,20 +37,11 @@ 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 z = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
 *
 * var out = scale( 5.0, z );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 25.0
-*
-* var im = imagf( out );
-* // returns 15.0
+* // returns <Complex64>[ 25.0, 15.0 ]
 */
 function scale( alpha, z ) {
 	return new Complex64( f32( realf(z)*alpha ), f32( imagf(z)*alpha ) );

lib/main.js

@@ -36,20 +36,11 @@ 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 z = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
 *
 * var out = scale( 5.0, z );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 25.0
-*
-* var im = imagf( out );
-* // returns 15.0
+* // returns <Complex64>[ 25.0, 15.0 ]
 */
 function scale( alpha, z ) {
 	var v = addon( alpha, z );