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

DivyanshuVortex · web-flow · commit 726755434945 · 2025-12-01T18:26:41.000-08:00
PR-URL: #8696 Ref: #8641 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/README.md b/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>
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/docs/repl.txt b/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
     --------
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/docs/types/index.d.ts b/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;
 
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/lib/index.js b/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 //
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/lib/ndarray.js b/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;
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/lib/zlacgv.js b/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 ) );

Original file line number	Diff line number	Diff line change
`@@ -36,21 +36,13 @@ interface Routine {`
`36`	`36`	`*`
`37`	`37`	`* @example`
`38`	`38`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`39`		`- * var real = require( '@stdlib/complex/float64/real' );`
`40`		`- * var imag = require( '@stdlib/complex/float64/imag' );`
`41`	`39`	`*`
`42`	`40`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`43`	`41`	`*`
`44`	`42`	`* zlacgv( 3, zx, 1 );`
`45`	`43`	`*`
`46`	`44`	`* var z = zx.get( 0 );`
`47`		`- * // returns <Complex128>`
`48`		`- *`
`49`		`- * var re = real( z );`
`50`		`- * // returns 1.0`
`51`		`- *`
`52`		`- * var im = imag( z );`
`53`		`- * // returns -2.0`
	`45`	`+ * // returns <Complex128>[ 1.0, -2.0 ]`
`54`	`46`	`*/`
`55`	`47`	`( N: number, zx: Complex128Array, strideZX: number ): Complex128Array;`
`56`	`48`
`@@ -65,21 +57,13 @@ interface Routine {`
`65`	`57`	`*`
`66`	`58`	`* @example`
`67`	`59`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`68`		`- * var real = require( '@stdlib/complex/float64/real' );`
`69`		`- * var imag = require( '@stdlib/complex/float64/imag' );`
`70`	`60`	`*`
`71`	`61`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`72`	`62`	`*`
`73`	`63`	`* zlacgv.ndarray( 3, zx, 1, 0 );`
`74`	`64`	`*`
`75`	`65`	`* var z = zx.get( 0 );`
`76`		`- * // returns <Complex128>`
`77`		`- *`
`78`		`- * var re = real( z );`
`79`		`- * // returns 1.0`
`80`		`- *`
`81`		`- * var im = imag( z );`
`82`		`- * // returns -2.0`
	`66`	`+ * // returns <Complex128>[ 1.0, -2.0 ]`
`83`	`67`	`*/`
`84`	`68`	`ndarray( N: number, zx: Complex128Array, strideZX: number, offsetZX: number ): Complex128Array;`
`85`	`69`	`}`
`@@ -94,39 +78,23 @@ interface Routine {`
`94`	`78`	`*`
`95`	`79`	`* @example`
`96`	`80`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`97`		`-* var real = require( '@stdlib/complex/float64/real' );`
`98`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`99`	`81`	`*`
`100`	`82`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`101`	`83`	`*`
`102`	`84`	`* zlacgv( 3, zx, 1 );`
`103`	`85`	`*`
`104`	`86`	`* var z = zx.get( 1 );`
`105`		`-* // returns <Complex128>`
`106`		`-*`
`107`		`-* var re = real( z );`
`108`		`-* // returns 3.0`
`109`		`-*`
`110`		`-* var im = imag( z );`
`111`		`-* // returns -4.0`
	`87`	`+* // returns <Complex128>[ 3.0, -4.0 ]`
`112`	`88`	`*`
`113`	`89`	`* @example`
`114`	`90`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`115`		`-* var real = require( '@stdlib/complex/float64/real' );`
`116`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`117`	`91`	`*`
`118`	`92`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`119`	`93`	`*`
`120`	`94`	`* zlacgv.ndarray( 2, zx, 1, 1 );`
`121`	`95`	`*`
`122`	`96`	`* var z = zx.get( 1 );`
`123`		`-* // returns <Complex128>`
`124`		`-*`
`125`		`-* var re = real( z );`
`126`		`-* // returns 3.0`
`127`		`-*`
`128`		`-* var im = imag( z );`
`129`		`-* // returns -4.0`
	`97`	`+* // returns <Complex128>[ 3.0, -4.0 ]`
`130`	`98`	`*/`
`131`	`99`	`declare var zlacgv: Routine;`
`132`	`100`
Original file line number	Diff line number	Diff line change
`@@ -25,41 +25,25 @@`
`25`	`25`	`*`
`26`	`26`	`* @example`
`27`	`27`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`28`		`-* var real = require( '@stdlib/complex/float64/real' );`
`29`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`30`	`28`	`* var zlacgv = require( '@stdlib/lapack/base/zlacgv' );`
`31`	`29`	`*`
`32`	`30`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`33`	`31`	`*`
`34`	`32`	`* zlacgv( 3, zx, 1 );`
`35`	`33`	`*`
`36`	`34`	`* var z = zx.get( 0 );`
`37`		`-* // returns <Complex128>`
`38`		`-*`
`39`		`-* var re = real( z );`
`40`		`-* // returns 1.0`
`41`		`-*`
`42`		`-* var im = imag( z );`
`43`		`-* // returns -2.0`
	`35`	`+* // returns <Complex128>[ 1.0, -2.0 ]`
`44`	`36`	`*`
`45`	`37`	`* @example`
`46`	`38`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`47`		`-* var real = require( '@stdlib/complex/float64/real' );`
`48`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`49`	`39`	`* var zlacgv = require( '@stdlib/lapack/base/zlacgv' );`
`50`	`40`	`*`
`51`	`41`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`52`	`42`	`*`
`53`	`43`	`* zlacgv.ndarray( 3, zx, 1, 0 );`
`54`	`44`	`*`
`55`	`45`	`* var z = zx.get( 0 );`
`56`		`-* // returns <Complex128>`
`57`		`-*`
`58`		`-* var re = real( z );`
`59`		`-* // returns 1.0`
`60`		`-*`
`61`		`-* var im = imag( z );`
`62`		`-* // returns -2.0`
	`46`	`+* // returns <Complex128>[ 1.0, -2.0 ]`
`63`	`47`	`*/`
`64`	`48`
`65`	`49`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -36,21 +36,13 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );`
`36`	`36`	`*`
`37`	`37`	`* @example`
`38`	`38`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`39`		`-* var real = require( '@stdlib/complex/float64/real' );`
`40`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`41`	`39`	`*`
`42`	`40`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`43`	`41`	`*`
`44`	`42`	`* zlacgv( 3, zx, 1, 0 );`
`45`	`43`	`*`
`46`	`44`	`* var z = zx.get( 0 );`
`47`		`-* // returns <Complex128>`
`48`		`-*`
`49`		`-* var re = real( z );`
`50`		`-* // returns 1.0`
`51`		`-*`
`52`		`-* var im = imag( z );`
`53`		`-* // returns -2.0`
	`45`	`+* // returns <Complex128>[ 1.0, -2.0 ]`
`54`	`46`	`*/`
`55`	`47`	`function zlacgv( N, zx, strideZX, offsetZX ) {`
`56`	`48`	`var zx64;`
Original file line number	Diff line number	Diff line change
`@@ -36,21 +36,13 @@ var ndarray = require( './ndarray.js' );`
`36`	`36`	`*`
`37`	`37`	`* @example`
`38`	`38`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`39`		`-* var real = require( '@stdlib/complex/float64/real' );`
`40`		`-* var imag = require( '@stdlib/complex/float64/imag' );`
`41`	`39`	`*`
`42`	`40`	`* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`43`	`41`	`*`
`44`	`42`	`* zlacgv( 3, zx, 1 );`
`45`	`43`	`*`
`46`	`44`	`* var z = zx.get( 0 );`
`47`		`-* // returns <Complex128>`
`48`		`-*`
`49`		`-* var re = real( z );`
`50`		`-* // returns 1.0`
`51`		`-*`
`52`		`-* var im = imag( z );`
`53`		`-* // returns -2.0`
	`45`	`+* // returns <Complex128>[ 1.0, -2.0 ]`
`54`	`46`	`*/`
`55`	`47`	`function zlacgv( N, zx, strideZX ) {`
`56`	`48`	`return ndarray( N, zx, strideZX, stride2offset( N, strideZX ) );`