Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-05-12)
+## Unreleased (2025-06-01)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`5c8faed`](https://github.com/stdlib-js/stdlib/commit/5c8faed8016941ff5a337bb4d14b1bdb65748993) - **docs:** update example _(by Athan Reines)_
 -   [`a1e230f`](https://github.com/stdlib-js/stdlib/commit/a1e230f29297caa89880e9c194c615a0400fb7bc) - **chore:** clean up cppcheck-suppress comments _(by Karan Anand)_
 -   [`3f8a327`](https://github.com/stdlib-js/stdlib/commit/3f8a327f98267690ae7d101c84e522810986caf0) - **bench:** fix syntax _(by Athan Reines)_
 -   [`2ddce39`](https://github.com/stdlib-js/stdlib/commit/2ddce39825650066ba35c74a217ab6425e4f3c9c) - **bench:** fix copy-paste error _(by Athan Reines)_

CHANGELOG.md

@@ -80,6 +80,7 @@ Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
 Justyn Shelby <96994781+ShelbyJustyn@users.noreply.github.com>
 Karan Anand <anandkarancompsci@gmail.com>
+Karan Vasudevamurthy <karanlvm123@gmail.com>
 Karan Yadav <77043443+karanBRAVO@users.noreply.github.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
 Kaushikgtm <162317291+Kaushikgtm@users.noreply.github.com>
@@ -146,6 +147,7 @@ Ryan Seal <splrk@users.noreply.github.com>
 Rylan Yang <137365285+rylany27@users.noreply.github.com>
 SAHIL KUMAR <168997976+sahilk45@users.noreply.github.com>
 SHIVAM YADAV <120725381+Shivam-1827@users.noreply.github.com>
+Sachin Raj <120590207+schnrj@users.noreply.github.com>
 Sahil Goyal <87982509+sahil20021008@users.noreply.github.com>
 Sai Avinash <120403424+nasarobot@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
@@ -166,10 +168,14 @@ Spandan Barve <contact@marsian.dev>
 Stephannie Jiménez Gacha <steff456@hotmail.com>
 Suhaib Ilahi <suhaib.elahi87@gmail.com>
 Suraj Kumar <125961509+kumarsuraj212003@users.noreply.github.com>
+Swapnil Hajare <69076366+Swapnil-2502@users.noreply.github.com>
 Tanishq Ahuja <68651083+TheGEN1U5@users.noreply.github.com>
 Tirtadwipa Manunggal <tirtadwipa.manunggal@gmail.com>
 Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
 Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
+Tushar Bhardwaj <155543597+TusharBhardwaj441@users.noreply.github.com>
+Uday Kakade <141299403+udaykakade25@users.noreply.github.com>
+Ujjwal Kirti <64329707+ujjwalkirti@users.noreply.github.com>
 Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
 UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>

CONTRIBUTORS

@@ -157,20 +157,16 @@ The function supports the following parameters:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Complex128 = require( '@stdlib/complex-float64-ctor' );
-var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
+var Complex128Array = require( '@stdlib/array-complex128' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var scale = require( '@stdlib/complex-float64-base-scale' );
 
-var rand = discreteUniform( -50, 50 );
+// Generate an array of random values:
+var values = new Complex128Array( discreteUniform( 200, -50, 50 ) );
 
-var z1;
-var z2;
-var i;
-for ( i = 0; i < 100; i++ ) {
-    z1 = new Complex128( rand(), rand() );
-    z2 = scale( 5.0, z1 );
-    console.log( '(%s) * 5.0 = %s', z1.toString(), z2.toString() );
-}
+// Scale each by a scalar constant:
+logEachMap( '%0.1f * (%s) = %s', 5.0, values, scale );
 ```
 
 </section>

README.md

@@ -18,17 +18,13 @@
 
 'use strict';
 
-var Complex128 = require( '@stdlib/complex-float64-ctor' );
-var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
+var Complex128Array = require( '@stdlib/array-complex128' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var scale = require( './../lib' );
 
-var rand = discreteUniform( -50, 50 );
+// Generate an array of random values:
+var values = new Complex128Array( discreteUniform( 200, -50, 50 ) );
 
-var z1;
-var z2;
-var i;
-for ( i = 0; i < 100; i++ ) {
-	z1 = new Complex128( rand(), rand() );
-	z2 = scale( 5.0, z1 );
-	console.log( '(%s) * 5.0 = %s', z1.toString(), z2.toString() );
-}
+// Scale each by a scalar constant:
+logEachMap( '%0.1f * (%s) = %s', 5.0, values, scale );

examples/index.js

@@ -50,12 +50,14 @@
     "@stdlib/utils-library-manifest": "^0.2.2"
   },
   "devDependencies": {
+    "@stdlib/array-complex128": "^0.3.0",
     "@stdlib/array-float64": "^0.2.2",
     "@stdlib/assert-is-method": "^0.2.2",
     "@stdlib/assert-is-same-float64array": "^0.2.2",
+    "@stdlib/console-log-each-map": "github:stdlib-js/console-log-each-map#main",
     "@stdlib/math-base-assert-is-nan": "^0.2.2",
+    "@stdlib/random-array-discrete-uniform": "^0.2.1",
     "@stdlib/random-array-uniform": "^0.2.1",
-    "@stdlib/random-base-discrete-uniform": "^0.2.1",
     "@stdlib/random-base-uniform": "^0.2.1",
     "@stdlib/utils-try-require": "^0.2.2",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",