Skip to content

Commit 906d67f

Browse files
committed
remove: remove range-by from namespace
This commit removes the `range-by` symbol from the `@stdlib/stats/base` namespace due to a package migration. BREAKING CHANGE: remove `range-by` 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 8ecbdfa commit 906d67f

File tree

2 files changed

+0
-53
lines changed

2 files changed

+0
-53
lines changed

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

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ import nanvariancetk = require( '@stdlib/stats/base/nanvariancetk' );
3838
import nanvariancewd = require( '@stdlib/stats/base/nanvariancewd' );
3939
import nanvarianceyc = require( '@stdlib/stats/base/nanvarianceyc' );
4040
import range = require( '@stdlib/stats/base/range' );
41-
import rangeBy = require( '@stdlib/stats/base/range-by' );
4241
import sdsnanmean = require( '@stdlib/stats/base/sdsnanmean' );
4342
import sdsnanmeanors = require( '@stdlib/stats/base/sdsnanmeanors' );
4443
import snanmean = require( '@stdlib/stats/base/snanmean' );
@@ -486,49 +485,6 @@ interface Namespace {
486485
*/
487486
range: typeof range;
488487

489-
/**
490-
* Calculates the range of a strided array via a callback function.
491-
*
492-
* ## Notes
493-
*
494-
* - The callback function is provided four arguments:
495-
*
496-
* - `value`: array element
497-
* - `aidx`: array index
498-
* - `sidx`: strided index (offset + aidx*stride)
499-
* - `array`: input array
500-
*
501-
* - The callback function should return a numeric value. If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.
502-
*
503-
* @param N - number of indexed elements
504-
* @param x - input array
505-
* @param stride - stride length
506-
* @param clbk - callback
507-
* @param thisArg - execution context
508-
* @returns range
509-
*
510-
* @example
511-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
512-
*
513-
* function accessor( v ) {
514-
* return v * 2.0;
515-
* }
516-
*
517-
* var v = ns.rangeBy( x.length, x, 1, accessor );
518-
* // returns 18.0
519-
*
520-
* @example
521-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
522-
*
523-
* function accessor( v ) {
524-
* return v * 2.0;
525-
* }
526-
*
527-
* var v = ns.rangeBy.ndarray( x.length, x, 1, 0, accessor );
528-
* // returns 18.0
529-
*/
530-
rangeBy: typeof rangeBy;
531-
532488
/**
533489
* Computes the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation.
534490
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -207,15 +207,6 @@ setReadOnly( ns, 'ndarray', require( '@stdlib/stats/base/ndarray' ) );
207207
*/
208208
setReadOnly( ns, 'range', require( '@stdlib/stats/base/range' ) );
209209

210-
/**
211-
* @name rangeBy
212-
* @memberof ns
213-
* @readonly
214-
* @type {Function}
215-
* @see {@link module:@stdlib/stats/base/range-by}
216-
*/
217-
setReadOnly( ns, 'rangeBy', require( '@stdlib/stats/base/range-by' ) );
218-
219210
/**
220211
* @name sdsnanmean
221212
* @memberof ns

0 commit comments

Comments
 (0)