Skip to content

Commit a7e7d81

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

File tree

2 files changed

+0
-57
lines changed

2 files changed

+0
-57
lines changed

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

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ import nanmeanors = require( '@stdlib/stats/base/nanmeanors' );
4242
import nanmeanpn = require( '@stdlib/stats/base/nanmeanpn' );
4343
import nanmeanwd = require( '@stdlib/stats/base/nanmeanwd' );
4444
import nanmin = require( '@stdlib/stats/base/nanmin' );
45-
import nanminBy = require( '@stdlib/stats/base/nanmin-by' );
4645
import nanmskmax = require( '@stdlib/stats/base/nanmskmax' );
4746
import nanmskmin = require( '@stdlib/stats/base/nanmskmin' );
4847
import nanmskrange = require( '@stdlib/stats/base/nanmskrange' );
@@ -645,53 +644,6 @@ interface Namespace {
645644
*/
646645
nanmin: typeof nanmin;
647646

648-
/**
649-
* Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values.
650-
*
651-
* ## Notes
652-
*
653-
* - The callback function is provided four arguments:
654-
*
655-
* - `value`: array element
656-
* - `aidx`: array index
657-
* - `sidx`: strided index (offset + aidx*stride)
658-
* - `array`: input array
659-
*
660-
* - The callback function should return a numeric value.
661-
*
662-
* - If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.
663-
*
664-
* - If the callback function returns `NaN`, the value is ignored.
665-
*
666-
* @param N - number of indexed elements
667-
* @param x - input array
668-
* @param stride - stride length
669-
* @param clbk - callback
670-
* @param thisArg - execution context
671-
* @returns minimum value
672-
*
673-
* @example
674-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ];
675-
*
676-
* function accessor( v ) {
677-
* return v * 2.0;
678-
* }
679-
*
680-
* var v = ns.nanminBy( x.length, x, 1, accessor );
681-
* // returns -10.0
682-
*
683-
* @example
684-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ];
685-
*
686-
* function accessor( v ) {
687-
* return v * 2.0;
688-
* }
689-
*
690-
* var v = ns.nanminBy.ndarray( x.length, x, 1, 0, accessor );
691-
* // returns -10.0
692-
*/
693-
nanminBy: typeof nanminBy;
694-
695647
/**
696648
* Computes the maximum value of a strided array according to a mask, ignoring `NaN` values.
697649
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -234,15 +234,6 @@ setReadOnly( ns, 'nanmeanwd', require( '@stdlib/stats/base/nanmeanwd' ) );
234234
*/
235235
setReadOnly( ns, 'nanmin', require( '@stdlib/stats/base/nanmin' ) );
236236

237-
/**
238-
* @name nanminBy
239-
* @memberof ns
240-
* @readonly
241-
* @type {Function}
242-
* @see {@link module:@stdlib/stats/base/nanmin-by}
243-
*/
244-
setReadOnly( ns, 'nanminBy', require( '@stdlib/stats/base/nanmin-by' ) );
245-
246237
/**
247238
* @name nanmskmax
248239
* @memberof ns

0 commit comments

Comments
 (0)