Skip to content

Commit 5c0803a

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

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
@@ -53,7 +53,6 @@ import snanvariancetk = require( '@stdlib/stats/base/snanvariancetk' );
5353
import snanvariancewd = require( '@stdlib/stats/base/snanvariancewd' );
5454
import snanvarianceyc = require( '@stdlib/stats/base/snanvarianceyc' );
5555
import sstdevwd = require( '@stdlib/stats/base/sstdevwd' );
56-
import stdev = require( '@stdlib/stats/base/stdev' );
5756
import dmeankbn2 = require( '@stdlib/stats/strided/dmeankbn2' );
5857
import dmeanli = require( '@stdlib/stats/strided/dmeanli' );
5958
import dmeanlipw = require( '@stdlib/stats/strided/dmeanlipw' );
@@ -886,29 +885,6 @@ interface Namespace {
886885
*/
887886
sstdevwd: typeof sstdevwd;
888887

889-
/**
890-
* Computes the standard deviation of a strided array.
891-
*
892-
* @param N - number of indexed elements
893-
* @param correction - degrees of freedom adjustment
894-
* @param x - input array
895-
* @param stride - stride length
896-
* @returns standard deviation
897-
*
898-
* @example
899-
* var x = [ 1.0, -2.0, 2.0 ];
900-
*
901-
* var v = ns.stdev( x.length, 1, x, 1 );
902-
* // returns ~2.0817
903-
*
904-
* @example
905-
* var x = [ 1.0, -2.0, 2.0 ];
906-
*
907-
* var v = ns.stdev.ndarray( x.length, 1, x, 1, 0 );
908-
* // returns ~2.0817
909-
*/
910-
stdev: typeof stdev;
911-
912888
/**
913889
* Computes the arithmetic mean of a double-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm.
914890
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -342,15 +342,6 @@ setReadOnly( ns, 'snanvarianceyc', require( '@stdlib/stats/base/snanvarianceyc'
342342
*/
343343
setReadOnly( ns, 'sstdevwd', require( '@stdlib/stats/base/sstdevwd' ) );
344344

345-
/**
346-
* @name stdev
347-
* @memberof ns
348-
* @readonly
349-
* @type {Function}
350-
* @see {@link module:@stdlib/stats/base/stdev}
351-
*/
352-
setReadOnly( ns, 'stdev', require( '@stdlib/stats/base/stdev' ) );
353-
354345
/**
355346
* @name dmeankbn2
356347
* @memberof ns

0 commit comments

Comments
 (0)