Skip to content

Commit b8f5542

Browse files
committed
docs: update example in variancetk function for clarity
--- 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 35849b5 commit b8f5542

File tree

1 file changed

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

1 file changed

+4
-8
lines changed

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
3838
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
3939
*
40-
* var x = toAccessorArray( [ 1.0, -2.0, 2.0 ] );
40+
* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
4141
*
42-
* var v = variancetk( x.length, 1, arraylike2object( x ), 1, 0 );
43-
* // returns ~4.3333
42+
* var v = variancetk( 4, 1, arraylike2object( x ), 2, 1 );
43+
* // returns 6.25
4444
*/
4545
function variancetk( N, correction, x, strideX, offsetX ) {
4646
var xbuf;
@@ -52,17 +52,13 @@ function variancetk( N, correction, x, strideX, offsetX ) {
5252
var n;
5353
var i;
5454

55-
n = N - correction;
56-
if ( N <= 0 || n <= 0.0 ) {
57-
return NaN;
58-
}
59-
6055
// Cache reference to array data:
6156
xbuf = x.data;
6257

6358
// Cache a reference to the element accessor:
6459
get = x.accessors[ 0 ];
6560

61+
n = N - correction;
6662
if ( N === 1 || strideX === 0 ) {
6763
return get( xbuf, offsetX );
6864
}

0 commit comments

Comments
 (0)