Skip to content

docs: improve doctests for complex number typed arrays in blas/base/wasm #11975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anandkaranubc wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: improve doctests for complex number typed arrays in blas/base/wasm #11975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions lib/node_modules/@stdlib/blas/base/wasm/ccopy/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,11 +493,8 @@
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
> mod.read( yptr, view );

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


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

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

See Also
--------
Expand Down
14 changes: 4 additions & 10 deletions lib/node_modules/@stdlib/blas/base/wasm/cscal/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,11 +479,8 @@
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
> mod.read( xptr, view );

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


{{alias}}.Module.prototype.ndarray( N, cap, cxp, sx, ox )
Expand Down Expand Up @@ -538,11 +535,8 @@
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );
> mod.read( xptr, view );

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

See Also
--------
Expand Down
28 changes: 8 additions & 20 deletions lib/node_modules/@stdlib/blas/base/wasm/csrot/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,16 +516,10 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 1 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
~3.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
~3.8
> v = viewY.get( 1 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
~-1.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
~-1.6
> viewX
<Complex64Array>[ ~1.4, ~2.2, 3.0, ~3.8, ~4.6, ~5.4, ~6.2, 7.0, ~7.8, ~8.6 ]
> viewY
<Complex64Array>[ ~0.2, ~-0.4, -1.0, ~-1.6, ~-2.2, ~-2.8, ~-3.4, -4.0, ~-4.6, ~-5.2 ]


{{alias}}.Module.prototype.ndarray( N, cxp, sx, ox, cyp, sy, oy, c, s )
Expand Down Expand Up @@ -593,16 +587,10 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 1 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
~3.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
~3.8
> v = viewY.get( 1 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
~-1.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
~-1.6
> viewX
<Complex64Array>[ ~1.4, ~2.2, 3.0, ~3.8, ~4.6, ~5.4, ~6.2, 7.0, ~7.8, ~8.6 ]
> viewY
<Complex64Array>[ ~0.2, ~-0.4, -1.0, ~-1.6, ~-2.2, ~-2.8, ~-3.4, -4.0, ~-4.6, ~-5.2 ]

See Also
--------
Expand Down
30 changes: 9 additions & 21 deletions lib/node_modules/@stdlib/blas/base/wasm/cswap/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,17 +505,11 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
0.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
0.0
> viewX
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

> var v = viewY.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
1.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
2.0
> viewY
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]


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

> var v = viewX.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
0.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
0.0

> var v = viewY.get( 0 );
> var re = {{alias:@stdlib/complex/float32/real}}( v )
1.0
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
2.0
> viewX
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

> viewY
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]

See Also
--------
Expand Down
18 changes: 6 additions & 12 deletions lib/node_modules/@stdlib/blas/base/wasm/zcopy/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@

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

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

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


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

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

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

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

See Also
--------
Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/blas/base/wasm/zcopy/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,8 +427,6 @@ interface Routine extends ModuleWrapper {
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
Expand Down
28 changes: 8 additions & 20 deletions lib/node_modules/@stdlib/blas/base/wasm/zdrot/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,16 +516,10 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 1 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
~3.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
~3.8
> v = viewY.get( 1 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
~-1.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
~-1.6
> viewX
<Complex128Array>[ 1.4, 2.2, 3.0, 3.8, 4.6, 5.4, 6.2, 7.0, 7.8, 8.6 ]
> viewY
<Complex128Array>[ 0.2, -0.4, -1.0, -1.6, -2.2, -2.8, -3.4, -4.0, -4.6, -5.2 ]


{{alias}}.Module.prototype.ndarray( N, zxp, sx, ox, zyp, sy, oy, c, s )
Expand Down Expand Up @@ -593,16 +587,10 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 1 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
~3.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
~3.8
> v = viewY.get( 1 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
~-1.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
~-1.6
> viewX
<Complex128Array>[ 1.4, 2.2, 3.0, 3.8, 4.6, 5.4, 6.2, 7.0, 7.8, 8.6 ]
> viewY
<Complex128Array>[ 0.2, -0.4, -1.0, -1.6, -2.2, -2.8, -3.4, -4.0, -4.6, -5.2 ]

See Also
--------
Expand Down
14 changes: 4 additions & 10 deletions lib/node_modules/@stdlib/blas/base/wasm/zscal/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,11 +479,8 @@
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
> mod.read( xptr, view );

> var v = view.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
-2.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
6.0
> view
<Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0, -2.0, 38.0 ]


{{alias}}.Module.prototype.ndarray( N, ap, xp, sx, ox )
Expand Down Expand Up @@ -538,11 +535,8 @@
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex128' );
> mod.read( xptr, view );

> var v = view.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
-2.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
6.0
> view
<Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0, -2.0, 38.0 ]

See Also
--------
Expand Down
30 changes: 9 additions & 21 deletions lib/node_modules/@stdlib/blas/base/wasm/zswap/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,17 +505,11 @@
> mod.read( xptr, viewX );
> mod.read( yptr, viewY );

> var v = viewX.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
0.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
0.0
> viewX
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

> var v = viewY.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
1.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
2.0
> viewY
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]


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

> var v = viewX.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
0.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
0.0

> var v = viewY.get( 0 );
> var re = {{alias:@stdlib/complex/float64/real}}( v )
1.0
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
2.0
> viewX
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

> viewY
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]

See Also
--------
Expand Down
Loading