Skip to content

Commit ad0e0a1

Browse files
committed
chore: self review
--- 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: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: na - 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: passed - 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 c4707a5 commit ad0e0a1

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed

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

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,28 @@ limitations under the License.
2020

2121
# dasumpw
2222

23-
> Calculate the sum of absolute values (L1 norm) of double-precision floating-point strided array elements using pairwise summation.
23+
> Calculate the sum of absolute values ([_L1_ norm][l1norm]) of double-precision floating-point strided array elements using pairwise summation.
24+
25+
<section class="intro">
26+
27+
The [_L1_ norm][l1norm] is defined as
28+
29+
<!-- <equation class="equation" label="eq:l1norm" align="center" raw="\|\mathbf{x}\|_1 = \sum_{i=0}^{n-1} \vert x_i \vert" alt="L1 norm definition."> -->
30+
31+
```math
32+
\|\mathbf{x}\|_1 = \sum_{i=0}^{n-1} \vert x_i \vert
33+
```
34+
35+
<!-- <div class="equation" align="center" data-raw-text="\|\mathbf{x}\|_1 = \sum_{i=0}^{n-1} \vert x_i \vert" data-equation="eq:l1norm">
36+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@4fc193be4e7ddee6645fe1071f68a85d9a4c54f0/lib/node_modules/@stdlib/blas/ext/base/dasumpw/docs/img/equation_l1norm.svg" alt="L1 norm definition.">
37+
<br>
38+
</div> -->
39+
40+
<!-- </equation> -->
41+
42+
</section>
43+
44+
<!-- /.intro -->
2445

2546
<section class="usage">
2647

@@ -32,7 +53,7 @@ var dasumpw = require( '@stdlib/blas/ext/base/wasm/dasumpw' );
3253

3354
#### dasumpw.main( N, x, strideX )
3455

35-
Computes the sum of absolute values (L1 norm) of double-precision floating-point strided array elements using pairwise summation.
56+
Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision floating-point strided array elements using pairwise summation.
3657

3758
```javascript
3859
var Float64Array = require( '@stdlib/array/float64' );
@@ -76,7 +97,7 @@ var sum = dasumpw.main( 4, x1, 2 );
7697

7798
#### dasumpw.ndarray( N, x, strideX, offsetX )
7899

79-
Computes the sum of absolute values (L1 norm) of double-precision floating-point strided array elements using pairwise summation and alternative indexing semantics..
100+
Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.
80101

81102
```javascript
82103
var Float64Array = require( '@stdlib/array/float64' );
@@ -131,7 +152,7 @@ mod.initializeSync();
131152

132153
#### dasumpw.Module.prototype.main( N, xp, sx )
133154

134-
Adds a scalar constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
155+
Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision floating-point strided array elements using pairwise summation.
135156

136157
<!-- eslint-disable node/no-sync -->
137158

@@ -178,7 +199,7 @@ The function has the following parameters:
178199

179200
#### dasumpw.Module.prototype.ndarray( N, xp, sx, ox )
180201

181-
Adds a scalar constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics.
202+
Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.
182203

183204
<!-- eslint-disable node/no-sync -->
184205

@@ -286,6 +307,8 @@ console.log( sum );
286307

287308
[@stdlib/blas/ext/base/dasumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dasumpw
288309

310+
[l1norm]: https://en.wikipedia.org/wiki/Norm_%28mathematics%29
311+
289312
</section>
290313

291314
<!-- /.links -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"benchmark": "./benchmark",
2222
"doc": "./docs",
2323
"example": "./examples",
24-
"include": "./include",
2524
"lib": "./lib",
25+
"scripts": "./scripts",
2626
"src": "./src",
2727
"test": "./test"
2828
},

0 commit comments

Comments
 (0)