@@ -34,6 +34,7 @@ interface ModuleConstructor {
3434 *
3535 * @example
3636 * var Memory = require( '@stdlib/wasm/memory' );
37+ * var zeros = require( '@stdlib/array/zeros' );
3738 * var oneTo = require( '@stdlib/array/one-to' );
3839 *
3940 * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
@@ -62,8 +63,16 @@ interface ModuleConstructor {
6263 * mod.write( xptr, oneTo( N, dtype ) );
6364 *
6465 * // Perform computation:
65- * mod.main( N, 5.0, xptr, 1 );
66- * // xptr => <Float64Array>[ 6.0, 7.0, 8.0 ]
66+ * var ptr = mod.main( N, 5.0, xptr, 1 );
67+ * // returns <number>
68+ *
69+ * var bool = ( ptr === xptr );
70+ * // returns true
71+ *
72+ * // Read out the results:
73+ * var view = zeros( N, dtype );
74+ * mod.read( xptr, view );
75+ * // view => <Float64Array>[ 6.0, 7.0, 8.0 ]
6776 */
6877 new ( mem : Memory ) : Module ; // newable
6978
@@ -76,6 +85,7 @@ interface ModuleConstructor {
7685 * @example
7786 * var Memory = require( '@stdlib/wasm/memory' );
7887 * var oneTo = require( '@stdlib/array/one-to' );
88+ * var zeros = require( '@stdlib/array/zeros' );
7989 *
8090 * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
8191 * var mem = new Memory({
@@ -103,8 +113,16 @@ interface ModuleConstructor {
103113 * mod.write( xptr, oneTo( N, dtype ) );
104114 *
105115 * // Perform computation:
106- * mod.main( N, 5.0, xptr, 1 );
107- * // xptr => <Float64Array>[ 6.0, 7.0, 8.0 ]
116+ * var ptr = mod.main( N, 5.0, xptr, 1 );
117+ * // returns <number>
118+ *
119+ * var bool = ( ptr === xptr );
120+ * // returns true
121+ *
122+ * // Read out the results:
123+ * var view = zeros( N, dtype );
124+ * mod.read( xptr, view );
125+ * // view => <Float64Array>[ 6.0, 7.0, 8.0 ]
108126 */
109127 ( mem : Memory ) : Module ; // callable
110128}
@@ -125,6 +143,7 @@ interface Module extends ModuleWrapper {
125143 * @example
126144 * var Memory = require( '@stdlib/wasm/memory' );
127145 * var oneTo = require( '@stdlib/array/one-to' );
146+ * var zeros = require( '@stdlib/array/zeros' );
128147 *
129148 * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
130149 * var mem = new Memory({
@@ -152,8 +171,16 @@ interface Module extends ModuleWrapper {
152171 * mod.write( xptr, oneTo( N, dtype ) );
153172 *
154173 * // Perform computation:
155- * mod.main( N, 5.0, xptr, 1 );
156- * // xptr => <Float64Array>[ 6.0, 7.0, 8.0 ]
174+ * var ptr = mod.main( N, 5.0, xptr, 1 );
175+ * // returns <number>
176+ *
177+ * var bool = ( ptr === xptr );
178+ * // returns true
179+ *
180+ * // Read out the results:
181+ * var view = zeros( N, dtype );
182+ * mod.read( xptr, view );
183+ * // view => <Float64Array>[ 6.0, 7.0, 8.0 ]
157184 */
158185 main ( N : number , alpha : number , xptr : number , strideX : number ) : number ;
159186
@@ -170,6 +197,7 @@ interface Module extends ModuleWrapper {
170197 * @example
171198 * var Memory = require( '@stdlib/wasm/memory' );
172199 * var oneTo = require( '@stdlib/array/one-to' );
200+ * var zeros = require( '@stdlib/array/zeros' );
173201 *
174202 * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
175203 * var mem = new Memory({
@@ -197,8 +225,16 @@ interface Module extends ModuleWrapper {
197225 * mod.write( xptr, oneTo( N, dtype ) );
198226 *
199227 * // Perform computation:
200- * mod.ndarray( N, 5.0, xptr, 1, 0 );
201- * // xptr => <Float64Array>[ 6.0, 7.0, 8.0 ]
228+ * var ptr = mod.ndarray( N, 5.0, xptr, 1, 0 );
229+ * // returns <number>
230+ *
231+ * var bool = ( ptr === xptr );
232+ * // returns true
233+ *
234+ * // Read out the results:
235+ * var view = zeros( N, dtype );
236+ * mod.read( xptr, view );
237+ * // view => <Float64Array>[ 6.0, 7.0, 8.0 ]
202238 */
203239 ndarray ( N : number , alpha : number , xptr : number , strideX : number , offsetX : number ) : number ;
204240}
@@ -222,7 +258,7 @@ interface Routine extends ModuleWrapper {
222258 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
223259 *
224260 * var out = dapx.main( 3, 5.0, x, 1 );
225- * // out => Float64Array[ 6.0, 3.0, 7.0 ]
261+ * // out => < Float64Array> [ 6.0, 3.0, 7.0 ]
226262 */
227263 main ( N : number , alpha : number , x : Float64Array , strideX : number ) : number ;
228264
@@ -242,7 +278,7 @@ interface Routine extends ModuleWrapper {
242278 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
243279 *
244280 * dapx.ndarray( 4, 5.0, x, 2, 1 );
245- * // x => Float64Array[ 7 .0, 6.0, 7 .0, 3.0, 3 .0, 7.0, 8 .0, 9.0 ]
281+ * // x => < Float64Array>[ 2 .0, 6.0, 2 .0, 3.0, -2 .0, 7.0, 3 .0, 9.0 ]
246282 */
247283 ndarray ( N : number , alpha : number , x : Float64Array , strideX : number , offsetX : number ) : number ;
248284
@@ -255,6 +291,7 @@ interface Routine extends ModuleWrapper {
255291 * @example
256292 * var Memory = require( '@stdlib/wasm/memory' );
257293 * var oneTo = require( '@stdlib/array/one-to' );
294+ * var zeros = require( '@stdlib/array/zeros' );
258295 *
259296 * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
260297 * var mem = new Memory({
@@ -282,8 +319,16 @@ interface Routine extends ModuleWrapper {
282319 * mod.write( xptr, oneTo( N, dtype ) );
283320 *
284321 * // Perform computation:
285- * mod.main( N, 5.0, xptr, 1 );
286- * // xptr => <Float64Array>[ 6.0, 7.0, 8.0 ]
322+ * var ptr = mod.main( N, 5.0, xptr, 1 );
323+ * // returns <number>
324+ *
325+ * var bool = ( ptr === xptr );
326+ * // returns true
327+ *
328+ * // Read out the results:
329+ * var view = zeros( N, dtype );
330+ * mod.read( xptr, view );
331+ * // view => <Float64Array>[ 6.0, 7.0, 8.0 ]
287332 */
288333 Module : ModuleConstructor ;
289334}
@@ -303,15 +348,15 @@ interface Routine extends ModuleWrapper {
303348* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
304349*
305350* dapx.main( 3, 5.0, x, 1 );
306- * // x => Float64Array[ 6.0, 3.0, 7.0 ]
351+ * // x => < Float64Array> [ 6.0, 3.0, 7.0 ]
307352*
308353* @example
309354* var Float64Array = require( '@stdlib/array/float64' );
310355*
311356* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
312357*
313358* dapx.ndarray( 4, 5.0, x, 2, 1 );
314- * // x => Float64Array[ 7 .0, 6.0, 7 .0, 3.0, 3 .0, 7.0, 8 .0, 9.0 ]
359+ * // x => < Float64Array>[ 2 .0, 6.0, 2 .0, 3.0, -2 .0, 7.0, 3 .0, 9.0 ]
315360*/
316361declare var dapx : Routine ;
317362
0 commit comments