Skip to content

Commit fcfbee1

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

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
@@ -38,7 +38,6 @@ import meanpn = require( '@stdlib/stats/base/meanpn' );
3838
import meanpw = require( '@stdlib/stats/base/meanpw' );
3939
import meanwd = require( '@stdlib/stats/base/meanwd' );
4040
import nanmax = require( '@stdlib/stats/base/nanmax' );
41-
import nanmaxBy = require( '@stdlib/stats/base/nanmax-by' );
4241
import nanmean = require( '@stdlib/stats/base/nanmean' );
4342
import nanmeanors = require( '@stdlib/stats/base/nanmeanors' );
4443
import nanmeanpn = require( '@stdlib/stats/base/nanmeanpn' );
@@ -560,53 +559,6 @@ interface Namespace {
560559
*/
561560
nanmax: typeof nanmax;
562561

563-
/**
564-
* Calculates the maximum value of a strided array via a callback function, ignoring `NaN` values.
565-
*
566-
* ## Notes
567-
*
568-
* - The callback function is provided four arguments:
569-
*
570-
* - `value`: array element
571-
* - `aidx`: array index
572-
* - `sidx`: strided index (offset + aidx*stride)
573-
* - `array`: input array
574-
*
575-
* - The callback function should return a numeric value.
576-
*
577-
* - If the callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.
578-
*
579-
* - If the callback function returns `NaN`, the value is ignored.
580-
*
581-
* @param N - number of indexed elements
582-
* @param x - input array
583-
* @param stride - stride length
584-
* @param clbk - callback
585-
* @param thisArg - execution context
586-
* @returns maximum value
587-
*
588-
* @example
589-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ];
590-
*
591-
* function accessor( v ) {
592-
* return v * 2.0;
593-
* }
594-
*
595-
* var v = ns.nanmaxBy( x.length, x, 1, accessor );
596-
* // returns 8.0
597-
*
598-
* @example
599-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ];
600-
*
601-
* function accessor( v ) {
602-
* return v * 2.0;
603-
* }
604-
*
605-
* var v = ns.nanmaxBy.ndarray( x.length, x, 1, 0, accessor );
606-
* // returns 8.0
607-
*/
608-
nanmaxBy: typeof nanmaxBy;
609-
610562
/**
611563
* Computes the arithmetic mean of a strided array, ignoring `NaN` values.
612564
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -198,15 +198,6 @@ setReadOnly( ns, 'meanwd', require( '@stdlib/stats/base/meanwd' ) );
198198
*/
199199
setReadOnly( ns, 'nanmax', require( '@stdlib/stats/base/nanmax' ) );
200200

201-
/**
202-
* @name nanmaxBy
203-
* @memberof ns
204-
* @readonly
205-
* @type {Function}
206-
* @see {@link module:@stdlib/stats/base/nanmax-by}
207-
*/
208-
setReadOnly( ns, 'nanmaxBy', require( '@stdlib/stats/base/nanmax-by' ) );
209-
210201
/**
211202
* @name nanmean
212203
* @memberof ns

0 commit comments

Comments
 (0)