Skip to content

Commit ba34b1b

Browse files
sagar7162sagar7162
authored
docs: improve doctests for complex number instances in lapack/base/zlacpy
PR-URL: #8776 Ref: #8641 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 4c6da75 commit ba34b1b

5 files changed

Lines changed: 28 additions & 224 deletions

File tree

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

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,14 @@ interface Routine {
4242
*
4343
* @example
4444
* var Complex128Array = require( '@stdlib/array/complex128' );
45-
* var real = require( '@stdlib/complex/float64/real' );
46-
* var imag = require( '@stdlib/complex/float64/imag' );
4745
*
4846
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4947
* var B = new Complex128Array( 4 );
5048
*
5149
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
5250
*
5351
* var z = B.get( 0 );
54-
* // returns <Complex128>
55-
*
56-
* var v = real( z );
57-
* // returns 1.0
58-
*
59-
* v = imag( z );
60-
* // returns 2.0
52+
* // returns <Complex128>[ 1.0, 2.0 ]
6153
*/
6254
( order: Layout, uplo: string, M: number, N: number, A: Complex128Array, LDA: number, B: Complex128Array, LDB: number ): Complex128Array;
6355

@@ -79,22 +71,14 @@ interface Routine {
7971
*
8072
* @example
8173
* var Complex128Array = require( '@stdlib/array/complex128' );
82-
* var real = require( '@stdlib/complex/float64/real' );
83-
* var imag = require( '@stdlib/complex/float64/imag' );
8474
*
8575
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
8676
* var B = new Complex128Array( 12 );
8777
*
8878
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
8979
*
9080
* var z = B.get( 2 );
91-
* // returns <Complex128>
92-
*
93-
* var v = real( z );
94-
* // returns 3.0
95-
*
96-
* v = imag( z );
97-
* // returns 4.0
81+
* // returns <Complex128>[ 3.0, 4.0 ]
9882
*/
9983
ndarray( uplo: string, M: number, N: number, A: Complex128Array, strideA1: number, strideA2: number, offsetA: number, B: Complex128Array, strideB1: number, strideB2: number, offsetB: number ): Complex128Array;
10084
}
@@ -114,41 +98,25 @@ interface Routine {
11498
*
11599
* @example
116100
* var Complex128Array = require( '@stdlib/array/complex128' );
117-
* var real = require( '@stdlib/complex/float64/real' );
118-
* var imag = require( '@stdlib/complex/float64/imag' );
119101
*
120102
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
121103
* var B = new Complex128Array( 4 );
122104
*
123105
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
124106
*
125107
* var z = B.get( 0 );
126-
* // returns <Complex128>
127-
*
128-
* var v = real( z );
129-
* // returns 1.0
130-
*
131-
* v = imag( z );
132-
* // returns 2.0
108+
* // returns <Complex128>[ 1.0, 2.0 ]
133109
*
134110
* @example
135111
* var Complex128Array = require( '@stdlib/array/complex128' );
136-
* var real = require( '@stdlib/complex/float64/real' );
137-
* var imag = require( '@stdlib/complex/float64/imag' );
138112
*
139113
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
140114
* var B = new Complex128Array( 12 );
141115
*
142116
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
143117
*
144118
* var z = B.get( 2 );
145-
* // returns <Complex128>
146-
*
147-
* var v = real( z );
148-
* // returns 3.0
149-
*
150-
* v = imag( z );
151-
* // returns 4.0
119+
* // returns <Complex128>[ 3.0, 4.0 ]
152120
*/
153121
declare var zlacpy: Routine;
154122

‎lib/node_modules/@stdlib/lapack/base/zlacpy/lib/base.js‎

Lines changed: 12 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -444,54 +444,26 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2,
444444
*
445445
* @example
446446
* var Complex128Array = require( '@stdlib/array/complex128' );
447-
* var real = require( '@stdlib/complex/float64/real' );
448-
* var imag = require( '@stdlib/complex/float64/imag' );
449447
*
450448
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
451449
* var B = new Complex128Array( 4 );
452450
*
453451
* zlacpy( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
454452
*
455453
* var z = B.get( 0 );
456-
* // returns <Complex128>
457-
*
458-
* var v = real( z );
459-
* // returns 1.0
460-
*
461-
* v = imag( z );
462-
* // returns 2.0
454+
* // returns <Complex128>[ 1.0, 2.0 ]
463455
*
464456
* z = B.get( 1 );
465-
* // returns <Complex128>
466-
*
467-
* v = real( z );
468-
* // returns 3.0
469-
*
470-
* v = imag( z );
471-
* // returns 4.0
457+
* // returns <Complex128>[ 3.0, 4.0 ]
472458
*
473459
* z = B.get( 2 );
474-
* // returns <Complex128>
475-
*
476-
* v = real( z );
477-
* // returns 5.0
478-
*
479-
* v = imag( z );
480-
* // returns 6.0
460+
* // returns <Complex128>[ 5.0, 6.0 ]
481461
*
482462
* z = B.get( 3 );
483-
* // returns <Complex128>
484-
*
485-
* v = real( z );
486-
* // returns 7.0
487-
*
488-
* v = imag( z );
489-
* // returns 8.0
463+
* // returns <Complex128>[ 7.0, 8.0 ]
490464
*
491465
* @example
492466
* var Complex128Array = require( '@stdlib/array/complex128' );
493-
* var real = require( '@stdlib/complex/float64/real' );
494-
* var imag = require( '@stdlib/complex/float64/imag' );
495467
*
496468
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
497469
* var B = new Complex128Array( 4 );
@@ -500,86 +472,36 @@ function copyLower( M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2,
500472
* // B => <Complex128Array>
501473
*
502474
* var z = B.get( 0 );
503-
* // returns <Complex128>
504-
*
505-
* var v = real( z );
506-
* // returns 1.0
507-
*
508-
* v = imag( z );
509-
* // returns 2.0
475+
* // returns <Complex128>[ 1.0, 2.0 ]
510476
*
511477
* z = B.get( 1 );
512-
* // returns <Complex128>
513-
*
514-
* v = real( z );
515-
* // returns 3.0
516-
*
517-
* v = imag( z );
518-
* // returns 4.0
478+
* // returns <Complex128>[ 3.0, 4.0 ]
519479
*
520480
* z = B.get( 2 );
521-
* // returns <Complex128>
522-
*
523-
* v = real( z );
524-
* // returns 0.0
525-
*
526-
* v = imag( z );
527-
* // returns 0.0
481+
* // returns <Complex128>[ 0.0, 0.0 ]
528482
*
529483
* z = B.get( 3 );
530-
* // returns <Complex128>
531-
*
532-
* v = real( z );
533-
* // returns 7.0
534-
*
535-
* v = imag( z );
536-
* // returns 8.0
484+
* // returns <Complex128>[ 7.0, 8.0 ]
537485
*
538486
* @example
539487
* var Complex128Array = require( '@stdlib/array/complex128' );
540-
* var real = require( '@stdlib/complex/float64/real' );
541-
* var imag = require( '@stdlib/complex/float64/imag' );
542488
*
543489
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
544490
* var B = new Complex128Array( 4 );
545491
*
546492
* zlacpy( 'lower', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
547493
*
548494
* var z = B.get( 0 );
549-
* // returns <Complex128>
550-
*
551-
* var v = real( z );
552-
* // returns 1.0
553-
*
554-
* v = imag( z );
555-
* // returns 2.0
495+
* // returns <Complex128>[ 1.0, 2.0 ]
556496
*
557497
* z = B.get( 1 );
558-
* // returns <Complex128>
559-
*
560-
* v = real( z );
561-
* // returns 0.0
562-
*
563-
* v = imag( z );
564-
* // returns 0.0
498+
* // returns <Complex128>[ 0.0, 0.0 ]
565499
*
566500
* z = B.get( 2 );
567-
* // returns <Complex128>
568-
*
569-
* v = real( z );
570-
* // returns 5.0
571-
*
572-
* v = imag( z );
573-
* // returns 6.0
501+
* // returns <Complex128>[ 5.0, 6.0 ]
574502
*
575503
* z = B.get( 3 );
576-
* // returns <Complex128>
577-
*
578-
* v = real( z );
579-
* // returns 7.0
580-
*
581-
* v = imag( z );
582-
* // returns 8.0
504+
* // returns <Complex128>[ 7.0, 8.0 ]
583505
*/
584506
function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) {
585507
var viewA;

‎lib/node_modules/@stdlib/lapack/base/zlacpy/lib/index.js‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,10 @@
3535
* zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
3636
*
3737
* var z = B.get( 0 );
38-
* // returns <Complex128>
39-
*
40-
* var v = real( z );
41-
* // returns 1.0
42-
*
43-
* v = imag( z );
44-
* // returns 2.0
38+
* // returns <Complex128>[ 1.0, 2.0 ]
4539
*
4640
* @example
4741
* var Complex128Array = require( '@stdlib/array/complex128' );
48-
* var real = require( '@stdlib/complex/float64/real' );
49-
* var imag = require( '@stdlib/complex/float64/imag' );
5042
* var zlacpy = require( '@stdlib/lapack/base/zlacpy' );
5143
*
5244
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
@@ -55,13 +47,7 @@
5547
* zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
5648
*
5749
* var z = B.get( 2 );
58-
* // returns <Complex128>
59-
*
60-
* var v = real( z );
61-
* // returns 3.0
62-
*
63-
* v = imag( z );
64-
* // returns 4.0
50+
* // returns <Complex128>[ 3.0, 4.0 ]
6551
*/
6652

6753
// MODULES //

‎lib/node_modules/@stdlib/lapack/base/zlacpy/lib/ndarray.js‎

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -43,78 +43,42 @@ var base = require( './base.js' );
4343
*
4444
* @example
4545
* var Complex128Array = require( '@stdlib/array/complex128' );
46-
* var real = require( '@stdlib/complex/float64/real' );
47-
* var imag = require( '@stdlib/complex/float64/imag' );
4846
*
4947
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
5048
* var B = new Complex128Array( 12 );
5149
*
5250
* zlacpy( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
5351
*
5452
* var z = B.get( 2 );
55-
* // returns <Complex128>
56-
*
57-
* var v = real( z );
58-
* // returns 3.0
59-
*
60-
* v = imag( z );
61-
* // returns 4.0
53+
* // returns <Complex128>[ 3.0, 4.0 ]
6254
*
6355
* @example
6456
* var Complex128Array = require( '@stdlib/array/complex128' );
65-
* var real = require( '@stdlib/complex/float64/real' );
66-
* var imag = require( '@stdlib/complex/float64/imag' );
6757
*
6858
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
6959
* var B = new Complex128Array( 12 );
7060
*
7161
* zlacpy( 'upper', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
7262
*
7363
* var z = B.get( 2 );
74-
* // returns <Complex128>
75-
*
76-
* var v = real( z );
77-
* // returns 3.0
78-
*
79-
* v = imag( z );
80-
* // returns 4.0
64+
* // returns <Complex128>[ 3.0, 4.0 ]
8165
*
8266
* z = B.get( 4 );
83-
* // returns <Complex128>
84-
*
85-
* v = real( z );
86-
* // returns 0.0
87-
*
88-
* v = imag( z );
89-
* // returns 0.0
67+
* // returns <Complex128>[ 0.0, 0.0 ]
9068
*
9169
* @example
9270
* var Complex128Array = require( '@stdlib/array/complex128' );
93-
* var real = require( '@stdlib/complex/float64/real' );
94-
* var imag = require( '@stdlib/complex/float64/imag' );
9571
*
9672
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
9773
* var B = new Complex128Array( 12 );
9874
*
9975
* zlacpy( 'lower', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
10076
*
10177
* var z = B.get( 2 );
102-
* // returns <Complex128>
103-
*
104-
* var v = real( z );
105-
* // returns 3.0
106-
*
107-
* v = imag( z );
108-
* // returns 4.0
78+
* // returns <Complex128>[ 3.0, 4.0 ]
10979
*
11080
* z = B.get( 1 );
111-
* // returns <Complex128>
112-
*
113-
* v = real( z );
114-
* // returns 0.0
115-
*
116-
* v = imag( z );
117-
* // returns 0.0
81+
* // returns <Complex128>[ 0.0, 0.0 ]
11882
*/
11983
function zlacpy( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ) { // eslint-disable-line max-len, max-params
12084
return base( uplo, M, N, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB ); // eslint-disable-line max-len

0 commit comments

Comments
 (0)