Skip to content

Commit 911f593

Browse files
ShabiShett07ShabiShett07
committed
docs: update files
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 53a9e7b commit 911f593

File tree

4 files changed

+12
-126
lines changed

4 files changed

+12
-126
lines changed

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

Lines changed: 4 additions & 40 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+
* // cx => <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

@@ -364,15 +354,7 @@ interface Routine extends ModuleWrapper {
364354
*
365355
* // Perform operation:
366356
* 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
357+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
376358
*/
377359
ndarray( N: number, alpha: Complex64, x: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
378360

@@ -454,8 +436,6 @@ interface Routine extends ModuleWrapper {
454436
* @example
455437
* var Complex64Array = require( '@stdlib/array/complex64' );
456438
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
457-
* var realf = require( '@stdlib/complex/float32/real' );
458-
* var imagf = require( '@stdlib/complex/float32/imag' );
459439
*
460440
* // Define a strided array:
461441
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -465,15 +445,7 @@ interface Routine extends ModuleWrapper {
465445
*
466446
* // Perform operation:
467447
* 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
448+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
477449
*
478450
* @example
479451
* var Complex64Array = require( '@stdlib/array/complex64' );
@@ -489,15 +461,7 @@ interface Routine extends ModuleWrapper {
489461
*
490462
* // Perform operation:
491463
* 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
464+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
501465
*/
502466
declare var cscal: Routine;
503467

‎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+
* // cx => <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+
* // cx => <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 & 20 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,15 +43,7 @@ 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' );
@@ -69,15 +59,7 @@ var Routine = require( './routine.js' );
6959
*
7060
* // Perform operation:
7161
* 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
62+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
8163
*/
8264
var cscal = new Routine();
8365
cscal.initializeSync(); // eslint-disable-line node/no-sync

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

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,6 @@ var Module = require( './module.js' );
4545
* @example
4646
* var Complex64Array = require( '@stdlib/array/complex64' );
4747
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
48-
* var realf = require( '@stdlib/complex/float32/real' );
49-
* var imagf = require( '@stdlib/complex/float32/imag' );
5048
*
5149
* // Create a new routine:
5250
* var cscal = new Routine();
@@ -62,21 +60,11 @@ var Module = require( './module.js' );
6260
*
6361
* // Perform operation:
6462
* cscal.main( x.length, z, x, 1 );
65-
*
66-
* var v = x.get( 0 );
67-
* // returns <Complex64>
68-
*
69-
* var re = realf( v );
70-
* // returns -2.0
71-
*
72-
* var im = imagf( v );
73-
* // returns 6.0
63+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
7464
*
7565
* @example
7666
* var Complex64Array = require( '@stdlib/array/complex64' );
7767
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
78-
* var realf = require( '@stdlib/complex/float32/real' );
79-
* var imagf = require( '@stdlib/complex/float32/imag' );
8068
*
8169
* // Create a new routine:
8270
* var cscal = new Routine();
@@ -92,15 +80,7 @@ var Module = require( './module.js' );
9280
*
9381
* // Perform operation:
9482
* cscal.ndarray( x.length, z, x, 1, 0 );
95-
*
96-
* var v = x.get( 0 );
97-
* // returns <Complex64>
98-
*
99-
* var re = realf( v );
100-
* // returns -2.0
101-
*
102-
* var im = imagf( v );
103-
* // returns 6.0
83+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
10484
*/
10585
function Routine() {
10686
if ( !( this instanceof Routine ) ) {
@@ -131,8 +111,6 @@ inherits( Routine, Module );
131111
* @example
132112
* var Complex64Array = require( '@stdlib/array/complex64' );
133113
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
134-
* var realf = require( '@stdlib/complex/float32/real' );
135-
* var imagf = require( '@stdlib/complex/float32/imag' );
136114
*
137115
* // Create a new routine:
138116
* var cscal = new Routine();
@@ -148,15 +126,7 @@ inherits( Routine, Module );
148126
*
149127
* // Perform operation:
150128
* cscal.main( x.length, z, x, 1 );
151-
*
152-
* var v = x.get( 0 );
153-
* // returns <Complex64>
154-
*
155-
* var re = realf( v );
156-
* // returns -2.0
157-
*
158-
* var im = imagf( v );
159-
* // returns 6.0
129+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
160130
*/
161131
setReadOnly( Routine.prototype, 'main', function cscal( N, alpha, x, strideX ) {
162132
return this.ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) );
@@ -179,8 +149,6 @@ setReadOnly( Routine.prototype, 'main', function cscal( N, alpha, x, strideX ) {
179149
* @example
180150
* var Complex64Array = require( '@stdlib/array/complex64' );
181151
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
182-
* var realf = require( '@stdlib/complex/float32/real' );
183-
* var imagf = require( '@stdlib/complex/float32/imag' );
184152
*
185153
* // Create a new routine:
186154
* var cscal = new Routine();
@@ -196,15 +164,7 @@ setReadOnly( Routine.prototype, 'main', function cscal( N, alpha, x, strideX ) {
196164
*
197165
* // Perform operation:
198166
* cscal.ndarray( x.length, z, x, 1, 0 );
199-
*
200-
* var v = x.get( 0 );
201-
* // returns <Complex64>
202-
*
203-
* var re = realf( v );
204-
* // returns -2.0
205-
*
206-
* var im = imagf( v );
207-
* // returns 6.0
167+
* // x => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
208168
*/
209169
setReadOnly( Routine.prototype, 'ndarray', function cscal( N, alpha, x, strideX, offsetX ) {
210170
var ptrs;

0 commit comments

Comments
 (0)