Skip to content

Commit f647afc

Browse files
committed
remove: remove variancetk from namespace
This commit removes the `variancetk` symbol from the `@stdlib/stats/base` namespace due to a package migration. BREAKING CHANGE: remove `variancetk` To migrate, users should access the same symbol via the `@stdlib/stats/strided` namespace. Ref: #4797 --- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7ca7b60 commit f647afc

File tree

2 files changed

+0
-33
lines changed

2 files changed

+0
-33
lines changed

lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ import stdevyc = require( '@stdlib/stats/base/stdevyc' );
6969
import variance = require( '@stdlib/stats/base/variance' );
7070
import variancech = require( '@stdlib/stats/base/variancech' );
7171
import variancepn = require( '@stdlib/stats/base/variancepn' );
72-
import variancetk = require( '@stdlib/stats/base/variancetk' );
7372
import dmeankbn2 = require( '@stdlib/stats/strided/dmeankbn2' );
7473
import dmeanli = require( '@stdlib/stats/strided/dmeanli' );
7574
import dmeanlipw = require( '@stdlib/stats/strided/dmeanlipw' );
@@ -1321,29 +1320,6 @@ interface Namespace {
13211320
*/
13221321
variancepn: typeof variancepn;
13231322

1324-
/**
1325-
* Computes the variance of a strided array using a one-pass textbook algorithm.
1326-
*
1327-
* @param N - number of indexed elements
1328-
* @param correction - degrees of freedom adjustment
1329-
* @param x - input array
1330-
* @param stride - stride length
1331-
* @returns variance
1332-
*
1333-
* @example
1334-
* var x = [ 1.0, -2.0, 2.0 ];
1335-
*
1336-
* var v = ns.variancetk( x.length, 1, x, 1 );
1337-
* // returns ~4.3333
1338-
*
1339-
* @example
1340-
* var x = [ 1.0, -2.0, 2.0 ];
1341-
*
1342-
* var v = ns.variancetk.ndarray( x.length, 1, x, 1, 0 );
1343-
* // returns ~4.3333
1344-
*/
1345-
variancetk: typeof variancetk;
1346-
13471323
/**
13481324
* Computes the arithmetic mean of a double-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm.
13491325
*

lib/node_modules/@stdlib/stats/base/lib/index.js

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -486,15 +486,6 @@ setReadOnly( ns, 'variancech', require( '@stdlib/stats/base/variancech' ) );
486486
*/
487487
setReadOnly( ns, 'variancepn', require( '@stdlib/stats/base/variancepn' ) );
488488

489-
/**
490-
* @name variancetk
491-
* @memberof ns
492-
* @readonly
493-
* @type {Function}
494-
* @see {@link module:@stdlib/stats/base/variancetk}
495-
*/
496-
setReadOnly( ns, 'variancetk', require( '@stdlib/stats/base/variancetk' ) );
497-
498489
/**
499490
* @name dmeankbn2
500491
* @memberof ns

0 commit comments

Comments
 (0)