Skip to content

Commit 420e21c

Browse files
committed
docs: fix examples and notes
1 parent fe8255a commit 420e21c

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

lib/node_modules/@stdlib/blas/base/drot-wasm/docs/repl.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
Number of indexed elements.
8484

8585
x: Float64Array
86-
Input array.
86+
First input array.
8787

8888
strideX: integer
8989
Index increment for `x`.
@@ -300,9 +300,9 @@
300300
Reallocates the underlying WebAssembly memory instance to a specified number
301301
of bytes.
302302

303-
WebAssembly memory can only **grow**, not shrink. Hence, if provided a
304-
number of bytes which is less than or equal to the size of the current
305-
memory, the function does nothing.
303+
WebAssembly memory can only *grow*, not shrink. Hence, if provided a number
304+
of bytes which is less than or equal to the size of the current memory, the
305+
function does nothing.
306306

307307
When non-shared memory is resized, the underlying the `ArrayBuffer` is
308308
detached, consequently invalidating any associated typed array views. Before

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,9 @@ interface ModuleConstructor {
7777
* var viewX = zeros( N, dtype );
7878
* var viewY = zeros( N, dtype );
7979
* mod.read( xptr, viewX );
80-
* mod.read( yptr, viewY );
8180
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
81+
*
82+
* mod.read( yptr, viewY );
8283
* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
8384
*/
8485
new( mem: Memory ): Module; // newable
@@ -134,8 +135,9 @@ interface ModuleConstructor {
134135
* var viewX = zeros( N, dtype );
135136
* var viewY = zeros( N, dtype );
136137
* mod.read( xptr, viewX );
137-
* mod.read( yptr, viewY );
138138
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
139+
*
140+
* mod.read( yptr, viewY );
139141
* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
140142
*/
141143
( mem: Memory ): Module; // callable
@@ -202,8 +204,9 @@ interface Module extends ModuleWrapper {
202204
* var viewX = zeros( N, dtype );
203205
* var viewY = zeros( N, dtype );
204206
* mod.read( xptr, viewX );
205-
* mod.read( yptr, viewY );
206207
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
208+
*
209+
* mod.read( yptr, viewY );
207210
* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
208211
*/
209212
main( N: number, xptr: number, strideX: number, yptr: number, strideY: number, c: number, s: number ): number;
@@ -267,8 +270,9 @@ interface Module extends ModuleWrapper {
267270
* var viewX = zeros( N, dtype );
268271
* var viewY = zeros( N, dtype );
269272
* mod.read( xptr, viewX );
270-
* mod.read( yptr, viewY );
271273
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
274+
*
275+
* mod.read( yptr, viewY );
272276
* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
273277
*/
274278
ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number, c: number, s: number ): number;
@@ -379,8 +383,9 @@ interface Routine extends ModuleWrapper {
379383
* var viewX = zeros( N, dtype );
380384
* var viewY = zeros( N, dtype );
381385
* mod.read( xptr, viewX );
382-
* mod.read( yptr, viewY );
383386
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
387+
*
388+
* mod.read( yptr, viewY );
384389
* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
385390
*/
386391
Module: ModuleConstructor;

lib/node_modules/@stdlib/blas/base/drot-wasm/lib/routine.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ setReadOnly( Routine.prototype, 'ndarray', function drot( N, x, strideX, offsetX
180180
// Perform computation by calling the corresponding parent method:
181181
Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset, c, s ); // eslint-disable-line max-len
182182

183-
// If the output arrays data had to be copied to module memory, copy the results to the provided output arrays...
183+
// If output array data had to be copied to module memory, copy the results to the provided output arrays...
184184
if ( p0.copy ) {
185185
readDataView( N, this.view, p0.stride*p0.BYTES_PER_ELEMENT, p0.ptr, x, strideX, offsetX, true ); // eslint-disable-line max-len
186186
}

0 commit comments

Comments
 (0)