docs: improve doctests for complex number instances in lapack/base/zlacgv

PR-URL: #8696
Ref: #8641
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: DivyanshuVortex

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

@@ -36,21 +36,13 @@ Conjugates each element in a double-precision complex floating-point vector.
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 
 zlacgv( 2, zx, 1 );
 
 var z = zx.get( 0 );
-// returns <Complex128>
-
-var re = real( z );
-// returns 1.0
-
-var im = imag( z );
-// returns -2.0
+// returns <Complex128>[ 1.0, -2.0 ]
 ```
 
 The function has the following parameters:
@@ -63,21 +55,13 @@ The `N` and stride parameters determine which elements in `zx` are conjugated. F
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 
 zlacgv( 2, zx, 2 );
 
 var z = zx.get( 0 );
-// returns <Complex128>
-
-var re = real( z );
-// returns 1.0
-
-var im = imag( z );
-// returns -2.0
+// returns <Complex128>[ 1.0, -2.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -87,8 +71,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 // Initial array:
 var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -100,13 +82,7 @@ var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start a
 zlacgv( 3, zx1, 1 );
 
 var z = zx0.get( 1 );
-// returns <Complex128>
-
-var re = real( z );
-// returns 3.0
-
-var im = imag( z );
-// returns -4.0
+// returns <Complex128>[ 3.0, -4.0 ]
 ```
 
 #### zlacgv.ndarray( N, zx, strideZX, offsetZX )
@@ -115,21 +91,13 @@ Conjugates each element in a double-precision floating-point vector using altern
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 
 zlacgv.ndarray( 3, zx, 1, 0 );
 
 var z = zx.get( 0 );
-// returns <Complex128>
-
-var re = real( z );
-// returns 1.0
-
-var im = imag( z );
-// returns -2.0
+// returns <Complex128>[ 1.0, -2.0 ]
 ```
 
 The function has the following additional parameters:
@@ -140,21 +108,13 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 
 zlacgv.ndarray( 2, zx, 2, 1 );
 
 var z = zx.get( 3 );
-// returns <Complex128>
-
-var re = real( z );
-// returns 7.0
-
-var im = imag( z );
-// returns -8.0
+// returns <Complex128>[ 7.0, -8.0 ]
 ```
 
 </section>

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

@@ -31,30 +31,21 @@
     // Standard usage:
     > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > {{alias}}( 2, zx, 1 );
-    > var z = zx.get( 0 );
-    > var re = {{alias:@stdlib/complex/float64/real}}( z )
-    1.0
-    > var im = {{alias:@stdlib/complex/float64/imag}}( z )
-    -2.0
+    > var z = zx.get( 0 )
+    <Complex128>[ 1.0, -2.0 ]
 
     // Advanced indexing:
     > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > {{alias}}( 2, zx, 2 );
-    > z = zx.get( 0 );
-    > re = {{alias:@stdlib/complex/float64/real}}( z )
-    1.0
-    > im = {{alias:@stdlib/complex/float64/imag}}( z )
-    -2.0
+    > z = zx.get( 0 )
+    <Complex128>[ 1.0, -2.0 ]
 
     // Using typed array views:
     > var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 );
     > {{alias}}( 2, zx1, 1 );
-    > z = zx0.get( 1 );
-    > re = {{alias:@stdlib/complex/float64/real}}( z )
-    3.0
-    > im = {{alias:@stdlib/complex/float64/imag}}( z )
-    -4.0
+    > z = zx0.get( 1 )
+    <Complex128>[ 3.0, -4.0 ]
 
 
 {{alias}}.ndarray( N, zx, strideZX, offsetZX )
@@ -89,20 +80,14 @@
     // Standard usage:
     > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
     > {{alias}}.ndarray( 2, zx, 1, 0 );
-    > var z = zx.get( 0 );
-    > var re = {{alias:@stdlib/complex/float64/real}}( z )
-    1.0
-    > var im = {{alias:@stdlib/complex/float64/imag}}( z )
-    -2.0
+    > var z = zx.get( 0 )
+    <Complex128>[ 1.0, -2.0 ]
 
     // Advanced indexing:
     > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
     > {{alias}}.ndarray( 2, zx, 1, 2 );
-    > z = zx.get( 2 );
-    > re = {{alias:@stdlib/complex/float64/real}}( z )
-    5.0
-    > im = {{alias:@stdlib/complex/float64/imag}}( z )
-    -6.0
+    > z = zx.get( 2 )
+    <Complex128>[ 5.0, -6.0 ]
 
     See Also
     --------

lib/node_modules/@stdlib/lapack/base/zlacgv/docs/types/index.d.ts

@@ -36,21 +36,13 @@ interface Routine {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	*
 	* zlacgv( 3, zx, 1 );
 	*
 	* var z = zx.get( 0 );
-	* // returns <Complex128>
-	*
-	* var re = real( z );
-	* // returns 1.0
-	*
-	* var im = imag( z );
-	* // returns -2.0
+	* // returns <Complex128>[ 1.0, -2.0 ]
 	*/
 	( N: number, zx: Complex128Array, strideZX: number ): Complex128Array;
 
@@ -65,21 +57,13 @@ interface Routine {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	*
 	* zlacgv.ndarray( 3, zx, 1, 0 );
 	*
 	* var z = zx.get( 0 );
-	* // returns <Complex128>
-	*
-	* var re = real( z );
-	* // returns 1.0
-	*
-	* var im = imag( z );
-	* // returns -2.0
+	* // returns <Complex128>[ 1.0, -2.0 ]
 	*/
 	ndarray( N: number, zx: Complex128Array, strideZX: number, offsetZX: number ): Complex128Array;
 }
@@ -94,39 +78,23 @@ interface Routine {
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv( 3, zx, 1 );
 *
 * var z = zx.get( 1 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 3.0
-*
-* var im = imag( z );
-* // returns -4.0
+* // returns <Complex128>[ 3.0, -4.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv.ndarray( 2, zx, 1, 1 );
 *
 * var z = zx.get( 1 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 3.0
-*
-* var im = imag( z );
-* // returns -4.0
+* // returns <Complex128>[ 3.0, -4.0 ]
 */
 declare var zlacgv: Routine;
 

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

@@ -25,41 +25,25 @@
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 * var zlacgv = require( '@stdlib/lapack/base/zlacgv' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv( 3, zx, 1 );
 *
 * var z = zx.get( 0 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 1.0
-*
-* var im = imag( z );
-* // returns -2.0
+* // returns <Complex128>[ 1.0, -2.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 * var zlacgv = require( '@stdlib/lapack/base/zlacgv' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv.ndarray( 3, zx, 1, 0 );
 *
 * var z = zx.get( 0 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 1.0
-*
-* var im = imag( z );
-* // returns -2.0
+* // returns <Complex128>[ 1.0, -2.0 ]
 */
 
 // MODULES //

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

@@ -36,21 +36,13 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv( 3, zx, 1, 0 );
 *
 * var z = zx.get( 0 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 1.0
-*
-* var im = imag( z );
-* // returns -2.0
+* // returns <Complex128>[ 1.0, -2.0 ]
 */
 function zlacgv( N, zx, strideZX, offsetZX ) {
 	var zx64;

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

@@ -36,21 +36,13 @@ var ndarray = require( './ndarray.js' );
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
 * zlacgv( 3, zx, 1 );
 *
 * var z = zx.get( 0 );
-* // returns <Complex128>
-*
-* var re = real( z );
-* // returns 1.0
-*
-* var im = imag( z );
-* // returns -2.0
+* // returns <Complex128>[ 1.0, -2.0 ]
 */
 function zlacgv( N, zx, strideZX ) {
 	return ndarray( N, zx, strideZX, stride2offset( N, strideZX ) );