Skip to content

Commit ef474af

Browse files
committed
docs: fix overwriting of variables
1 parent 929a224 commit ef474af

File tree

1 file changed

+30
-30
lines changed
  • lib/node_modules/@stdlib/blas/base/daxpy-wasm/docs/types

1 file changed

+30
-30
lines changed

lib/node_modules/@stdlib/blas/base/daxpy-wasm/docs/types/index.d.ts

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ interface ModuleConstructor {
4646
* });
4747
*
4848
* // Create a BLAS routine:
49-
* var daxpy = new daxpy.Module( mem );
49+
* var mod = new daxpy.Module( mem );
5050
* // returns <Module>
5151
*
5252
* // Initialize the routine:
53-
* daxpy.initializeSync();
53+
* mod.initializeSync();
5454
*
5555
* // Define a vector data type:
5656
* var dtype = 'float64';
@@ -63,19 +63,19 @@ interface ModuleConstructor {
6363
* var yptr = N * bytesPerElement( dtype );
6464
*
6565
* // Write vector values to module memory:
66-
* daxpy.write( xptr, oneTo( N, dtype ) );
67-
* daxpy.write( yptr, ones( N, dtype ) );
66+
* mod.write( xptr, oneTo( N, dtype ) );
67+
* mod.write( yptr, ones( N, dtype ) );
6868
*
6969
* // Perform computation:
70-
* var ptr = daxpy.main( N, 5.0, xptr, 1, yptr, 1 );
70+
* var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 );
7171
* // returns <number>
7272
*
7373
* var bool = ( ptr === yptr );
7474
* // returns true
7575
*
7676
* // Read out the results:
7777
* var view = zeros( N, dtype );
78-
* daxpy.read( yptr, view );
78+
* mod.read( yptr, view );
7979
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
8080
*/
8181
new( mem: Memory ): Module; // newable
@@ -100,11 +100,11 @@ interface ModuleConstructor {
100100
* });
101101
*
102102
* // Create a BLAS routine:
103-
* var daxpy = daxpy.Module( mem );
103+
* var mod = daxpy.Module( mem );
104104
* // returns <Module>
105105
*
106106
* // Initialize the routine:
107-
* daxpy.initializeSync();
107+
* mod.initializeSync();
108108
*
109109
* // Define a vector data type:
110110
* var dtype = 'float64';
@@ -117,19 +117,19 @@ interface ModuleConstructor {
117117
* var yptr = N * bytesPerElement( dtype );
118118
*
119119
* // Write vector values to module memory:
120-
* daxpy.write( xptr, oneTo( N, dtype ) );
121-
* daxpy.write( yptr, ones( N, dtype ) );
120+
* mod.write( xptr, oneTo( N, dtype ) );
121+
* mod.write( yptr, ones( N, dtype ) );
122122
*
123123
* // Perform computation:
124-
* var ptr = daxpy.main( N, 5.0, xptr, 1, yptr, 1 );
124+
* var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 );
125125
* // returns <number>
126126
*
127127
* var bool = ( ptr === yptr );
128128
* // returns true
129129
*
130130
* // Read out the results:
131131
* var view = zeros( N, dtype );
132-
* daxpy.read( yptr, view );
132+
* mod.read( yptr, view );
133133
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
134134
*/
135135
( mem: Memory ): Module; // callable
@@ -164,11 +164,11 @@ interface Module extends ModuleWrapper {
164164
* });
165165
*
166166
* // Create a BLAS routine:
167-
* var daxpy = new Module( mem );
167+
* var mod = new daxpy.Module( mem );
168168
* // returns <Module>
169169
*
170170
* // Initialize the routine:
171-
* daxpy.initializeSync();
171+
* mod.initializeSync();
172172
*
173173
* // Define a vector data type:
174174
* var dtype = 'float64';
@@ -181,19 +181,19 @@ interface Module extends ModuleWrapper {
181181
* var yptr = N * bytesPerElement( dtype );
182182
*
183183
* // Write vector values to module memory:
184-
* daxpy.write( xptr, oneTo( N, dtype ) );
185-
* daxpy.write( yptr, ones( N, dtype ) );
184+
* mod.write( xptr, oneTo( N, dtype ) );
185+
* mod.write( yptr, ones( N, dtype ) );
186186
*
187187
* // Perform computation:
188-
* var ptr = daxpy.main( N, 5.0, xptr, 1, yptr, 1 );
188+
* var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 );
189189
* // returns <number>
190190
*
191191
* var bool = ( ptr === yptr );
192192
* // returns true
193193
*
194194
* // Read out the results:
195195
* var view = zeros( N, dtype );
196-
* daxpy.read( yptr, view );
196+
* mod.read( yptr, view );
197197
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
198198
*/
199199
main( N: number, alpha: number, xptr: number, strideX: number, yptr: number, strideY: number ): number;
@@ -225,11 +225,11 @@ interface Module extends ModuleWrapper {
225225
* });
226226
*
227227
* // Create a BLAS routine:
228-
* var daxpy = new Module( mem );
228+
* var mod = new daxpy.Module( mem );
229229
* // returns <Module>
230230
*
231231
* // Initialize the routine:
232-
* daxpy.initializeSync();
232+
* mod.initializeSync();
233233
*
234234
* // Define a vector data type:
235235
* var dtype = 'float64';
@@ -242,19 +242,19 @@ interface Module extends ModuleWrapper {
242242
* var yptr = N * bytesPerElement( dtype );
243243
*
244244
* // Write vector values to module memory:
245-
* daxpy.write( xptr, oneTo( N, dtype ) );
246-
* daxpy.write( yptr, ones( N, dtype ) );
245+
* mod.write( xptr, oneTo( N, dtype ) );
246+
* mod.write( yptr, ones( N, dtype ) );
247247
*
248248
* // Perform computation:
249-
* var ptr = daxpy.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 );
249+
* var ptr = mod.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 );
250250
* // returns <number>
251251
*
252252
* var bool = ( ptr === yptr );
253253
* // returns true
254254
*
255255
* // Read out the results:
256256
* var view = zeros( N, dtype );
257-
* daxpy.read( yptr, view );
257+
* mod.read( yptr, view );
258258
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
259259
*/
260260
ndarray( N: number, alpha: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number;
@@ -330,11 +330,11 @@ interface Routine extends ModuleWrapper {
330330
* });
331331
*
332332
* // Create a BLAS routine:
333-
* var daxpy = new daxpy.Module( mem );
333+
* var mod = new daxpy.Module( mem );
334334
* // returns <Module>
335335
*
336336
* // Initialize the routine:
337-
* daxpy.initializeSync();
337+
* mod.initializeSync();
338338
*
339339
* // Define a vector data type:
340340
* var dtype = 'float64';
@@ -347,19 +347,19 @@ interface Routine extends ModuleWrapper {
347347
* var yptr = N * bytesPerElement( dtype );
348348
*
349349
* // Write vector values to module memory:
350-
* daxpy.write( xptr, oneTo( N, dtype ) );
351-
* daxpy.write( yptr, ones( N, dtype ) );
350+
* mod.write( xptr, oneTo( N, dtype ) );
351+
* mod.write( yptr, ones( N, dtype ) );
352352
*
353353
* // Perform computation:
354-
* var ptr = daxpy.main( N, 5.0, xptr, 1, yptr, 1 );
354+
* var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 );
355355
* // returns <number>
356356
*
357357
* var bool = ( ptr === yptr );
358358
* // returns true
359359
*
360360
* // Read out the results:
361361
* var view = zeros( N, dtype );
362-
* daxpy.read( yptr, view );
362+
* mod.read( yptr, view );
363363
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
364364
*/
365365
Module: ModuleConstructor;

0 commit comments

Comments
 (0)