Skip to content

Commit ea11328

Browse files
Rupa-Rdkgryte
Rupa-Rd
and
kgryte
authored
docs: update examples for blas/base/wasm/cscal
PR-URL: #6495 Ref: #4833 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>
1 parent cbffd97 commit ea11328

File tree

6 files changed

+29
-213
lines changed

6 files changed

+29
-213
lines changed

‎lib/node_modules/@stdlib/blas/base/wasm/cscal/README.md‎

Lines changed: 5 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ Scales values from `cx` by `ca`.
3737
```javascript
3838
var Complex64Array = require( '@stdlib/array/complex64' );
3939
var Complex64 = require( '@stdlib/complex/float32/ctor' );
40-
var realf = require( '@stdlib/complex/float32/real' );
41-
var imagf = require( '@stdlib/complex/float32/imag' );
4240

4341
// Define a strided array:
4442
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -48,15 +46,8 @@ var ca = new Complex64( 2.0, 2.0 );
4846

4947
// Perform operation:
5048
cscal.main( cx.length, ca, cx, 1 );
49+
// cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5150

52-
var v = cx.get( 0 );
53-
// returns <Complex64>
54-
55-
var re = realf( v );
56-
// returns -2.0
57-
58-
var im = imagf( v );
59-
// returns 6.0
6051
```
6152

6253
The function has the following parameters:
@@ -71,8 +62,6 @@ The `N` and stride parameters determine which elements in the input strided arra
7162
```javascript
7263
var Complex64Array = require( '@stdlib/array/complex64' );
7364
var Complex64 = require( '@stdlib/complex/float32/ctor' );
74-
var realf = require( '@stdlib/complex/float32/real' );
75-
var imagf = require( '@stdlib/complex/float32/imag' );
7665

7766
// Define a strided array:
7867
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -82,15 +71,8 @@ var ca = new Complex64( 2.0, 0.0 );
8271

8372
// Perform operation:
8473
cscal.main( 2, ca, cx, 2 );
74+
// cx => <Complex64Array>[ 2.0, 4.0, 3.0, 4.0, 10.0, 12.0 ]
8575

86-
var v = cx.get( 2 );
87-
// returns <Complex64>
88-
89-
var re = realf( v );
90-
// returns 10.0
91-
92-
var im = imagf( v );
93-
// returns 12.0
9476
```
9577

9678
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -100,8 +82,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
10082
```javascript
10183
var Complex64Array = require( '@stdlib/array/complex64' );
10284
var Complex64 = require( '@stdlib/complex/float32/ctor' );
103-
var realf = require( '@stdlib/complex/float32/real' );
104-
var imagf = require( '@stdlib/complex/float32/imag' );
10585

10686
// Initial array:
10787
var cx0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -114,15 +94,8 @@ var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at
11494

11595
// Scales every other value from `cx1` by `ca`...
11696
cscal.main( 3, ca, cx1, 1 );
97+
// cx0 => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0, -2.0, 30.0 ]
11798

118-
var z = cx0.get( 1 );
119-
// returns <Complex64>
120-
121-
var re = realf( z );
122-
// returns -2.0
123-
124-
var im = imagf( z );
125-
// returns 14.0
12699
```
127100

128101
#### cscal.ndarray( N, ca, cx, strideX, offsetX )
@@ -132,8 +105,6 @@ Scales values from `cx` by `ca` using alternative indexing semantics.
132105
```javascript
133106
var Complex64Array = require( '@stdlib/array/complex64' );
134107
var Complex64 = require( '@stdlib/complex/float32/ctor' );
135-
var realf = require( '@stdlib/complex/float32/real' );
136-
var imagf = require( '@stdlib/complex/float32/imag' );
137108

138109
// Define a strided array:
139110
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -143,15 +114,8 @@ var ca = new Complex64( 2.0, 2.0 );
143114

144115
// Perform operation:
145116
cscal.ndarray( cx.length, ca, cx, 1, 0 );
117+
// cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
146118

147-
var v = cx.get( 0 );
148-
// returns <Complex64>
149-
150-
var re = realf( v );
151-
// returns -2.0
152-
153-
var im = imagf( v );
154-
// returns 6.0
155119
```
156120

157121
The function has the following additional parameters:
@@ -163,22 +127,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
163127
```javascript
164128
var Complex64Array = require( '@stdlib/array/complex64' );
165129
var Complex64 = require( '@stdlib/complex/float32/ctor' );
166-
var realf = require( '@stdlib/complex/float32/real' );
167-
var imagf = require( '@stdlib/complex/float32/imag' );
168130

169131
var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
170132
var ca = new Complex64( 2.0, 2.0 );
171133

172134
cscal.ndarray( 2, ca, cx, 2, 1 );
173-
174-
var z = cx.get( 3 );
175-
// returns <Complex64>
176-
177-
var re = realf( z );
178-
// returns -2.0
179-
180-
var im = imagf( z );
181-
// returns 30.0
135+
// cx => <Complex64Array>[ 1.0, 2.0, -2.0, 14.0, 5.0, 6.0, -2.0, 30.0 ]
182136
```
183137

184138
* * *

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

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,33 +35,23 @@
3535
// Standard usage:
3636
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
3737
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
38-
> {{alias}}.main( 2, ca, cx, 1 );
39-
> var z = cx.get( 0 );
40-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
41-
-3.0
42-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
43-
4.0
38+
> {{alias}}.main( 2, ca, cx, 1 )
39+
<Complex64Array>[ -3.0, 4.0, -5.0, 10.0 ]
4440

4541
// Advanced indexing:
4642
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4743
> ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 1.0 );
48-
> {{alias}}.main( 2, ca, cx, 2 );
49-
> z = cx.get( 0 );
50-
> re = {{alias:@stdlib/complex/float32/real}}( z )
51-
-1.0
52-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
53-
3.0
44+
> {{alias}}.main( 2, ca, cx, 2 )
45+
<Complex64Array>[ -1.0, 3.0, 3.0, 4.0, -1.0, 11.0 ]
5446

5547
// Using typed array views:
5648
> var cx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
5749
> var cx1 = new {{alias:@stdlib/array/complex64}}( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 );
5850
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
59-
> {{alias}}.main( 2, ca, cx1, 1 );
60-
> z = cx0.get( 1 );
61-
> re = {{alias:@stdlib/complex/float32/real}}( z )
62-
-2.0
63-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
64-
14.0
51+
> {{alias}}.main( 2, ca, cx1, 1 )
52+
<Complex64Array>[ -2.0, 14.0, -2.0, 22.0 ]
53+
> cx0
54+
<Complex64Array>[ 1.0, 2.0, -2.0, 14.0, -2.0, 22.0 ]
6555

6656

6757
{{alias}}.ndarray( N, ca, cx, strideX, offsetX )
@@ -100,22 +90,14 @@
10090
// Standard usage:
10191
> var cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
10292
> var ca = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 );
103-
> {{alias}}.ndarray( 2, ca, cx, 1, 0 );
104-
> var z = cx.get( 0 );
105-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
106-
-2.0
107-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
108-
6.0
93+
> {{alias}}.ndarray( 2, ca, cx, 1, 0 )
94+
<Complex64Array>[ -2.0, 6.0, -2.0, 14.0 ]
10995

11096
// Advanced indexing:
11197
> cx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
11298
> ca = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, 2.0 );
113-
> {{alias}}.ndarray( 2, ca, cx, 1, 2 );
114-
> z = cx.get( 2 );
115-
> re = {{alias:@stdlib/complex/float32/real}}( z )
116-
-7.0
117-
> im = {{alias:@stdlib/complex/float32/imag}}( z )
118-
16.0
99+
> {{alias}}.ndarray( 2, ca, cx, 1, 2 )
100+
<Complex64Array>[ 1.0, 2.0, 3.0, 4.0, -7.0, 16.0, -9.0, 22.0 ]
119101

120102

121103
{{alias}}.Module( memory )

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

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -317,8 +317,6 @@ interface Routine extends ModuleWrapper {
317317
* @example
318318
* var Complex64Array = require( '@stdlib/array/complex64' );
319319
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
320-
* var realf = require( '@stdlib/complex/float32/real' );
321-
* var imagf = require( '@stdlib/complex/float32/imag' );
322320
*
323321
* // Define a strided array:
324322
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -328,15 +326,7 @@ interface Routine extends ModuleWrapper {
328326
*
329327
* // Perform operation:
330328
* cscal.main( x.length, z, x, 1 );
331-
*
332-
* var v = x.get( 0 );
333-
* // returns <Complex64>
334-
*
335-
* var re = realf( v );
336-
* // returns -2.0
337-
*
338-
* var im = imagf( v );
339-
* // returns 6.0
329+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
340330
*/
341331
main( N: number, alpha: Complex64, x: Complex64Array, strideX: number ): Complex64Array;
342332

@@ -353,8 +343,6 @@ interface Routine extends ModuleWrapper {
353343
* @example
354344
* var Complex64Array = require( '@stdlib/array/complex64' );
355345
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
356-
* var realf = require( '@stdlib/complex/float32/real' );
357-
* var imagf = require( '@stdlib/complex/float32/imag' );
358346
*
359347
* // Define a strided array:
360348
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -364,15 +352,7 @@ interface Routine extends ModuleWrapper {
364352
*
365353
* // Perform operation:
366354
* cscal.ndarray( x.length, z, x, 1, 0 );
367-
*
368-
* var v = x.get( 0 );
369-
* // returns <Complex64>
370-
*
371-
* var re = realf( v );
372-
* // returns -2.0
373-
*
374-
* var im = imagf( v );
375-
* // returns 6.0
355+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
376356
*/
377357
ndarray( N: number, alpha: Complex64, x: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
378358

@@ -454,8 +434,6 @@ interface Routine extends ModuleWrapper {
454434
* @example
455435
* var Complex64Array = require( '@stdlib/array/complex64' );
456436
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
457-
* var realf = require( '@stdlib/complex/float32/real' );
458-
* var imagf = require( '@stdlib/complex/float32/imag' );
459437
*
460438
* // Define a strided array:
461439
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -465,21 +443,11 @@ interface Routine extends ModuleWrapper {
465443
*
466444
* // Perform operation:
467445
* cscal.main( x.length, z, x, 1 );
468-
*
469-
* var v = x.get( 0 );
470-
* // returns <Complex64>
471-
*
472-
* var re = realf( v );
473-
* // returns -2.0
474-
*
475-
* var im = imagf( v );
476-
* // returns 6.0
446+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
477447
*
478448
* @example
479449
* var Complex64Array = require( '@stdlib/array/complex64' );
480450
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
481-
* var realf = require( '@stdlib/complex/float32/real' );
482-
* var imagf = require( '@stdlib/complex/float32/imag' );
483451
*
484452
* // Define a strided array:
485453
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -489,15 +457,7 @@ interface Routine extends ModuleWrapper {
489457
*
490458
* // Perform operation:
491459
* cscal.ndarray( x.length, z, x, 1, 0 );
492-
*
493-
* var v = x.get( 0 );
494-
* // returns <Complex64>
495-
*
496-
* var re = realf( v );
497-
* // returns -2.0
498-
*
499-
* var im = imagf( v );
500-
* // returns 6.0
460+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
501461
*/
502462
declare var cscal: Routine;
503463

‎lib/node_modules/@stdlib/blas/base/wasm/cscal/lib/index.js‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626
* @example
2727
* var Complex64Array = require( '@stdlib/array/complex64' );
2828
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
29-
* var realf = require( '@stdlib/complex/float32/real' );
30-
* var imagf = require( '@stdlib/complex/float32/imag' );
3129
* var cscal = require( '@stdlib/blas/base/wasm/cscal' );
3230
*
3331
* // Define a strided array:
@@ -38,21 +36,11 @@
3836
*
3937
* // Perform operation:
4038
* cscal.main( x.length, z, x, 1 );
41-
*
42-
* var v = x.get( 0 );
43-
* // returns <Complex64>
44-
*
45-
* var re = realf( v );
46-
* // returns -2.0
47-
*
48-
* var im = imagf( v );
49-
* // returns 6.0
39+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5040
*
5141
* @example
5242
* var Complex64Array = require( '@stdlib/array/complex64' );
5343
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
54-
* var realf = require( '@stdlib/complex/float32/real' );
55-
* var imagf = require( '@stdlib/complex/float32/imag' );
5644
* var cscal = require( '@stdlib/blas/base/wasm/cscal' );
5745
*
5846
* // Define a strided array:
@@ -63,15 +51,7 @@
6351
*
6452
* // Perform operation:
6553
* cscal.ndarray( x.length, z, x, 1, 0 );
66-
*
67-
* var v = x.get( 0 );
68-
* // returns <Complex64>
69-
*
70-
* var re = realf( v );
71-
* // returns -2.0
72-
*
73-
* var im = imagf( v );
74-
* // returns 6.0
54+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
7555
*
7656
* @example
7757
* var Memory = require( '@stdlib/wasm/memory' );

‎lib/node_modules/@stdlib/blas/base/wasm/cscal/lib/main.js‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ var Routine = require( './routine.js' );
3434
* @example
3535
* var Complex64Array = require( '@stdlib/array/complex64' );
3636
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
37-
* var realf = require( '@stdlib/complex/float32/real' );
38-
* var imagf = require( '@stdlib/complex/float32/imag' );
3937
*
4038
* // Define a strided array:
4139
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -45,21 +43,11 @@ var Routine = require( './routine.js' );
4543
*
4644
* // Perform operation:
4745
* cscal.main( x.length, z, x, 1 );
48-
*
49-
* var v = x.get( 0 );
50-
* // returns <Complex64>
51-
*
52-
* var re = realf( v );
53-
* // returns -2.0
54-
*
55-
* var im = imagf( v );
56-
* // returns 6.0
46+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
5747
*
5848
* @example
5949
* var Complex64Array = require( '@stdlib/array/complex64' );
6050
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
61-
* var realf = require( '@stdlib/complex/float32/real' );
62-
* var imagf = require( '@stdlib/complex/float32/imag' );
6351
*
6452
* // Define a strided array:
6553
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -69,15 +57,7 @@ var Routine = require( './routine.js' );
6957
*
7058
* // Perform operation:
7159
* cscal.ndarray( x.length, z, x, 1, 0 );
72-
*
73-
* var v = x.get( 0 );
74-
* // returns <Complex64>
75-
*
76-
* var re = realf( v );
77-
* // returns -2.0
78-
*
79-
* var im = imagf( v );
80-
* // returns 6.0
60+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
8161
*/
8262
var cscal = new Routine();
8363
cscal.initializeSync(); // eslint-disable-line node/no-sync

0 commit comments

Comments
 (0)