Skip to content

Commit 2947a4b

Browse files
committed
docs: add references and fix optional parameter documentation
--- 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: passed - 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 ---
1 parent 0dd627d commit 2947a4b

File tree

5 files changed

+50
-2
lines changed

5 files changed

+50
-2
lines changed

lib/node_modules/@stdlib/stats/array/stdevpn/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,19 @@ console.log( v );
162162

163163
<!-- /.examples -->
164164

165+
* * *
166+
167+
<section class="references">
168+
169+
## References
170+
171+
- Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958][@neely:1966a].
172+
- Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036][@schubert:2018a].
173+
174+
</section>
175+
176+
<!-- /.references -->
177+
165178
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
166179

167180
<section class="related">
@@ -178,6 +191,10 @@ console.log( v );
178191

179192
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
180193

194+
[@neely:1966a]: https://doi.org/10.1145/365719.365958
195+
196+
[@schubert:2018a]: https://doi.org/10.1145/3221269.3223036
197+
181198
</section>
182199

183200
<!-- /.links -->

lib/node_modules/@stdlib/stats/array/stdevpn/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var GENERIC_DTYPE = 'generic';
4242
* Computes the standard deviation of an array using a two-pass algorithm.
4343
*
4444
* @param {NumericArray} x - input array
45-
* @param {number} correction - degrees of freedom adjustment
45+
* @param {number} [correction=1.0] - degrees of freedom adjustment
4646
* @throws {TypeError} first argument must have a supported data type
4747
* @throws {TypeError} first argument must be an array-like object
4848
* @throws {TypeError} second argument must be an number

lib/node_modules/@stdlib/stats/array/stdevwd/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,19 @@ console.log( v );
162162

163163
<!-- /.examples -->
164164

165+
* * *
166+
167+
<section class="references">
168+
169+
## References
170+
171+
- Welford, B. P. 1962. "Note on a Method for Calculating Corrected Sums of Squares and Products." _Technometrics_ 4 (3). Taylor & Francis: 419–20. doi:[10.1080/00401706.1962.10490022][@welford:1962a].
172+
- van Reeken, A. J. 1968. "Letters to the Editor: Dealing with Neely's Algorithms." _Communications of the ACM_ 11 (3): 149–50. doi:[10.1145/362929.362961][@vanreeken:1968a].
173+
174+
</section>
175+
176+
<!-- /.references -->
177+
165178
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
166179

167180
<section class="related">
@@ -178,6 +191,10 @@ console.log( v );
178191

179192
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
180193

194+
[@welford:1962a]: https://doi.org/10.1080/00401706.1962.10490022
195+
196+
[@vanreeken:1968a]: https://doi.org/10.1145/362929.362961
197+
181198
</section>
182199

183200
<!-- /.links -->

lib/node_modules/@stdlib/stats/array/stdevyc/README.md

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

163163
<!-- /.examples -->
164164

165+
* * *
166+
167+
<section class="references">
168+
169+
## References
170+
171+
- Youngs, Edward A., and Elliot M. Cramer. 1971. "Some Results Relevant to Choice of Sum and Sum-of-Product Algorithms." _Technometrics_ 13 (3): 657–65. doi:[10.1080/00401706.1971.10488826][@youngs:1971a].
172+
173+
</section>
174+
175+
<!-- /.references -->
176+
165177
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
166178

167179
<section class="related">
@@ -178,6 +190,8 @@ console.log( v );
178190

179191
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
180192

193+
[@youngs:1971a]: https://doi.org/10.1080/00401706.1971.10488826
194+
181195
</section>
182196

183197
<!-- /.links -->

lib/node_modules/@stdlib/stats/array/stdevyc/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var GENERIC_DTYPE = 'generic';
4242
* Computes the standard deviation of an array using a one-pass algorithm proposed by Youngs and Cramer.
4343
*
4444
* @param {NumericArray} x - input array
45-
* @param {number} correction - degrees of freedom adjustment
45+
* @param {number} [correction=1.0] - degrees of freedom adjustment
4646
* @throws {TypeError} first argument must have a supported data type
4747
* @throws {TypeError} first argument must be an array-like object
4848
* @throws {TypeError} second argument must be an number

0 commit comments

Comments
 (0)