Skip to content

Commit 2d26990

Browse files
gururaj1512gururaj1512
authored
docs: update examples for blas/base/wasm/zcopy
PR-URL: #5442 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent 165c7fb commit 2d26990

File tree

6 files changed

+29
-215
lines changed

6 files changed

+29
-215
lines changed

Diff for: ‎lib/node_modules/@stdlib/blas/base/wasm/zcopy/README.md

+5-55
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,14 @@ Copies values from `x` into `y`.
3636

3737
```javascript
3838
var Complex128Array = require( '@stdlib/array/complex128' );
39-
var real = require( '@stdlib/complex/float64/real' );
40-
var imag = require( '@stdlib/complex/float64/imag' );
4139

4240
// Define strided arrays...
4341
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4442
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4543

4644
// Perform operation:
4745
zcopy.main( x.length, x, 1, y, 1 );
48-
49-
var v = y.get( 0 );
50-
// returns <Complex128>
51-
52-
var re = real( v );
53-
// returns 1.0
54-
55-
var im = imag( v );
56-
// returns 2.0
46+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
5747
```
5848

5949
The function has the following parameters:
@@ -68,22 +58,12 @@ The `N` and stride parameters determine how values from `x` are copied into `y`.
6858

6959
```javascript
7060
var Complex128Array = require( '@stdlib/array/complex128' );
71-
var real = require( '@stdlib/complex/float64/real' );
72-
var imag = require( '@stdlib/complex/float64/imag' );
7361

7462
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
7563
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7664

7765
zcopy.main( 2, x, -2, y, 1 );
78-
79-
var v = y.get( 0 );
80-
// returns <Complex128>
81-
82-
var re = real( v );
83-
// returns 5.0
84-
85-
var im = imag( v );
86-
// returns 6.0
66+
// y => <Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
8767
```
8868

8969
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -92,8 +72,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9272

9373
```javascript
9474
var Complex128Array = require( '@stdlib/array/complex128' );
95-
var real = require( '@stdlib/complex/float64/real' );
96-
var imag = require( '@stdlib/complex/float64/imag' );
9775

9876
// Initial arrays...
9977
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
@@ -105,15 +83,7 @@ var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3
10583

10684
// Copy every other value from `x1` into `y1` in reverse order...
10785
zcopy.main( 2, x1, -2, y1, 1 );
108-
109-
var z = y0.get( 2 );
110-
// returns <Complex128>
111-
112-
var re = real( z );
113-
// returns 7.0
114-
115-
var im = imag( z );
116-
// returns 8.0
86+
// y0 => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
11787
```
11888

11989
#### zcopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -122,22 +92,12 @@ Copies values from `x` into `y` using alternative indexing semantics.
12292

12393
```javascript
12494
var Complex128Array = require( '@stdlib/array/complex128' );
125-
var real = require( '@stdlib/complex/float64/real' );
126-
var imag = require( '@stdlib/complex/float64/imag' );
12795

12896
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
12997
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
13098

13199
zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
132-
133-
var v = y.get( 0 );
134-
// returns <Complex128>
135-
136-
var re = real( v );
137-
// returns 1.0
138-
139-
var im = imag( v );
140-
// returns 2.0
100+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
141101
```
142102

143103
The function has the following additional parameters:
@@ -149,22 +109,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
149109

150110
```javascript
151111
var Complex128Array = require( '@stdlib/array/complex128' );
152-
var real = require( '@stdlib/complex/float64/real' );
153-
var imag = require( '@stdlib/complex/float64/imag' );
154112

155113
var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
156114
var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
157115

158116
zcopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
159-
160-
var z = y.get( y.length-1 );
161-
// returns <Complex128>
162-
163-
var re = real( z );
164-
// returns 3.0
165-
166-
var im = imag( z );
167-
// returns 4.0
117+
// y => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
168118
```
169119

170120
* * *

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

+12-30
Original file line numberDiff line numberDiff line change
@@ -38,34 +38,24 @@
3838
// Standard usage:
3939
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
4040
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
41-
> {{alias}}.main( x.length, x, 1, y, 1 );
42-
> var z = y.get( 0 );
43-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
44-
1.0
45-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
46-
2.0
41+
> {{alias}}.main( x.length, x, 1, y, 1 )
42+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
4743

4844
// Advanced indexing:
4945
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
5046
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
51-
> {{alias}}.main( 2, x, -2, y, 1 );
52-
> z = y.get( 0 );
53-
> re = {{alias:@stdlib/complex/float64/real}}( z )
54-
5.0
55-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
56-
6.0
47+
> {{alias}}.main( 2, x, -2, y, 1 )
48+
<Complex128Array>[ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
5749

5850
// Using typed array views:
5951
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6052
> var y0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
6153
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
6254
> var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
63-
> {{alias}}.main( 2, x1, -1, y1, 1 );
64-
> z = y0.get( 2 );
65-
> re = {{alias:@stdlib/complex/float64/real}}( z )
66-
5.0
67-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
68-
6.0
55+
> {{alias}}.main( 2, x1, -1, y1, 1 )
56+
<Complex128Array>[ 5.0, 6.0 ]
57+
> y0
58+
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 5.0, 6.0 ]
6959

7060

7161
{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -110,22 +100,14 @@
110100
// Standard usage:
111101
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
112102
> var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] );
113-
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 );
114-
> var z = y.get( 0 );
115-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
116-
1.0
117-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
118-
2.0
103+
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 )
104+
<Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
119105

120106
// Advanced indexing:
121107
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
122108
> y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
123-
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1 );
124-
> z = y.get( y.length-1 );
125-
> re = {{alias:@stdlib/complex/float64/real}}( z )
126-
3.0
127-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
128-
4.0
109+
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1 )
110+
<Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ]
129111

130112

131113
{{alias}}.Module( memory )

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

+4-42
Original file line numberDiff line numberDiff line change
@@ -307,23 +307,13 @@ interface Routine extends ModuleWrapper {
307307
*
308308
* @example
309309
* var Complex128Array = require( '@stdlib/array/complex128' );
310-
* var real = require( '@stdlib/complex/float64/real' );
311-
* var imag = require( '@stdlib/complex/float64/imag' );
312310
*
313311
* var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
314312
* var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
315313
*
316314
* // Perform operation:
317315
* zcopy.main( x.length, x, 1, y, 1 );
318-
*
319-
* var v = y.get( 0 );
320-
* // returns <Complex64>
321-
*
322-
* var re = real( v );
323-
* // returns -1.0
324-
*
325-
* var im = imag( v );
326-
* // returns -2.0
316+
* // y => <Complex128Array>[ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ]
327317
*/
328318
main( N: number, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array;
329319

@@ -341,23 +331,13 @@ interface Routine extends ModuleWrapper {
341331
*
342332
* @example
343333
* var Complex128Array = require( '@stdlib/array/complex128' );
344-
* var real = require( '@stdlib/complex/float64/real' );
345-
* var imag = require( '@stdlib/complex/float64/imag' );
346334
*
347335
* var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
348336
* var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
349337
*
350338
* // Perform operation:
351339
* zcopy.ndarray( x.length, x, -1, 2, y, 1, 0 );
352-
*
353-
* var v = y.get( 0 );
354-
* // returns <Complex64>
355-
*
356-
* var re = real( v );
357-
* // returns -5.0
358-
*
359-
* var im = imag( v );
360-
* // returns -6.0
340+
* // y => <Complex128Array>[ -5.0, -6.0, -3.0, -4.0, -1.0, -2.0 ]
361341
*/
362342
ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128Array;
363343

@@ -437,23 +417,13 @@ interface Routine extends ModuleWrapper {
437417
*
438418
* @example
439419
* var Complex128Array = require( '@stdlib/array/complex128' );
440-
* var real = require( '@stdlib/complex/float64/real' );
441-
* var imag = require( '@stdlib/complex/float64/imag' );
442420
*
443421
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
444422
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
445423
*
446424
* // Perform operation:
447425
* zcopy.main( x.length, x, -1, y, 1 );
448-
*
449-
* var v = y.get( 0 );
450-
* // returns <Complex64>
451-
*
452-
* var re = real( v );
453-
* // returns 5.0
454-
*
455-
* var im = imag( v );
456-
* // returns 6.0
426+
* // y => <Complex128Array>[ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]
457427
*
458428
* @example
459429
* var Complex128Array = require( '@stdlib/array/complex128' );
@@ -465,15 +435,7 @@ interface Routine extends ModuleWrapper {
465435
*
466436
* // Perform operation:
467437
* zcopy.ndarray( x.length, x, 1, 0, y, -1, 2 );
468-
*
469-
* var v = y.get( 2 );
470-
* // returns <Complex64>
471-
*
472-
* var re = real( v );
473-
* // returns 1.0
474-
*
475-
* var im = imag( v );
476-
* // returns 2.0
438+
* // y => <Complex128Array>[ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]
477439
*/
478440
declare var zcopy: Routine;
479441

Diff for: ‎lib/node_modules/@stdlib/blas/base/wasm/zcopy/lib/index.js

+2-22
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
*
2626
* @example
2727
* var Complex128Array = require( '@stdlib/array/complex128' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var zcopy = require( '@stdlib/blas/base/wasm/zcopy' );
3129
*
3230
* // Define strided arrays...
@@ -35,21 +33,11 @@
3533
*
3634
* // Perform operation:
3735
* zcopy.main( x.length, x, 1, y, 1 );
38-
*
39-
* var v = y.get( 0 );
40-
* // returns <Complex128>
41-
*
42-
* var re = real( v );
43-
* // returns 1.0
44-
*
45-
* var im = imag( v );
46-
* // returns 2.0
36+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
4737
*
4838
* @example
4939
* var Complex128Array = require( '@stdlib/array/complex128' );
5040
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
51-
* var real = require( '@stdlib/complex/float64/real' );
52-
* var imag = require( '@stdlib/complex/float64/imag' );
5341
* var zcopy = require( '@stdlib/blas/base/wasm/zcopy' );
5442
*
5543
* // Define strided arrays...
@@ -58,15 +46,7 @@
5846
*
5947
* // Perform operation:
6048
* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
61-
*
62-
* var v = y.get( 0 );
63-
* // returns <Complex128>
64-
*
65-
* var re = real( v );
66-
* // returns 1.0
67-
*
68-
* var im = imag( v );
69-
* // returns 2.0
49+
// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
7050
*
7151
* @example
7252
* var Memory = require( '@stdlib/wasm/memory' );

Diff for: ‎lib/node_modules/@stdlib/blas/base/wasm/zcopy/lib/main.js

+2-22
Original file line numberDiff line numberDiff line change
@@ -33,45 +33,25 @@ var Routine = require( './routine.js' );
3333
*
3434
* @example
3535
* var Complex128Array = require( '@stdlib/array/complex128' );
36-
* var real = require( '@stdlib/complex/float64/real' );
37-
* var imag = require( '@stdlib/complex/float64/imag' );
3836
*
3937
* // Define strided arrays...
4038
* var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
4139
* var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
4240
*
4341
* // Perform operation:
4442
* zcopy.main( x.length, x, 1, y, 1 );
45-
*
46-
* var v = y.get( 0 );
47-
* // returns <Complex128>
48-
*
49-
* var re = real( v );
50-
* // returns -1.0
51-
*
52-
* var im = imag( v );
53-
* // returns -2.0
43+
// y => <Complex128Array>[ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ]
5444
*
5545
* @example
5646
* var Complex128Array = require( '@stdlib/array/complex128' );
57-
* var real = require( '@stdlib/complex/float64/real' );
58-
* var imag = require( '@stdlib/complex/float64/imag' );
5947
*
6048
* // Define a strided arrays...
6149
* var x = new Complex128Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
6250
* var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
6351
*
6452
* // Perform operation:
6553
* zcopy.ndarray( x.length, x, 1, 0, y, -1, 2 );
66-
*
67-
* var v = y.get( 0 );
68-
* // returns <Complex128>
69-
*
70-
* var re = real( v );
71-
* // returns -5.0
72-
*
73-
* var im = imag( v );
74-
* // returns -6.0
54+
// y => <Complex128Array>[ -5.0, -6.0, -3.0, -4.0, -1.0, -2.0 ]
7555
*/
7656
var zcopy = new Routine();
7757
zcopy.initializeSync(); // eslint-disable-line node/no-sync

0 commit comments

Comments
 (0)