docs: improve doctests for complex number typed arrays in lapack/base/zlaset

PR-URL: #12024
Reviewed-by: Athan Reines <kgryte@gmail.com>
Ref: stdlib-js/metr-issue-tracker#522
Ref: #4833

Author: anandkaranubc

lib/node_modules/@stdlib/lapack/base/zlaset/README.md

@@ -44,12 +44,7 @@ var alpha = new Complex128( 1.0, 2.0 );
 var beta = new Complex128( 3.0, 4.0 );
 
 zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
-
-var z = A.get( 0 );
-// returns <Complex128>[ 3.0, 4.0 ]
-
-z = A.get( 1 );
-// returns <Complex128>[ 1.0, 2.0 ]
+// A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 ```
 
 The function has the following parameters:
@@ -81,9 +76,7 @@ var alpha = new Complex128( 1.0, 2.0 );
 var beta = new Complex128( 3.0, 4.0 );
 
 zlaset( 'row-major', 'all', 2, 2, alpha, beta, A1, 2 );
-
-var z = A0.get( 1 );
-// returns <Complex128>[ 3.0, 4.0 ]
+// A0 => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 ```
 
 #### zlaset.ndarray( uplo, M, N, alpha, beta, A, sa1, sa2, oa )
@@ -100,12 +93,7 @@ var alpha = new Complex128( 1.0, 2.0 );
 var beta = new Complex128( 3.0, 4.0 );
 
 zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
-
-var z = A.get( 0 );
-// returns <Complex128>[ 3.0, 4.0 ]
-
-z = A.get( 1 );
-// returns <Complex128>[ 1.0, 2.0 ]
+// A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 ```
 
 The function has the following parameters:
@@ -132,12 +120,7 @@ var alpha = new Complex128( 1.0, 2.0 );
 var beta = new Complex128( 3.0, 4.0 );
 
 zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
-
-var z = A.get( 0 );
-// returns <Complex128>[ 0.0, 0.0 ]
-
-z = A.get( 1 );
-// returns <Complex128>[ 3.0, 4.0 ]
+// A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 ```
 
 </section>

lib/node_modules/@stdlib/lapack/base/zlaset/docs/repl.txt

@@ -45,9 +45,8 @@
     > var A = new {{alias:@stdlib/array/complex128}}( 4 );
     > var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 );
     > var beta = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 4.0 );
-    > {{alias}}( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
-    > var z = A.get( 0 )
-    <Complex128>[ 3.0, 4.0 ]
+    > {{alias}}( 'row-major', 'all', 2, 2, alpha, beta, A, 2 )
+    <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 
 
 {{alias}}.ndarray( uplo, M, N, alpha, beta, A, sa1, sa2, oa )
@@ -99,9 +98,8 @@
     > var A = new {{alias:@stdlib/array/complex128}}( 5 );
     > var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 2.0 );
     > var beta = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 4.0 );
-    > {{alias}}.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
-    > var z = A.get( 1 )
-    <Complex128>[ 3.0, 4.0 ]
+    > {{alias}}.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 )
+    <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 
     See Also
     --------

lib/node_modules/@stdlib/lapack/base/zlaset/lib/base.js

@@ -482,15 +482,7 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -502,15 +494,7 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'upper', 2, 2, alpha, beta, A, 2, 1, 0 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 0.0, 0.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 0.0, 0.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -522,15 +506,7 @@ function setLower( M, N, areal, aimag, breal, bimag, A, strideA1, strideA2, offs
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'lower', 2, 2, alpha, beta, A, 2, 1, 0 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 0.0, 0.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
 */
 function zlaset( uplo, M, N, alpha, beta, A, strideA1, strideA2, offsetA ) {
 	var viewA;

lib/node_modules/@stdlib/lapack/base/zlaset/lib/index.js

@@ -33,9 +33,7 @@
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -47,9 +45,7 @@
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
-*
-* var z = A.get( 1 );
-* // returns <Complex128>[ 3.0, 4.0 ]
+* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 */
 
 // MODULES //

lib/node_modules/@stdlib/lapack/base/zlaset/lib/ndarray.js

@@ -49,15 +49,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
-*
-* var z = A.get( 1 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 3 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -69,15 +61,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'upper', 2, 2, alpha, beta, A, 2, 1, 1 );
-*
-* var z = A.get( 1 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 3 );
-* // returns <Complex128>[ 0.0, 0.0 ]
+* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 0.0, 0.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -89,15 +73,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'lower', 2, 2, alpha, beta, A, 2, 1, 1 );
-*
-* var z = A.get( 1 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 0.0, 0.0 ]
-*
-* z = A.get( 3 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
 */
 function zlaset( uplo, M, N, alpha, beta, A, strideA1, strideA2, offsetA ) {
 	return base( uplo, M, N, alpha, beta, A, strideA1, strideA2, offsetA );

lib/node_modules/@stdlib/lapack/base/zlaset/lib/zlaset.js

@@ -53,15 +53,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -73,15 +65,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'row-major', 'upper', 2, 2, alpha, beta, A, 2 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 1.0, 2.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 0.0, 0.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 0.0, 0.0, 3.0, 4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -93,15 +77,7 @@ var base = require( './base.js' );
 * var beta = new Complex128( 3.0, 4.0 );
 *
 * zlaset( 'row-major', 'lower', 2, 2, alpha, beta, A, 2 );
-*
-* var z = A.get( 0 );
-* // returns <Complex128>[ 3.0, 4.0 ]
-*
-* z = A.get( 1 );
-* // returns <Complex128>[ 0.0, 0.0 ]
-*
-* z = A.get( 2 );
-* // returns <Complex128>[ 1.0, 2.0 ]
+* // A => <Complex128Array>[ 3.0, 4.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
 */
 function zlaset( order, uplo, M, N, alpha, beta, A, LDA ) {
 	var sa1;