Skip to content

Commit f6448fd

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

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
@@ -40,7 +40,6 @@ import meanpw = require( '@stdlib/stats/base/meanpw' );
4040
import meanwd = require( '@stdlib/stats/base/meanwd' );
4141
import mediansorted = require( '@stdlib/stats/base/mediansorted' );
4242
import min = require( '@stdlib/stats/base/min' );
43-
import minBy = require( '@stdlib/stats/base/min-by' );
4443
import minabs = require( '@stdlib/stats/base/minabs' );
4544
import minsorted = require( '@stdlib/stats/base/minsorted' );
4645
import mskmax = require( '@stdlib/stats/base/mskmax' );
@@ -614,49 +613,6 @@ interface Namespace {
614613
*/
615614
min: typeof min;
616615

617-
/**
618-
* Calculates the minimum value of a strided array via a callback function.
619-
*
620-
* ## Notes
621-
*
622-
* - The callback function is provided four arguments:
623-
*
624-
* - `value`: array element
625-
* - `aidx`: array index
626-
* - `sidx`: strided index (offset + aidx*stride)
627-
* - `array`: input array
628-
*
629-
* - 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.
630-
*
631-
* @param N - number of indexed elements
632-
* @param x - input array
633-
* @param stride - stride length
634-
* @param clbk - callback
635-
* @param thisArg - execution context
636-
* @returns minimum value
637-
*
638-
* @example
639-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
640-
*
641-
* function accessor( v ) {
642-
* return v * 2.0;
643-
* }
644-
*
645-
* var v = ns.minBy( x.length, x, 1, accessor );
646-
* // returns -10.0
647-
*
648-
* @example
649-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
650-
*
651-
* function accessor( v ) {
652-
* return v * 2.0;
653-
* }
654-
*
655-
* var v = ns.minBy.ndarray( x.length, x, 1, 0, accessor );
656-
* // returns -10.0
657-
*/
658-
minBy: typeof minBy;
659-
660616
/**
661617
* Computes the minimum absolute value of a strided array.
662618
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,6 @@ setReadOnly( ns, 'mediansorted', require( '@stdlib/stats/base/mediansorted' ) );
216216
*/
217217
setReadOnly( ns, 'min', require( '@stdlib/stats/base/min' ) );
218218

219-
/**
220-
* @name minBy
221-
* @memberof ns
222-
* @readonly
223-
* @type {Function}
224-
* @see {@link module:@stdlib/stats/base/min-by}
225-
*/
226-
setReadOnly( ns, 'minBy', require( '@stdlib/stats/base/min-by' ) );
227-
228219
/**
229220
* @name minabs
230221
* @memberof ns

0 commit comments

Comments
 (0)