Skip to content

Commit e0767ad

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

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
@@ -32,7 +32,6 @@ import dmeanvarpn = require( '@stdlib/stats/base/dmeanvarpn' );
3232
import dvarm = require( '@stdlib/stats/base/dvarm' );
3333
import dvarmpn = require( '@stdlib/stats/base/dvarmpn' );
3434
import max = require( '@stdlib/stats/base/max' );
35-
import maxBy = require( '@stdlib/stats/base/max-by' );
3635
import maxabs = require( '@stdlib/stats/base/maxabs' );
3736
import maxsorted = require( '@stdlib/stats/base/maxsorted' );
3837
import mean = require( '@stdlib/stats/base/mean' );
@@ -442,49 +441,6 @@ interface Namespace {
442441
*/
443442
max: typeof max;
444443

445-
/**
446-
* Calculates the maximum value of a strided array via a callback function.
447-
*
448-
* ## Notes
449-
*
450-
* - The callback function is provided four arguments:
451-
*
452-
* - `value`: array element
453-
* - `aidx`: array index
454-
* - `sidx`: strided index (offset + aidx*stride)
455-
* - `array`: input array
456-
*
457-
* - 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.
458-
*
459-
* @param N - number of indexed elements
460-
* @param x - input array
461-
* @param stride - stride length
462-
* @param clbk - callback
463-
* @param thisArg - execution context
464-
* @returns maximum value
465-
*
466-
* @example
467-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
468-
*
469-
* function accessor( v ) {
470-
* return v * 2.0;
471-
* }
472-
*
473-
* var v = ns.maxBy( x.length, x, 1, accessor );
474-
* // returns 8.0
475-
*
476-
* @example
477-
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
478-
*
479-
* function accessor( v ) {
480-
* return v * 2.0;
481-
* }
482-
*
483-
* var v = ns.maxBy.ndarray( x.length, x, 1, 0, accessor );
484-
* // returns 8.0
485-
*/
486-
maxBy: typeof maxBy;
487-
488444
/**
489445
* Computes the maximum absolute value of a strided array.
490446
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,6 @@ setReadOnly( ns, 'dvarmpn', require( '@stdlib/stats/base/dvarmpn' ) );
144144
*/
145145
setReadOnly( ns, 'max', require( '@stdlib/stats/base/max' ) );
146146

147-
/**
148-
* @name maxBy
149-
* @memberof ns
150-
* @readonly
151-
* @type {Function}
152-
* @see {@link module:@stdlib/stats/base/max-by}
153-
*/
154-
setReadOnly( ns, 'maxBy', require( '@stdlib/stats/base/max-by' ) );
155-
156147
/**
157148
* @name maxabs
158149
* @memberof ns

0 commit comments

Comments
 (0)