Skip to content

Commit 0d2bde9

Browse files
committed
docs: add missing references and notes
--- 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: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 347914d commit 0d2bde9

File tree

9 files changed

+74
-1
lines changed

9 files changed

+74
-1
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/dmeankbn/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ console.log( v );
110110

111111
<!-- /.examples -->
112112

113+
* * *
114+
115+
<section class="references">
116+
117+
## References
118+
119+
- Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106][@neumaier:1974a].
120+
121+
</section>
122+
123+
<!-- /.references -->
124+
113125
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
114126

115127
<section class="related">
@@ -124,6 +136,8 @@ console.log( v );
124136

125137
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
126138

139+
[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
140+
127141
</section>
128142

129143
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/dmeankbn2/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ console.log( v );
110110

111111
<!-- /.examples -->
112112

113+
* * *
114+
115+
<section class="references">
116+
117+
## References
118+
119+
- Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x][@klein:2005a].
120+
121+
</section>
122+
123+
<!-- /.references -->
124+
113125
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
114126

115127
<section class="related">
@@ -124,6 +136,8 @@ console.log( v );
124136

125137
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
126138

139+
[@klein:2005a]: https://doi.org/10.1007/s00607-005-0139-x
140+
127141
</section>
128142

129143
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/dnanmeanpw/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ The function has the following parameters:
7979
## Notes
8080

8181
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
82+
- In general, pairwise summation is more numerically stable than ordinary recursive summation (i.e., "simple" summation), with slightly worse performance. While not the most numerically stable summation technique (e.g., compensated summation techniques such as the Kahan–Babuška-Neumaier algorithm are generally more numerically stable), pairwise summation strikes a reasonable balance between numerical stability and performance. If either numerical stability or performance is more desirable for your use case, consider alternative summation techniques.
8283

8384
</section>
8485

lib/node_modules/@stdlib/stats/base/ndarray/meankbn/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,18 @@ console.log( v );
109109

110110
<!-- /.examples -->
111111

112+
* * *
113+
114+
<section class="references">
115+
116+
## References
117+
118+
- Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106][@neumaier:1974a].
119+
120+
</section>
121+
122+
<!-- /.references -->
123+
112124
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
113125

114126
<section class="related">
@@ -123,6 +135,8 @@ console.log( v );
123135

124136
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
125137

138+
[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
139+
126140
</section>
127141

128142
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/meankbn2/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,18 @@ console.log( v );
109109

110110
<!-- /.examples -->
111111

112+
* * *
113+
114+
<section class="references">
115+
116+
## References
117+
118+
- Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x][@klein:2005a].
119+
120+
</section>
121+
122+
<!-- /.references -->
123+
112124
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
113125

114126
<section class="related">
@@ -123,6 +135,8 @@ console.log( v );
123135

124136
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
125137

138+
[@klein:2005a]: https://doi.org/10.1007/s00607-005-0139-x
139+
126140
</section>
127141

128142
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/meanpw/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ console.log( v );
110110

111111
<!-- /.examples -->
112112

113+
* * *
114+
115+
<section class="references">
116+
117+
## References
118+
119+
- Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050][@higham:1993a].
120+
121+
</section>
122+
123+
<!-- /.references -->
124+
113125
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
114126

115127
<section class="related">
@@ -124,6 +136,8 @@ console.log( v );
124136

125137
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
126138

139+
[@higham:1993a]: https://doi.org/10.1137/0914050
140+
127141
</section>
128142

129143
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/mediansorted/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ The function has the following parameters:
6363
## Notes
6464

6565
- If provided an empty ndarray, the function returns `NaN`.
66+
- The one-dimensional input ndarray must be sorted in either **strictly** ascending or descending order.
6667

6768
</section>
6869

lib/node_modules/@stdlib/stats/base/ndarray/minsorted/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The function has the following parameters:
6363
## Notes
6464

6565
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
66-
- The input ndarray must be sorted in either ascending or descending order.
66+
- The one-dimensional input ndarray must be sorted in either **strictly** ascending or descending order.
6767

6868
</section>
6969

lib/node_modules/@stdlib/stats/base/ndarray/smaxabssorted/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The function has the following parameters:
6464
## Notes
6565

6666
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
67+
- The one-dimensional input ndarray must be sorted in either **strictly** ascending or descending order.
6768

6869
</section>
6970

0 commit comments

Comments
 (0)