Skip to content

Commit 98d7ca6

Browse files
committed
docs: update JSDoc and example
--- 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: na - 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 dd450e8 commit 98d7ca6

File tree

1 file changed

+3
-4
lines changed
  • lib/node_modules/@stdlib/stats/base/variancetk/lib

1 file changed

+3
-4
lines changed

lib/node_modules/@stdlib/stats/base/variancetk/lib/main.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,18 @@ var ndarray = require( './ndarray.js' );
2727
// MAIN //
2828

2929
/**
30-
* Computes the variance of a strided array.
30+
* Computes the variance of a strided array using a one-pass textbook algorithm.
3131
*
3232
* @param {PositiveInteger} N - number of indexed elements
33-
* @param {PositiveInteger} correction - degrees of freedom adjustment
33+
* @param {number} correction - degrees of freedom adjustment
3434
* @param {NumericArray} x - input array
3535
* @param {integer} strideX - stride length
3636
* @returns {number} variance
3737
*
3838
* @example
3939
* var x = [ 1.0, -2.0, 2.0 ];
40-
* var N = x.length;
4140
*
42-
* var v = variancetk( N, 1, x, 1 );
41+
* var v = variancetk( x.length, 1, x, 1 );
4342
* // returns ~4.3333
4443
*/
4544
function variancetk( N, correction, x, strideX ) {

0 commit comments

Comments
 (0)