Skip to content

Commit c345633

Browse files
committed
remove: remove variance from namespace
This commit removes the `variance` symbol from the `@stdlib/stats/base` namespace due to a package migration. BREAKING CHANGE: remove `variance` 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 09be71b commit c345633

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
@@ -66,7 +66,6 @@ import stdevpn = require( '@stdlib/stats/base/stdevpn' );
6666
import stdevtk = require( '@stdlib/stats/base/stdevtk' );
6767
import stdevwd = require( '@stdlib/stats/base/stdevwd' );
6868
import stdevyc = require( '@stdlib/stats/base/stdevyc' );
69-
import variance = require( '@stdlib/stats/base/variance' );
7069
import dmeankbn2 = require( '@stdlib/stats/strided/dmeankbn2' );
7170
import dmeanli = require( '@stdlib/stats/strided/dmeanli' );
7271
import dmeanlipw = require( '@stdlib/stats/strided/dmeanlipw' );
@@ -1249,29 +1248,6 @@ interface Namespace {
12491248
*/
12501249
stdevyc: typeof stdevyc;
12511250

1252-
/**
1253-
* Computes the variance of a strided array.
1254-
*
1255-
* @param N - number of indexed elements
1256-
* @param correction - degrees of freedom adjustment
1257-
* @param x - input array
1258-
* @param stride - stride length
1259-
* @returns variance
1260-
*
1261-
* @example
1262-
* var x = [ 1.0, -2.0, 2.0 ];
1263-
*
1264-
* var v = ns.variance( x.length, 1, x, 1 );
1265-
* // returns ~4.3333
1266-
*
1267-
* @example
1268-
* var x = [ 1.0, -2.0, 2.0 ];
1269-
*
1270-
* var v = ns.variance.ndarray( x.length, 1, x, 1, 0 );
1271-
* // returns ~4.3333
1272-
*/
1273-
variance: typeof variance;
1274-
12751251
/**
12761252
* Computes the arithmetic mean of a double-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm.
12771253
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -459,15 +459,6 @@ setReadOnly( ns, 'stdevwd', require( '@stdlib/stats/base/stdevwd' ) );
459459
*/
460460
setReadOnly( ns, 'stdevyc', require( '@stdlib/stats/base/stdevyc' ) );
461461

462-
/**
463-
* @name variance
464-
* @memberof ns
465-
* @readonly
466-
* @type {Function}
467-
* @see {@link module:@stdlib/stats/base/variance}
468-
*/
469-
setReadOnly( ns, 'variance', require( '@stdlib/stats/base/variance' ) );
470-
471462
/**
472463
* @name dmeankbn2
473464
* @memberof ns

0 commit comments

Comments
 (0)