Skip to content

Commit ac023f1

Browse files
DivyanshuVortexDivyanshuVortex
authored
docs: improve doctests for complex number instances in lapack/base/clacpy
PR-URL: stdlib-js#8657 Ref: stdlib-js#8641 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent ea0d5a6 commit ac023f1

File tree

6 files changed

+32
-236
lines changed

6 files changed

+32
-236
lines changed

‎lib/node_modules/@stdlib/lapack/base/clacpy/docs/repl.txt‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,8 @@
4747
> var A = new {{alias:@stdlib/array/complex64}}( abuf );
4848
> var B = new {{alias:@stdlib/array/complex64}}( bbuf );
4949
> {{alias}}( 'row-major', 'all', 2, 2, A, 2, B, 2 );
50-
> var z = B.get( 0 );
51-
> {{alias:@stdlib/complex/float32/real}}( z )
52-
1.0
53-
> {{alias:@stdlib/complex/float32/imag}}( z )
54-
2.0
50+
> var z = B.get( 0 )
51+
<Complex64>[ 1.0, 2.0 ]
5552

5653

5754
{{alias}}.ndarray( uplo, M, N, A, sa1, sa2, oa, B, sb1, sb2, ob )
@@ -110,11 +107,8 @@
110107
> var A = new {{alias:@stdlib/array/complex64}}( abuf );
111108
> var B = new {{alias:@stdlib/array/complex64}}( bbuf );
112109
> {{alias}}.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
113-
> var z = B.get( 2 );
114-
> {{alias:@stdlib/complex/float32/real}}( z )
115-
3.0
116-
> {{alias:@stdlib/complex/float32/imag}}( z )
117-
4.0
110+
> var z = B.get( 2 )
111+
<Complex64>[ 3.0, 4.0 ]
118112

119113
See Also
120114
--------

‎lib/node_modules/@stdlib/lapack/base/clacpy/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 Complex64Array = require( '@stdlib/array/complex64' );
45-
* var realf = require( '@stdlib/complex/float32/real' );
46-
* var imagf = require( '@stdlib/complex/float32/imag' );
4745
*
4846
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
4947
* var B = new Complex64Array( 4 );
5048
*
5149
* clacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
5250
*
5351
* var z = B.get( 0 );
54-
* // returns <Complex64>
55-
*
56-
* var v = realf( z );
57-
* // returns 1.0
58-
*
59-
* v = imagf( z );
60-
* // returns 2.0
52+
* // returns <Complex64>[ 1.0, 2.0 ]
6153
*/
6254
( order: Layout, uplo: string, M: number, N: number, A: Complex64Array, LDA: number, B: Complex64Array, LDB: number ): Complex64Array;
6355

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

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

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

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -46,78 +46,42 @@ var base = require( './base.js' );
4646
*
4747
* @example
4848
* var Complex64Array = require( '@stdlib/array/complex64' );
49-
* var realf = require( '@stdlib/complex/float32/real' );
50-
* var imagf = require( '@stdlib/complex/float32/imag' );
5149
*
5250
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5351
* var B = new Complex64Array( 4 );
5452
*
5553
* clacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
5654
*
5755
* var z = B.get( 0 );
58-
* // returns <Complex64>
59-
*
60-
* var v = realf( z );
61-
* // returns 1.0
62-
*
63-
* v = imagf( z );
64-
* // returns 2.0
56+
* // returns <Complex64>[ 1.0, 2.0 ]
6557
*
6658
* @example
6759
* var Complex64Array = require( '@stdlib/array/complex64' );
68-
* var realf = require( '@stdlib/complex/float32/real' );
69-
* var imagf = require( '@stdlib/complex/float32/imag' );
7060
*
7161
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7262
* var B = new Complex64Array( 4 );
7363
*
7464
* clacpy( 'row-major', 'upper', 2, 2, A, 2, B, 2 );
7565
*
7666
* var z = B.get( 0 );
77-
* // returns <Complex64>
78-
*
79-
* var v = realf( z );
80-
* // returns 1.0
81-
*
82-
* v = imagf( z );
83-
* // returns 2.0
67+
* // returns <Complex64>[ 1.0, 2.0 ]
8468
*
8569
* z = B.get( 2 );
86-
* // returns <Complex64>
87-
*
88-
* v = realf( z );
89-
* // returns 0.0
90-
*
91-
* v = imagf( z );
92-
* // returns 0.0
70+
* // returns <Complex64>[ 0.0, 0.0 ]
9371
*
9472
* @example
9573
* var Complex64Array = require( '@stdlib/array/complex64' );
96-
* var realf = require( '@stdlib/complex/float32/real' );
97-
* var imagf = require( '@stdlib/complex/float32/imag' );
9874
*
9975
* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
10076
* var B = new Complex64Array( 4 );
10177
*
10278
* clacpy( 'row-major', 'lower', 2, 2, A, 2, B, 2 );
10379
*
10480
* var z = B.get( 0 );
105-
* // returns <Complex64>
106-
*
107-
* var v = realf( z );
108-
* // returns 1.0
109-
*
110-
* v = imagf( z );
111-
* // returns 2.0
81+
* // returns <Complex64>[ 1.0, 2.0 ]
11282
*
11383
* z = B.get( 1 );
114-
* // returns <Complex64>
115-
*
116-
* v = realf( z );
117-
* // returns 0.0
118-
*
119-
* v = imagf( z );
120-
* // returns 0.0
84+
* // returns <Complex64>[ 0.0, 0.0 ]
12185
*/
12286
function clacpy( order, uplo, M, N, A, LDA, B, LDB ) {
12387
var sa1;

0 commit comments

Comments
 (0)