Skip to content

Commit 3eb90f3

Browse files
committed
remove: remove varianceyc from namespace
This commit removes the `varianceyc` symbol from the `@stdlib/stats/base` namespace due to a package migration. BREAKING CHANGE: remove `varianceyc` 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 628566c commit 3eb90f3

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
@@ -71,7 +71,6 @@ import variancech = require( '@stdlib/stats/base/variancech' );
7171
import variancepn = require( '@stdlib/stats/base/variancepn' );
7272
import variancetk = require( '@stdlib/stats/base/variancetk' );
7373
import variancewd = require( '@stdlib/stats/base/variancewd' );
74-
import varianceyc = require( '@stdlib/stats/base/varianceyc' );
7574
import dmeankbn2 = require( '@stdlib/stats/strided/dmeankbn2' );
7675
import dmeanli = require( '@stdlib/stats/strided/dmeanli' );
7776
import dmeanlipw = require( '@stdlib/stats/strided/dmeanlipw' );
@@ -1369,29 +1368,6 @@ interface Namespace {
13691368
*/
13701369
variancewd: typeof variancewd;
13711370

1372-
/**
1373-
* Computes the variance of a strided array using a one-pass algorithm proposed by Youngs and Cramer.
1374-
*
1375-
* @param N - number of indexed elements
1376-
* @param correction - degrees of freedom adjustment
1377-
* @param x - input array
1378-
* @param stride - stride length
1379-
* @returns variance
1380-
*
1381-
* @example
1382-
* var x = [ 1.0, -2.0, 2.0 ];
1383-
*
1384-
* var v = ns.varianceyc( x.length, 1, x, 1 );
1385-
* // returns ~4.3333
1386-
*
1387-
* @example
1388-
* var x = [ 1.0, -2.0, 2.0 ];
1389-
*
1390-
* var v = ns.varianceyc.ndarray( x.length, 1, x, 1, 0 );
1391-
* // returns ~4.3333
1392-
*/
1393-
varianceyc: typeof varianceyc;
1394-
13951371
/**
13961372
* Computes the arithmetic mean of a double-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm.
13971373
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -504,15 +504,6 @@ setReadOnly( ns, 'variancetk', require( '@stdlib/stats/base/variancetk' ) );
504504
*/
505505
setReadOnly( ns, 'variancewd', require( '@stdlib/stats/base/variancewd' ) );
506506

507-
/**
508-
* @name varianceyc
509-
* @memberof ns
510-
* @readonly
511-
* @type {Function}
512-
* @see {@link module:@stdlib/stats/base/varianceyc}
513-
*/
514-
setReadOnly( ns, 'varianceyc', require( '@stdlib/stats/base/varianceyc' ) );
515-
516507
/**
517508
* @name dmeankbn2
518509
* @memberof ns

0 commit comments

Comments
 (0)