chore: apply review changes

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

@@ -20,7 +20,7 @@ limitations under the License.
 
 # cscal
 
-> Scales a complex single-precision floating-point vector by a single-precision floating point constant.
+> Scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.
 
 <section class="usage">
 
@@ -30,20 +30,22 @@ limitations under the License.
 var cscal = require( '@stdlib/blas/base/cscal' );
 ```
 
-#### cscal( N, cx, x, strideX )
+#### cscal( N, ca, cx, strideX )
 
-Scales values from `x` by `cx`.
+Scales values from `cx` by `ca`.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
 var realf = require( '@stdlib/complex/realf' );
 var imagf = require( '@stdlib/complex/imagf' );
 
-var x = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
-var cx = new Complex64Array( [ 2.0, 0.0 ] );
-cscal( 3, cx, x, 1 );
+var cx = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+var ca = new Complex64( 2.0, 0.0 );
+
+cscal( 3, ca, cx, 1 );
 
-var z = x.get( 0 );
+var z = cx.get( 0 );
 // returns <Complex64>
 
 var re = realf( z );
@@ -56,23 +58,24 @@ var im = imagf( z );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
--   **cx**: complex constant 
--   **x**: input [`Complex64Array`][@stdlib/array/complex64].
+-   **ca**: scalar [`Complex64`][@stdlib/complex/float32] constant. 
+-   **cx**: input [`Complex64Array`][@stdlib/array/complex64].
 -   **strideX**: index increment for `x`.
 
-The `N` and stride parameters determine how values from `x` are scaled by `cx`. For example, to scale every other value in `x` by `cx`,
+The `N` and stride parameters determine how values from `cx` are scaled by `ca`. For example, to scale every other value in `cx` by `ca`,
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
 var realf = require( '@stdlib/complex/realf' );
 var imagf = require( '@stdlib/complex/imagf' );
 
-var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-var cx = new Complex64Array( [ 2.0, 0.0 ] );
+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, 0.0 );
 
-cscal( 2, cx, x, 2 );
+cscal( 2, ca, cx, 2 );
 
-var z = x.get( 2 );
+var z = cx.get( 2 );
 // returns <Complex64>
 
 var re = realf( z );
@@ -88,20 +91,23 @@ 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' );
 var realf = require( '@stdlib/complex/realf' );
 var imagf = require( '@stdlib/complex/imagf' );
 
-// Initial arrays...
-var x0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-var cx = new Complex64Array( [ 2.0, 2.0 ] );
+// Initial array...
+var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+
+// Complex constant
+var ca = new Complex64( 2.0, 2.0 );
 
 // Create offset views...
-var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-// Copy in reverse order every other value from `x1` into `y1`...
-cscal( 3, cx, x1, 1 );
+// Scales every other value from `cx1` by `ca`...
+cscal( 3, ca, cx1, 1 );
 
-var z = x0.get( 1 );
+var z = cx0.get( 1 );
 // returns <Complex64>
 
 var re = realf( z );
@@ -111,21 +117,22 @@ var im = imagf( z );
 // returns 14.0
 ```
 
-#### cscal.ndarray( N, cx, x, strideX, offsetX )
+#### cscal.ndarray( N, ca, cx, strideX, offsetX )
 
-Scales values from `x` by `cx` using alternative indexing semantics.
+Scales values from `cx` by `ca` using alternative indexing semantics.
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
 var realf = require( '@stdlib/complex/realf' );
 var imagf = require( '@stdlib/complex/imagf' );
 
-var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-var cx = new Complex64Array( [ 2.0, 2.0 ] );
+var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var ca = new Complex64( 2.0, 2.0 );
 
-cscal.ndarray( x.length, cx, x, 1, 0 );
+cscal.ndarray( 3, ca, cx, 1, 0 );
 
-var z = x.get( 0 );
+var z = cx.get( 0 );
 // returns <Complex64>
 
 var re = realf( z );
@@ -139,19 +146,20 @@ The function has the following additional parameters:
 
 -   **offsetX**: starting index for `x`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to scale every other value in `x` starting from the second value by `cx` where `x[i] = cx[0] * x[i]`, `x[i+1] = cx[1] * x[i+1]`,...,
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter support indexing semantics based on starting indices. For example, to scale every other value in the input strided array starting from the second element,
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
 var realf = require( '@stdlib/complex/realf' );
 var imagf = require( '@stdlib/complex/imagf' );
 
-var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-var cx = new Complex64Array( [ 2.0, 2.0 ] );
+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, cx, x, 2, 1 );
+cscal.ndarray( 2, ca, cx, 2, 1 );
 
-var z = x.get( 3 );
+var z = cx.get( 3 );
 // returns <Complex64>
 
 var re = realf( z );
@@ -169,7 +177,7 @@ var im = imagf( z );
 
 ## Notes
 
--   If `N <= 0` or `strideX <= 0` , both functions return `x` unchanged.
+-   If `N <= 0` or `strideX <= 0` , both functions return `cx` unchanged.
 -   `cscal()` corresponds to the [BLAS][blas] level 1 function [`cscal`][cscal].
 
 </section>
@@ -183,7 +191,6 @@ var im = imagf( z );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Complex64Array = require( '@stdlib/array/complex64' );
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
 var filledarrayBy = require( '@stdlib/array/filled-by' );
 var Complex64 = require( '@stdlib/complex/float32' );
@@ -193,13 +200,15 @@ function rand() {
     return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
 }
 
-var x = filledarrayBy( 10, 'complex64', rand );
-console.log( x.get( 0 ).toString() );
-var cx = new Complex64Array( [ 2.0, 2.0 ] );
+var cx = filledarrayBy( 10, 'complex64', rand );
+console.log( cx.toString() );
+
+var ca = new Complex64( 2.0, 2.0 );
+console.log( ca.toString() );
 
-// Scales elements from `x` by `cx`:
-cscal( x.length, cx, x, 1 );
-console.log( x.get( x.length-1 ).toString() );
+// Scales elements from `cx` by `ca`:
+cscal( cx.length, ca, cx, 1 );
+console.log( cx.get( cx.length-1 ).toString() );
 ```
 
 </section>
@@ -210,12 +219,6 @@ console.log( x.get( x.length-1 ).toString() );
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/blas/base/cswap`][@stdlib/blas/base/cswap]</span><span class="delimiter">: </span><span class="description">interchanges two complex single-precision floating-point vectors.</span>
-
 </section>
 
 <!-- /.related -->
@@ -226,17 +229,13 @@ console.log( x.get( x.length-1 ).toString() );
 
 [blas]: http://www.netlib.org/blas
 
-[cscal]: https://www.netlib.org/lapack/explore-html/d2/de8/group__scal_gacce468103c83fa18bae078d5f49fefe2.html#gacce468103c83fa18bae078d5f49fefe2
+[cscal]: http://www.netlib.org/lapack/explore-html/da/df6/group__complex__blas__level1.html
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
 [@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
 
-<!-- <related-links> -->
-
-[@stdlib/blas/base/cswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cswap
-
-<!-- </related-links> -->
+[@stdlib/complex/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32
 
 </section>
 

lib/node_modules/@stdlib/blas/base/cscal/benchmark/benchmark.js

@@ -25,7 +25,8 @@ var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Complex64Array = require( '@stdlib/array/complex64' );
-var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
+var reinterpret = require('@stdlib/strided/base/reinterpret-complex64');
 var pkg = require( './../package.json' ).name;
 var cscal = require( './../lib/cscal.js' );
 
@@ -47,13 +48,9 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var cx;
-	var x;
+	var ca;
 
-	x = uniform( len*2, -100.0, 100.0, options );
-	x = new Complex64Array( x.buffer );
-
-	cx = new Complex64Array( [ 2.0, -2.0 ] );
+	ca = new Complex64( 2.0, -2.0 );
 
 	return benchmark;
 
@@ -65,12 +62,15 @@ function createBenchmark( len ) {
 	*/
 	function benchmark( b ) {
 		var viewX;
+		var cx;
 		var i;
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			cscal( len, cx, x, 1 );
-			viewX = reinterpret( x, 0 );
+			cx = uniform( len*2, -100.0, 100.0, options );
+			cx = new Complex64Array( cx.buffer );
+			cscal( len, ca, cx, 1 );
+			viewX = reinterpret( cx, 0 );
 			if ( isnan( viewX[ i%(len*2) ] ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/blas/base/cscal/benchmark/benchmark.ndarray.js

@@ -25,7 +25,8 @@ var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Complex64Array = require( '@stdlib/array/complex64' );
-var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' );
+var Complex64 = require( '@stdlib/complex/float32' );
+var reinterpret = require('@stdlib/strided/base/reinterpret-complex64');
 var pkg = require( './../package.json' ).name;
 var cscal = require( './../lib/ndarray.js' );
 
@@ -47,13 +48,9 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var cx;
-	var x;
+	var ca;
 
-	x = uniform( len*2, -100.0, 100.0, options );
-	x = new Complex64Array( x.buffer );
-
-	cx = new Complex64Array( [ 2.0, -2.0 ] );
+	ca = new Complex64( 2.0, -2.0 );
 
 	return benchmark;
 
@@ -65,12 +62,15 @@ function createBenchmark( len ) {
 	*/
 	function benchmark( b ) {
 		var viewX;
+		var cx;
 		var i;
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			cscal( len, cx, x, 1, 0 );
-			viewX = reinterpret( x, 0 );
+			cx = uniform( len*2, -100.0, 100.0, options );
+			cx = new Complex64Array( cx.buffer );
+			cscal( len, ca, cx, 1, 0 );
+			viewX = reinterpret( cx, 0 );
 			if ( isnan( viewX[ i%(len*2) ] ) ) {
 				b.fail( 'should not return NaN' );
 			}