Skip to content

Commit ee5eced

Browse files
anandkaranubckgryte
anandkaranubc
and
kgryte
authored
docs: improve doctests for complex number typed arrays in blas/base/wasm
PR-URL: #11975 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#517 Ref: #4833
1 parent bd61437 commit ee5eced

9 files changed

Lines changed: 92 additions & 166 deletions

File tree

‎lib/node_modules/@stdlib/blas/base/wasm/ccopy/docs/repl.txt‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -493,11 +493,8 @@
493493
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
494494
> mod.read( yptr, view );
495495

496-
> var v = view.get( 0 );
497-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
498-
1.0
499-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
500-
2.0
496+
> view
497+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
501498

502499

503500
{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )
@@ -559,11 +556,8 @@
559556
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
560557
> mod.read( yptr, view );
561558

562-
> var v = view.get( 0 );
563-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
564-
1.0
565-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
566-
2.0
559+
> view
560+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
567561

568562
See Also
569563
--------

‎lib/node_modules/@stdlib/blas/base/wasm/cscal/docs/repl.txt‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -462,28 +462,25 @@
462462

463463
// Define "pointers" (i.e., byte offsets) into module memory:
464464
> var xptr = 0;
465-
> var zptr = 80;
465+
> var zptr = 32;
466466

467467
// Write data to module memory:
468-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float32' );
468+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float32' );
469469
> var x = new {{alias:@stdlib/array/complex64}}( xbuf.buffer );
470470
> mod.write( xptr, x );
471471

472472
// Write a complex number to module memory:
473473
> mod.write( zptr, new {{alias:@stdlib/array/float32}}( [ 2.0, 2.0 ] ) );
474474

475475
// Perform computation:
476-
> mod.main( 5, zptr, xptr, 1 );
476+
> mod.main( 4, zptr, xptr, 1 );
477477

478478
// Extract results from module memory:
479-
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
479+
> var view = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
480480
> mod.read( xptr, view );
481481

482-
> var v = view.get( 0 );
483-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
484-
-2.0
485-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
486-
6.0
482+
> view
483+
<Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
487484

488485

489486
{{alias}}.Module.prototype.ndarray( N, cap, cxp, sx, ox )
@@ -521,28 +518,25 @@
521518

522519
// Define "pointers" (i.e., byte offsets) into module memory:
523520
> var xptr = 0;
524-
> var zptr = 80;
521+
> var zptr = 32;
525522

526523
// Write data to module memory:
527-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float32' );
524+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float32' );
528525
> var x = new {{alias:@stdlib/array/complex64}}( xbuf.buffer );
529526
> mod.write( xptr, x );
530527

531528
// Write a complex number to module memory:
532529
> mod.write( zptr, new {{alias:@stdlib/array/float32}}( [ 2.0, 2.0 ] ) );
533530

534531
// Perform computation:
535-
> mod.ndarray( 5, zptr, xptr, 1, 0 );
532+
> mod.ndarray( 4, zptr, xptr, 1, 0 );
536533

537534
// Extract results from module memory:
538-
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
535+
> var view = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
539536
> mod.read( xptr, view );
540537

541-
> var v = view.get( 0 );
542-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
543-
-2.0
544-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
545-
6.0
538+
> view
539+
<Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
546540

547541
See Also
548542
--------

‎lib/node_modules/@stdlib/blas/base/wasm/csrot/docs/repl.txt‎

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -496,36 +496,30 @@
496496

497497
// Define "pointers" (i.e., byte offsets) into module memory:
498498
> var xptr = 0;
499-
> var yptr = 40;
499+
> var yptr = 32;
500500

501501
// Write data to module memory:
502-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float32' );
502+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float32' );
503503
> var x = new {{alias:@stdlib/array/complex64}}( xbuf.buffer );
504504
> mod.write( xptr, x );
505505

506-
> var ybuf = {{alias:@stdlib/array/ones}}( 10, 'float32' );
506+
> var ybuf = {{alias:@stdlib/array/ones}}( 8, 'float32' );
507507
> var y = new {{alias:@stdlib/array/complex64}}( ybuf.buffer );
508508
> mod.write( yptr, y );
509509

510510
// Perform computation:
511-
> mod.main( 5, xptr, 1, yptr, 1, 0.8, 0.6 );
511+
> mod.main( 4, xptr, 1, yptr, 1, 0.8, 0.6 );
512512

513513
// Extract results from module memory:
514-
> var viewX = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
515-
> var viewY = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
514+
> var viewX = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
515+
> var viewY = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
516516
> mod.read( xptr, viewX );
517517
> mod.read( yptr, viewY );
518518

519-
> var v = viewX.get( 1 );
520-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
521-
~3.0
522-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
523-
~3.8
524-
> v = viewY.get( 1 );
525-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
526-
~-1.0
527-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
528-
~-1.6
519+
> viewX
520+
<Complex64Array>[ ~1.4, ~2.2, 3.0, ~3.8, ~4.6, ~5.4, ~6.2, 7.0 ]
521+
> viewY
522+
<Complex64Array>[ ~0.2, ~-0.4, -1.0, ~-1.6, ~-2.2, ~-2.8, ~-3.4, -4.0 ]
529523

530524

531525
{{alias}}.Module.prototype.ndarray( N, cxp, sx, ox, cyp, sy, oy, c, s )
@@ -573,36 +567,30 @@
573567

574568
// Define "pointers" (i.e., byte offsets) into module memory:
575569
> var xptr = 0;
576-
> var yptr = 40;
570+
> var yptr = 32;
577571

578572
// Write data to module memory:
579-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float32' );
573+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float32' );
580574
> var x = new {{alias:@stdlib/array/complex64}}( xbuf.buffer );
581575
> mod.write( xptr, x );
582576

583-
> var ybuf = {{alias:@stdlib/array/ones}}( 10, 'float32' );
577+
> var ybuf = {{alias:@stdlib/array/ones}}( 8, 'float32' );
584578
> var y = new {{alias:@stdlib/array/complex64}}( ybuf.buffer );
585579
> mod.write( yptr, y );
586580

587581
// Perform computation:
588-
> mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0, 0.8, 0.6 );
582+
> mod.ndarray( 4, xptr, 1, 0, yptr, 1, 0, 0.8, 0.6 );
589583

590584
// Extract results from module memory:
591-
> var viewX = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
592-
> var viewY = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
585+
> var viewX = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
586+
> var viewY = {{alias:@stdlib/array/zeros}}( 4, 'complex64' );
593587
> mod.read( xptr, viewX );
594588
> mod.read( yptr, viewY );
595589

596-
> var v = viewX.get( 1 );
597-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
598-
~3.0
599-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
600-
~3.8
601-
> v = viewY.get( 1 );
602-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
603-
~-1.0
604-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
605-
~-1.6
590+
> viewX
591+
<Complex64Array>[ ~1.4, ~2.2, 3.0, ~3.8, ~4.6, ~5.4, ~6.2, 7.0 ]
592+
> viewY
593+
<Complex64Array>[ ~0.2, ~-0.4, -1.0, ~-1.6, ~-2.2, ~-2.8, ~-3.4, -4.0 ]
606594

607595
See Also
608596
--------

‎lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/repl.txt‎

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -505,17 +505,11 @@
505505
> mod.read( xptr, viewX );
506506
> mod.read( yptr, viewY );
507507

508-
> var v = viewX.get( 0 );
509-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
510-
0.0
511-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
512-
0.0
508+
> viewX
509+
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
513510

514-
> var v = viewY.get( 0 );
515-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
516-
1.0
517-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
518-
2.0
511+
> viewY
512+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
519513

520514

521515
{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )
@@ -578,17 +572,11 @@
578572
> mod.read( xptr, viewX );
579573
> mod.read( yptr, viewY );
580574

581-
> var v = viewX.get( 0 );
582-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
583-
0.0
584-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
585-
0.0
586-
587-
> var v = viewY.get( 0 );
588-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
589-
1.0
590-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
591-
2.0
575+
> viewX
576+
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
577+
578+
> viewY
579+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
592580

593581
See Also
594582
--------

‎lib/node_modules/@stdlib/blas/base/wasm/zcopy/docs/repl.txt‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@
475475

476476
// Define "pointers" (i.e., byte offsets) into module memory:
477477
> var xptr = 0;
478-
> var yptr = 40;
478+
> var yptr = 80;
479479

480480
// Write data to module memory:
481481
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' );
@@ -493,11 +493,8 @@
493493
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
494494
> mod.read( yptr, view );
495495

496-
> var v = view.get( 0 );
497-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
498-
1.0
499-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
500-
2.0
496+
> view
497+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
501498

502499

503500
{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )
@@ -541,7 +538,7 @@
541538

542539
// Define "pointers" (i.e., byte offsets) into module memory:
543540
> var xptr = 0;
544-
> var yptr = 40;
541+
> var yptr = 80;
545542

546543
// Write data to module memory:
547544
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' );
@@ -559,11 +556,8 @@
559556
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
560557
> mod.read( yptr, view );
561558

562-
> var v = view.get( 0 );
563-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
564-
1.0
565-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
566-
2.0
559+
> view
560+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
567561

568562
See Also
569563
--------

‎lib/node_modules/@stdlib/blas/base/wasm/zcopy/docs/types/index.d.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,8 +427,6 @@ interface Routine extends ModuleWrapper {
427427
*
428428
* @example
429429
* var Complex128Array = require( '@stdlib/array/complex128' );
430-
* var real = require( '@stdlib/complex/float64/real' );
431-
* var imag = require( '@stdlib/complex/float64/imag' );
432430
*
433431
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
434432
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

‎lib/node_modules/@stdlib/blas/base/wasm/zdrot/docs/repl.txt‎

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -496,36 +496,30 @@
496496

497497
// Define "pointers" (i.e., byte offsets) into module memory:
498498
> var xptr = 0;
499-
> var yptr = 80;
499+
> var yptr = 64;
500500

501501
// Write data to module memory:
502-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' );
502+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float64' );
503503
> var x = new {{alias:@stdlib/array/complex128}}( xbuf.buffer );
504504
> mod.write( xptr, x );
505505

506-
> var ybuf = {{alias:@stdlib/array/ones}}( 10, 'float64' );
506+
> var ybuf = {{alias:@stdlib/array/ones}}( 8, 'float64' );
507507
> var y = new {{alias:@stdlib/array/complex128}}( ybuf.buffer );
508508
> mod.write( yptr, y );
509509

510510
// Perform computation:
511-
> mod.main( 5, xptr, 1, yptr, 1, 0.8, 0.6 );
511+
> mod.main( 4, xptr, 1, yptr, 1, 0.8, 0.6 );
512512

513513
// Extract results from module memory:
514-
> var viewX = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
515-
> var viewY = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
514+
> var viewX = {{alias:@stdlib/array/zeros}}( 4, 'complex128' );
515+
> var viewY = {{alias:@stdlib/array/zeros}}( 4, 'complex128' );
516516
> mod.read( xptr, viewX );
517517
> mod.read( yptr, viewY );
518518

519-
> var v = viewX.get( 1 );
520-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
521-
~3.0
522-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
523-
~3.8
524-
> v = viewY.get( 1 );
525-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
526-
~-1.0
527-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
528-
~-1.6
519+
> viewX
520+
<Complex128Array>[ 1.4, 2.2, 3.0, 3.8, 4.6, 5.4, 6.2, 7.0 ]
521+
> viewY
522+
<Complex128Array>[ 0.2, -0.4, -1.0, -1.6, -2.2, -2.8, -3.4, -4.0 ]
529523

530524

531525
{{alias}}.Module.prototype.ndarray( N, zxp, sx, ox, zyp, sy, oy, c, s )
@@ -573,36 +567,30 @@
573567

574568
// Define "pointers" (i.e., byte offsets) into module memory:
575569
> var xptr = 0;
576-
> var yptr = 80;
570+
> var yptr = 64;
577571

578572
// Write data to module memory:
579-
> var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' );
573+
> var xbuf = {{alias:@stdlib/array/one-to}}( 8, 'float64' );
580574
> var x = new {{alias:@stdlib/array/complex128}}( xbuf.buffer );
581575
> mod.write( xptr, x );
582576

583-
> var ybuf = {{alias:@stdlib/array/ones}}( 10, 'float64' );
577+
> var ybuf = {{alias:@stdlib/array/ones}}( 8, 'float64' );
584578
> var y = new {{alias:@stdlib/array/complex128}}( ybuf.buffer );
585579
> mod.write( yptr, y );
586580

587581
// Perform computation:
588-
> mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0, 0.8, 0.6 );
582+
> mod.ndarray( 4, xptr, 1, 0, yptr, 1, 0, 0.8, 0.6 );
589583

590584
// Extract results from module memory:
591-
> var viewX = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
592-
> var viewY = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
585+
> var viewX = {{alias:@stdlib/array/zeros}}( 4, 'complex128' );
586+
> var viewY = {{alias:@stdlib/array/zeros}}( 4, 'complex128' );
593587
> mod.read( xptr, viewX );
594588
> mod.read( yptr, viewY );
595589

596-
> var v = viewX.get( 1 );
597-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
598-
~3.0
599-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
600-
~3.8
601-
> v = viewY.get( 1 );
602-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
603-
~-1.0
604-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
605-
~-1.6
590+
> viewX
591+
<Complex128Array>[ 1.4, 2.2, 3.0, 3.8, 4.6, 5.4, 6.2, 7.0 ]
592+
> viewY
593+
<Complex128Array>[ 0.2, -0.4, -1.0, -1.6, -2.2, -2.8, -3.4, -4.0 ]
606594

607595
See Also
608596
--------

0 commit comments

Comments
 (0)