Skip to content

Commit a70718c

Browse files
ShabiShett07ShabiShett07
authored
docs: update examples for blas/base/wasm/cswap
PR-URL: #6846 Ref: #4833 Reviewed-by: Athan Reines <[email protected]>
1 parent b59ce6f commit a70718c

File tree

4 files changed

+46
-263
lines changed

4 files changed

+46
-263
lines changed

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

Lines changed: 16 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -327,32 +327,14 @@ interface Routine extends ModuleWrapper {
327327
*
328328
* @example
329329
* var Complex64Array = require( '@stdlib/array/complex64' );
330-
* var realf = require( '@stdlib/complex/float32/real' );
331-
* var imagf = require( '@stdlib/complex/float32/imag' );
332330
*
333-
* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
334-
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
331+
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
332+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
335333
*
336334
* // Perform operation:
337335
* cswap.main( x.length, x, 1, y, 1 );
338-
*
339-
* var v = x.get( 0 );
340-
* // returns <Complex64>
341-
*
342-
* var re = realf( v );
343-
* // returns 1.0
344-
*
345-
* var im = imagf( v );
346-
* // returns 2.0
347-
*
348-
* var v = y.get( 0 );
349-
* // returns <Complex64>
350-
*
351-
* var re = realf( v );
352-
* // returns -1.0
353-
*
354-
* var im = imagf( v );
355-
* // returns -2.0
336+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
337+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
356338
*/
357339
main( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64Array;
358340

@@ -370,32 +352,14 @@ interface Routine extends ModuleWrapper {
370352
*
371353
* @example
372354
* var Complex64Array = require( '@stdlib/array/complex64' );
373-
* var realf = require( '@stdlib/complex/float32/real' );
374-
* var imagf = require( '@stdlib/complex/float32/imag' );
375355
*
376-
* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
377-
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
356+
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
357+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
378358
*
379359
* // Perform operation:
380-
* cswap.ndarray( x.length, x, -1, 2, y, 1, 0 );
381-
*
382-
* var v = x.get( 2 );
383-
* // returns <Complex64>
384-
*
385-
* var re = realf( v );
386-
* // returns 1.0
387-
*
388-
* var im = imagf( v );
389-
* // returns 2.0
390-
*
391-
* var v = y.get( 2 );
392-
* // returns <Complex64>
393-
*
394-
* var re = realf( v );
395-
* // returns -1.0
396-
*
397-
* var im = imagf( v );
398-
* // returns -2.0
360+
* cswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
361+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
362+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
399363
*/
400364
ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64Array;
401365

@@ -480,61 +444,25 @@ interface Routine extends ModuleWrapper {
480444
*
481445
* @example
482446
* var Complex64Array = require( '@stdlib/array/complex64' );
483-
* var realf = require( '@stdlib/complex/float32/real' );
484-
* var imagf = require( '@stdlib/complex/float32/imag' );
485447
*
486448
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
487-
* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
449+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
488450
*
489451
* // Perform operation:
490452
* cswap.main( x.length, x, -1, y, 1 );
491-
*
492-
* var v = x.get( 0 );
493-
* // returns <Complex64>
494-
*
495-
* var re = realf( v );
496-
* // returns 11.0
497-
*
498-
* var im = imagf( v );
499-
* // returns 12.0
500-
*
501-
* var v = y.get( 0 );
502-
* // returns <Complex64>
503-
*
504-
* var re = realf( v );
505-
* // returns 5.0
506-
*
507-
* var im = imagf( v );
508-
* // returns 6.0
453+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
454+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
509455
*
510456
* @example
511457
* var Complex64Array = require( '@stdlib/array/complex64' );
512-
* var realf = require( '@stdlib/complex/float32/real' );
513-
* var imagf = require( '@stdlib/complex/float32/imag' );
514458
*
515459
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
516-
* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
460+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
517461
*
518462
* // Perform operation:
519-
* cswap.ndarray( x.length, x, 1, 0, y, -1, 2 );
520-
*
521-
* var v = x.get( 2 );
522-
* // returns <Complex64>
523-
*
524-
* var re = realf( v );
525-
* // returns 7.0
526-
*
527-
* var im = imagf( v );
528-
* // returns 8.0
529-
*
530-
* var v = y.get( 2 );
531-
* // returns <Complex64>
532-
*
533-
* var re = realf( v );
534-
* // returns 1.0
535-
*
536-
* var im = imagf( v );
537-
* // returns 2.0
463+
* cswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
464+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
465+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
538466
*/
539467
declare var cswap: Routine;
540468

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

Lines changed: 4 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
*
2626
* @example
2727
* var Complex64Array = require( '@stdlib/array/complex64' );
28-
* var realf = require( '@stdlib/complex/float32/real' );
29-
* var imagf = require( '@stdlib/complex/float32/imag' );
3028
* var cswap = require( '@stdlib/blas/base/wasm/cswap' );
3129
*
3230
* // Define strided arrays...
@@ -35,30 +33,11 @@
3533
*
3634
* // Perform operation:
3735
* cswap.main( x.length, x, 1, y, 1 );
38-
*
39-
* var v = x.get( 0 );
40-
* // returns <Complex64>
41-
*
42-
* var re = realf( v );
43-
* // returns 0.0
44-
*
45-
* var im = imagf( v );
46-
* // returns 0.0
47-
*
48-
* var v = y.get( 0 );
49-
* // returns <Complex64>
50-
*
51-
* var re = realf( v );
52-
* // returns 1.0
53-
*
54-
* var im = imagf( v );
55-
* // returns 2.0
36+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
37+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
5638
*
5739
* @example
5840
* var Complex64Array = require( '@stdlib/array/complex64' );
59-
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
60-
* var realf = require( '@stdlib/complex/float32/real' );
61-
* var imagf = require( '@stdlib/complex/float32/imag' );
6241
* var cswap = require( '@stdlib/blas/base/wasm/cswap' );
6342
*
6443
* // Define strided arrays...
@@ -67,24 +46,8 @@
6746
*
6847
* // Perform operation:
6948
* cswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
70-
*
71-
* var v = x.get( 0 );
72-
* // returns <Complex64>
73-
*
74-
* var re = realf( v );
75-
* // returns 0.0
76-
*
77-
* var im = imagf( v );
78-
* // returns 0.0
79-
*
80-
* var v = y.get( 0 );
81-
* // returns <Complex64>
82-
*
83-
* var re = realf( v );
84-
* // returns 1.0
85-
*
86-
* var im = imagf( v );
87-
* // returns 2.0
49+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
50+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
8851
*
8952
* @example
9053
* var Memory = require( '@stdlib/wasm/memory' );

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

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -33,63 +33,27 @@ var Routine = require( './routine.js' );
3333
*
3434
* @example
3535
* var Complex64Array = require( '@stdlib/array/complex64' );
36-
* var realf = require( '@stdlib/complex/float32/real' );
37-
* var imagf = require( '@stdlib/complex/float32/imag' );
3836
*
3937
* // Define strided arrays...
40-
* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
41-
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
38+
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
39+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4240
*
4341
* // Perform operation:
4442
* cswap.main( x.length, x, 1, y, 1 );
45-
*
46-
* var v = x.get( 0 );
47-
* // returns <Complex64>
48-
*
49-
* var re = realf( v );
50-
* // returns 1.0
51-
*
52-
* var im = imagf( v );
53-
* // returns 2.0
54-
*
55-
* var v = y.get( 0 );
56-
* // returns <Complex64>
57-
*
58-
* var re = realf( v );
59-
* // returns -1.0
60-
*
61-
* var im = imagf( v );
62-
* // returns -2.0
43+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
44+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
6345
*
6446
* @example
6547
* var Complex64Array = require( '@stdlib/array/complex64' );
66-
* var realf = require( '@stdlib/complex/float32/real' );
67-
* var imagf = require( '@stdlib/complex/float32/imag' );
6848
*
6949
* // Define a strided arrays...
70-
* var x = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0 ] );
71-
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
50+
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
51+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
7252
*
7353
* // Perform operation:
74-
* cswap.ndarray( x.length, x, 1, 0, y, -1, 2 );
75-
*
76-
* var v = x.get( 0 );
77-
* // returns <Complex64>
78-
*
79-
* var re = realf( v );
80-
* // returns 5.0
81-
*
82-
* var im = imagf( v );
83-
* // returns 6.0
84-
*
85-
* var v = y.get( 0 );
86-
* // returns <Complex64>
87-
*
88-
* var re = realf( v );
89-
* // returns -5.0
90-
*
91-
* var im = imagf( v );
92-
* // returns -6.0
54+
* cswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
55+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
56+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
9357
*/
9458
var cswap = new Routine();
9559
cswap.initializeSync(); // eslint-disable-line node/no-sync

0 commit comments

Comments
 (0)