Skip to content

Commit c7511f6

Browse files
chore: changes as per code review
--- 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: failed ---
1 parent b88b642 commit c7511f6

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

lib/node_modules/@stdlib/blas/ext/base/wasm/dnansum/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ The function has the following additional parameters:
232232
## Notes
233233

234234
- If `N <= 0`, both `main` and `ndarray` methods return `0.0`.
235-
- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dnansum` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/blas/base/dnansum`][@stdlib/blas/ext/base/dnansum]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/blas/base/dnansum`][@stdlib/blas/ext/base/dnansum]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other.
235+
- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dnansum` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/blas/ext/base/dnansum`][@stdlib/blas/ext/base/dnansum]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/blas/ext/base/dnansum`][@stdlib/blas/ext/base/dnansum]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other.
236236

237237
</section>
238238

lib/node_modules/@stdlib/blas/ext/base/wasm/dnansum/docs/types/index.d.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ interface ModuleConstructor {
4343
* });
4444
*
4545
* // Create a BLAS routine:
46-
* var mod = new dapxsumkbn.Module( mem );
46+
* var mod = new dnansum.Module( mem );
4747
* // returns <Module>
4848
*
4949
* // Initialize the routine:
@@ -84,7 +84,7 @@ interface ModuleConstructor {
8484
* });
8585
*
8686
* // Create a BLAS routine:
87-
* var mod = dapxsumkbn.Module( mem );
87+
* var mod = dnansum.Module( mem );
8888
* // returns <Module>
8989
*
9090
* // Initialize the routine:
@@ -110,7 +110,7 @@ interface ModuleConstructor {
110110
}
111111

112112
/**
113-
* Interface describing a `dapxsumkbn` WebAssembly module.
113+
* Interface describing a `dnansum` WebAssembly module.
114114
*/
115115
interface Module extends ModuleWrapper {
116116
/**
@@ -132,7 +132,7 @@ interface Module extends ModuleWrapper {
132132
* });
133133
*
134134
* // Create a BLAS routine:
135-
* var mod = new dapxsumkbn.Module( mem );
135+
* var mod = new dnansum.Module( mem );
136136
* // returns <Module>
137137
*
138138
* // Initialize the routine:
@@ -176,7 +176,7 @@ interface Module extends ModuleWrapper {
176176
* });
177177
*
178178
* // Create a BLAS routine:
179-
* var mod = new dapxsumkbn.Module( mem );
179+
* var mod = new dnansum.Module( mem );
180180
* // returns <Module>
181181
*
182182
* // Initialize the routine:
@@ -202,7 +202,7 @@ interface Module extends ModuleWrapper {
202202
}
203203

204204
/**
205-
* Interface describing `dapxsumkbn`.
205+
* Interface describing `dnansum`.
206206
*/
207207
interface Routine extends ModuleWrapper {
208208
/**
@@ -218,7 +218,7 @@ interface Routine extends ModuleWrapper {
218218
*
219219
* var x = new Float64Array( [ 1.0, -2.0, NaN 2.0 ] );
220220
*
221-
* var out = dapxsumkbn.main( 4, x, 1 );
221+
* var out = dnansum.main( 4, x, 1 );
222222
* // returns 1.0
223223
*/
224224
main( N: number, x: Float64Array, strideX: number ): number;
@@ -237,7 +237,7 @@ interface Routine extends ModuleWrapper {
237237
*
238238
* var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
239239
*
240-
* var out = dapxsumkbn.ndarray( 4, x, 2, 1 );
240+
* var out = dnansum.ndarray( 4, x, 2, 1 );
241241
* // returns 5.0
242242
*/
243243
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;
@@ -259,7 +259,7 @@ interface Routine extends ModuleWrapper {
259259
* });
260260
*
261261
* // Create a BLAS routine:
262-
* var mod = new dapxsumkbn.Module( mem );
262+
* var mod = new dnansum.Module( mem );
263263
* // returns <Module>
264264
*
265265
* // Initialize the routine:
@@ -297,20 +297,20 @@ interface Routine extends ModuleWrapper {
297297
*
298298
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
299299
*
300-
* var out = dapxsumkbn.main( 4, x, 1 );
300+
* var out = dnansum.main( 4, x, 1 );
301301
* // returns 1.0
302302
*
303303
* @example
304304
* var Float64Array = require( '@stdlib/array/float64' );
305305
*
306306
* var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
307307
*
308-
* var out = dapxsumkbn.ndarray( 4, x, 2, 1 );
308+
* var out = dnansum.ndarray( 4, x, 2, 1 );
309309
* // returns 25.0
310310
*/
311-
declare var dapxsumkbn: Routine;
311+
declare var dnansum: Routine;
312312

313313

314314
// EXPORTS //
315315

316-
export = dapxsumkbn;
316+
export = dnansum;

lib/node_modules/@stdlib/blas/ext/base/wasm/dnansum/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/blas/base/ext/wasm/dnansum",
2+
"name": "@stdlib/blas/ext/base/wasm/dnansum",
33
"version": "0.0.0",
44
"description": "Calculate the sum of double-precision floating-point strided array elements, ignoring NaN values",
55
"license": "Apache-2.0",

0 commit comments

Comments
 (0)