docs: update examples for blas/base/wasm/cscal

PR-URL: #6495
Ref: #4833
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Signed-off-by: Athan Reines <[email protected]>

Author: Rupa-Rd

lib/node_modules/@stdlib/blas/base/wasm/cscal/README.md

@@ -37,8 +37,6 @@ Scales values from `cx` by `ca`.
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Define a strided array:
 var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -48,15 +46,8 @@ var ca = new Complex64( 2.0, 2.0 );
 
 // Perform operation:
 cscal.main( cx.length, ca, cx, 1 );
+// cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 
-var v = cx.get( 0 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns -2.0
-
-var im = imagf( v );
-// returns 6.0
 ```
 
 The function has the following parameters:
@@ -71,8 +62,6 @@ The `N` and stride parameters determine which elements in the input strided arra
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Define a strided array:
 var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -82,15 +71,8 @@ var ca = new Complex64( 2.0, 0.0 );
 
 // Perform operation:
 cscal.main( 2, ca, cx, 2 );
+// cx => <Complex64Array>[ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0 ]
 
-var v = cx.get( 2 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 10.0
-
-var im = imagf( v );
-// returns 12.0
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -100,8 +82,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Initial array:
 var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -114,15 +94,8 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
 
 // Scales every other value from `cx1` by `ca`...
 cscal.main( 3, ca, cx1, 1 );
+// cx0 => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
 
-var z = cx0.get( 1 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns -2.0
-
-var im = imagf( z );
-// returns 14.0
 ```
 
 #### cscal.ndarray( N, ca, cx, strideX, offsetX )
@@ -132,8 +105,6 @@ Scales values from `cx` by `ca` using alternative indexing semantics.
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 // Define a strided array:
 var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -143,15 +114,8 @@ var ca = new Complex64( 2.0, 2.0 );
 
 // Perform operation:
 cscal.ndarray( cx.length, ca, cx, 1, 0 );
+// cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 
-var v = cx.get( 0 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns -2.0
-
-var im = imagf( v );
-// returns 6.0
 ```
 
 The function has the following additional parameters:
@@ -163,22 +127,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 var ca = new Complex64( 2.0, 2.0 );
 
 cscal.ndarray( 2, ca, cx, 2, 1 );
-
-var z = cx.get( 3 );
-// returns <Complex64>
-
-var re = realf( z );
-// returns -2.0
-
-var im = imagf( z );
-// returns 30.0
+// cx => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ]
 ```
 
 * * *

lib/node_modules/@stdlib/blas/base/wasm/cscal/docs/repl.txt

@@ -35,33 +35,23 @@
     // Standard usage:
     > var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > var ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
-    > {{alias}}.main( 2, ca, cx, 1 );
-    > var z = cx.get( 0 );
-    > var re = {{alias:@stdlib/complex/float32/real}}( z )
-    -3.0
-    > var im = {{alias:@stdlib/complex/float32/imag}}( z )
-    4.0
+    > {{alias}}.main( 2, ca, cx, 1 )
+    <Complex64Array>[ -3.0, 4.0, -5.0, 10.0 ]
 
     // Advanced indexing:
     > cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 1.0 );
-    > {{alias}}.main( 2, ca, cx, 2 );
-    > z = cx.get( 0 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    -1.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    3.0
+    > {{alias}}.main( 2, ca, cx, 2 )
+    <Complex64Array>[ -1.0, 3.0, 3.0, 4.0, -1.0, 11.0 ]
 
     // Using typed array views:
     > var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
     > var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
-    > {{alias}}.main( 2, ca, cx1, 1 );
-    > z = cx0.get( 1 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    -2.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    14.0
+    > {{alias}}.main( 2, ca, cx1, 1 )
+    <Complex64Array>[ -2.0, 14.0, -2.0, 22.0 ]
+    > cx0
+    <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0 ]
 
 
 {{alias}}.ndarray( N, ca, cx, strideX, offsetX )
@@ -100,22 +90,14 @@
     // Standard usage:
     > var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
-    > {{alias}}.ndarray( 2, ca, cx, 1, 0 );
-    > var z = cx.get( 0 );
-    > var re = {{alias:@stdlib/complex/float32/real}}( z )
-    -2.0
-    > var im = {{alias:@stdlib/complex/float32/imag}}( z )
-    6.0
+    > {{alias}}.ndarray( 2, ca, cx, 1, 0 )
+    <Complex64Array>[ -2.0, 6.0, -2.0, 14.0 ]
 
     // Advanced indexing:
     > cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
     > ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
-    > {{alias}}.ndarray( 2, ca, cx, 1, 2 );
-    > z = cx.get( 2 );
-    > re = {{alias:@stdlib/complex/float32/real}}( z )
-    -7.0
-    > im = {{alias:@stdlib/complex/float32/imag}}( z )
-    16.0
+    > {{alias}}.ndarray( 2, ca, cx, 1, 2 )
+    <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, -7.0, 16.0, -9.0, 22.0 ]
 
 
 {{alias}}.Module( memory )

lib/node_modules/@stdlib/blas/base/wasm/cscal/docs/types/index.d.ts

@@ -317,8 +317,6 @@ interface Routine extends ModuleWrapper {
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
 	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
 	* // Define a strided array:
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -328,15 +326,7 @@ interface Routine extends ModuleWrapper {
 	*
 	* // Perform operation:
 	* cscal.main( x.length, z, x, 1 );
-	*
-	* var v = x.get( 0 );
-	* // returns <Complex64>
-	*
-	* var re = realf( v );
-	* // returns -2.0
-	*
-	* var im = imagf( v );
-	* // returns 6.0
+	* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 	*/
 	main( N: number, alpha: Complex64, x: Complex64Array, strideX: number ): Complex64Array;
 
@@ -353,8 +343,6 @@ interface Routine extends ModuleWrapper {
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
 	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
 	* // Define a strided array:
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -364,15 +352,7 @@ interface Routine extends ModuleWrapper {
 	*
 	* // Perform operation:
 	* cscal.ndarray( x.length, z, x, 1, 0 );
-	*
-	* var v = x.get( 0 );
-	* // returns <Complex64>
-	*
-	* var re = realf( v );
-	* // returns -2.0
-	*
-	* var im = imagf( v );
-	* // returns 6.0
+	* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 	*/
 	ndarray( N: number, alpha: Complex64, x: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
 
@@ -454,8 +434,6 @@ interface Routine extends ModuleWrapper {
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * // Define a strided array:
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -465,21 +443,11 @@ interface Routine extends ModuleWrapper {
 *
 * // Perform operation:
 * cscal.main( x.length, z, x, 1 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * // Define a strided array:
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -489,15 +457,7 @@ interface Routine extends ModuleWrapper {
 *
 * // Perform operation:
 * cscal.ndarray( x.length, z, x, 1, 0 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 */
 declare var cscal: Routine;
 

lib/node_modules/@stdlib/blas/base/wasm/cscal/lib/index.js

@@ -26,8 +26,6 @@
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var cscal = require( '@stdlib/blas/base/wasm/cscal' );
 *
 * // Define a strided array:
@@ -38,21 +36,11 @@
 *
 * // Perform operation:
 * cscal.main( x.length, z, x, 1 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var cscal = require( '@stdlib/blas/base/wasm/cscal' );
 *
 * // Define a strided array:
@@ -63,15 +51,7 @@
 *
 * // Perform operation:
 * cscal.ndarray( x.length, z, x, 1, 0 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 *
 * @example
 * var Memory = require( '@stdlib/wasm/memory' );

lib/node_modules/@stdlib/blas/base/wasm/cscal/lib/main.js

@@ -34,8 +34,6 @@ var Routine = require( './routine.js' );
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * // Define a strided array:
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -45,21 +43,11 @@ var Routine = require( './routine.js' );
 *
 * // Perform operation:
 * cscal.main( x.length, z, x, 1 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * // Define a strided array:
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -69,15 +57,7 @@ var Routine = require( './routine.js' );
 *
 * // Perform operation:
 * cscal.ndarray( x.length, z, x, 1, 0 );
-*
-* var v = x.get( 0 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns -2.0
-*
-* var im = imagf( v );
-* // returns 6.0
+* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
 */
 var cscal = new Routine();
 cscal.initializeSync(); // eslint-disable-line node/no-sync