From 543a1d22ed5f395cb4f69f88152d9c5617723811 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 1 Jun 2025 07:06:58 +0000 Subject: [PATCH 1/2] feat: add `stats/array/min-by` --- 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: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - 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: passed - task: lint_license_headers status: passed --- --- .../@stdlib/stats/array/min-by/README.md | 147 ++++++++++ .../stats/array/min-by/benchmark/benchmark.js | 107 +++++++ .../@stdlib/stats/array/min-by/docs/repl.txt | 43 +++ .../stats/array/min-by/docs/types/index.d.ts | 97 +++++++ .../stats/array/min-by/docs/types/test.ts | 72 +++++ .../stats/array/min-by/examples/index.js | 34 +++ .../@stdlib/stats/array/min-by/lib/index.js | 46 +++ .../@stdlib/stats/array/min-by/lib/main.js | 93 ++++++ .../@stdlib/stats/array/min-by/package.json | 67 +++++ .../@stdlib/stats/array/min-by/test/test.js | 274 ++++++++++++++++++ 10 files changed, 980 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/README.md create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/package.json create mode 100644 lib/node_modules/@stdlib/stats/array/min-by/test/test.js diff --git a/lib/node_modules/@stdlib/stats/array/min-by/README.md b/lib/node_modules/@stdlib/stats/array/min-by/README.md new file mode 100644 index 000000000000..3cd6e5b3dc02 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/README.md @@ -0,0 +1,147 @@ + + +# minBy + +> Calculate the minimum value of an array via a callback function. + +
+ +
+ + + +
+ +## Usage + +```javascript +var minBy = require( '@stdlib/stats/array/min-by' ); +``` + +#### minBy( x, clbk\[, thisArg] ) + +Computes the minimum value of an array via a callback function. + +```javascript +function accessor( v ) { + return v * 2.0; +} + +var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; + +var v = minBy( x, accessor ); +// returns -10.0 +``` + +The function has the following parameters: + +- **x**: input array. +- **clbk**: callback function. +- **thisArg**: execution context (_optional_). + +The invoked callback is provided four arguments: + +- **value**: array element. +- **aidx**: array index. +- **array**: input array/collection. + +To set the callback execution context, provide a `thisArg`. + +```javascript +function accessor( v ) { + this.count += 1; + return v * 2.0; +} + +var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; + +var context = { + 'count': 0 +}; + +var v = minBy( x, accessor, context ); +// returns -10.0 + +var cnt = context.count; +// returns 8 +``` + +
+ + + +
+ +## Notes + +- If provided an empty array, the function returns `NaN`. +- A provided callback function should return a numeric value. +- If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is **ignored**. +- The function supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]). + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var minBy = require( '@stdlib/stats/array/min-by' ); + +function accessor( v ) { + return v * 2.0; +} + +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +console.log( x ); + +var v = minBy( x, accessor ); +console.log( v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor + +
+ + diff --git a/lib/node_modules/@stdlib/stats/array/min-by/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/array/min-by/benchmark/benchmark.js new file mode 100644 index 000000000000..1518cd3a3d81 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/benchmark/benchmark.js @@ -0,0 +1,107 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var minBy = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Accessor function. +* +* @private +* @param {number} value - array element +* @returns {number} accessed value +*/ +function accessor( value ) { + return value * 2.0; +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -10, 10, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = minBy( x, accessor ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt new file mode 100644 index 000000000000..9c017a8b6316 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt @@ -0,0 +1,43 @@ + +{{alias}}( x, clbk[, thisArg] ) + Computes the minimum value of an array via a callback function. + + If provided an empty array, the function returns `NaN`. + + The callback function is provided three arguments: + + - value: array element. + - aidx: array index. + - array: the input array. + + 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. + + Parameters + ---------- + x: Array|TypedArray + Input array. + + clbk: Function + Callback function. + + thisArg: any (optional) + Execution context. + + Returns + ------- + out: number + Minimum value. + + Examples + -------- + > function accessor( v ) { return v * 2.0; }; + > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; + > {{alias}}( x, accessor ) + -10.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts new file mode 100644 index 000000000000..1398a905e6c7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts @@ -0,0 +1,97 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; + +/** +* Returns an accessed value. +* +* @returns accessed value +*/ +type Nullary = ( this: U ) => number | void; + +/** +* Returns an accessed value. +* +* @param value - array element +* @returns accessed value +*/ +type Unary = ( this: U, value: T ) => number | void; + +/** +* Returns an accessed value. +* +* @param value - array element +* @param aidx - array index +* @returns accessed value +*/ +type Binary = ( this: U, value: T, aidx: number ) => number | void; + +/** +* Returns an accessed value. +* +* @param value - array element +* @param aidx - array index +* @param array - input array +* @returns accessed value +*/ +type Ternary = ( this: U, value: T, aidx: number, array: Collection ) => number | void; + +/** +* Returns an accessed value. +* +* @param value - array element +* @param aidx - array index +* @param array - input array +* @returns accessed value +*/ +type Callback = Nullary | Unary | Binary | Ternary; + +/** +* Computes the minimum value of an array via a callback function. +* +* @param x - input array +* @param clbk - callback +* @param thisArg - execution context +* @returns minimum value +* +* @example +* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; +* +* function accessor( v ) { +* return v * 2.0; +* } +* +* var v = minBy( x, accessor ); +* // returns -10.0 +*/ +declare function minBy( x: InputArray, clbk: Callback, thisArg?: ThisParameterType> ): number; + + +// EXPORTS // + +export = minBy; diff --git a/lib/node_modules/@stdlib/stats/array/min-by/docs/types/test.ts b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/test.ts new file mode 100644 index 000000000000..d54ac41701ba --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/test.ts @@ -0,0 +1,72 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import AccessorArray = require( '@stdlib/array/base/accessor' ); +import minBy = require( './index' ); + +const accessor = (): number => { + return 5.0; +}; + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + + minBy( x, accessor ); // $ExpectType number + minBy( new AccessorArray( x ), accessor ); // $ExpectType number + + minBy( x, accessor, {} ); // $ExpectType number + minBy( new AccessorArray( x ), accessor, {} ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a numeric array... +{ + minBy( 10, accessor ); // $ExpectError + minBy( '10', accessor ); // $ExpectError + minBy( true, accessor ); // $ExpectError + minBy( false, accessor ); // $ExpectError + minBy( null, accessor ); // $ExpectError + minBy( undefined, accessor ); // $ExpectError + minBy( {}, accessor ); // $ExpectError + minBy( ( x: number ): number => x, accessor ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a function... +{ + const x = new Float64Array( 10 ); + + minBy( x, '10' ); // $ExpectError + minBy( x, true ); // $ExpectError + minBy( x, false ); // $ExpectError + minBy( x, null ); // $ExpectError + minBy( x, undefined ); // $ExpectError + minBy( x, [] ); // $ExpectError + minBy( x, {} ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + + minBy(); // $ExpectError + minBy( x ); // $ExpectError + minBy( x, accessor, {}, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/array/min-by/examples/index.js b/lib/node_modules/@stdlib/stats/array/min-by/examples/index.js new file mode 100644 index 000000000000..20653646d666 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var minBy = require( './../lib' ); + +function accessor( v ) { + return v * 2.0; +} + +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +console.log( x ); + +var v = minBy( x, accessor ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/array/min-by/lib/index.js b/lib/node_modules/@stdlib/stats/array/min-by/lib/index.js new file mode 100644 index 000000000000..e9f47fed2bda --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/lib/index.js @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Compute the minimum value of an array via a callback function. +* +* @module @stdlib/stats/array/min-by +* +* @example +* var minBy = require( '@stdlib/stats/array/min-by' ); +* +* function accessor( v ) { +* return v * 2.0; +* } +* +* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; +* +* var v = minBy( x, accessor ); +* // returns -10.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js b/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js new file mode 100644 index 000000000000..6f71af465ac4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js @@ -0,0 +1,93 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var isCollection = require( '@stdlib/assert/is-collection' ); +var dtypes = require( '@stdlib/array/dtypes' ); +var dtype = require( '@stdlib/array/dtype' ); +var contains = require( '@stdlib/array/base/assert/contains' ); +var join = require( '@stdlib/array/base/join' ); +var strided = require( '@stdlib/stats/base/min-by' ).ndarray; +var format = require( '@stdlib/string/format' ); +var isFunction = require( '@stdlib/assert/is-function' ); + + +// VARIABLES // + +var IDTYPES = dtypes( 'real_and_generic' ); +var GENERIC_DTYPE = 'generic'; + + +// MAIN // + +/** +* Computes the minimum value of an array via a callback function. +* +* @param {NumericArray} x - input array +* @param {Callback} clbk - callback +* @param {*} [thisArg] - execution context +* @throws {TypeError} first argument must be an array-like object +* @throws {TypeError} first argument must have a supported data type +* @returns {number} minimum value +* +* @example +* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; +* +* function accessor( v ) { +* return v * 2.0; +* } +* +* var v = minBy( x, accessor ); +* // returns -10.0 +*/ +function minBy( x, clbk, thisArg ) { + var dt; + if ( !isCollection( x ) ) { + throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + } + dt = dtype( x ) || GENERIC_DTYPE; + if ( !contains( IDTYPES, dt ) ) { + throw new TypeError( format( 'invalid argument. First argument must have one of the following data types: "%s". Data type: `%s`.', join( IDTYPES, '", "' ), dt ) ); + } + if ( !isFunction( clbk ) ) { + throw new TypeError( format( 'invalid argument. Callback function must be a function. Value: `%s`.', clbk ) ); + } + return strided( x.length, x, 1, 0, wrapper ); + + /** + * Invokes a provided callback. + * + * @private + * @param {number} value - current element + * @param {NonNegativeInteger} aidx - current array index + * @param {NonNegativeInteger} sidx - current strided index + * @param {NumericArray} arr - input array + * @returns {number} callback return value + */ + function wrapper( value, aidx, sidx, arr ) { + return clbk.call( thisArg, value, aidx, arr ); + } +} + + +// EXPORTS // + +module.exports = minBy; diff --git a/lib/node_modules/@stdlib/stats/array/min-by/package.json b/lib/node_modules/@stdlib/stats/array/min-by/package.json new file mode 100644 index 000000000000..3a89e25dff36 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/package.json @@ -0,0 +1,67 @@ +{ + "name": "@stdlib/stats/array/min-by", + "version": "0.0.0", + "description": "Calculate the minimum value of an array via a callback function.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "minimum", + "min", + "range", + "extremes", + "domain", + "extent", + "array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/array/min-by/test/test.js b/lib/node_modules/@stdlib/stats/array/min-by/test/test.js new file mode 100644 index 000000000000..fdf9a9389d75 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/array/min-by/test/test.js @@ -0,0 +1,274 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var BooleanArray = require( '@stdlib/array/bool' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var minBy = require( './../lib/main.js' ); + + +// FUNCTIONS // + +function accessor( v ) { + if ( v === void 0 ) { + return; + } + return v * 2.0; +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof minBy, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 3', function test( t ) { + t.strictEqual( minBy.length, 3, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided a first argument which is not an array-like object', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + {}, + function noop() {} + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + minBy( value ); + }; + } +}); + +tape( 'the function throws an error if provided a first argument which has an unsupported data type', function test( t ) { + var values; + var i; + + values = [ + new BooleanArray( 4 ), + new Complex128Array( 4 ) + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + minBy( value ); + }; + } +}); + +tape( 'the function throws an error if provided a callback function argument which is not a function', function test( t ) { + var values; + var i; + var x; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + [], + {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + minBy( x, value ); + }; + } +}); + +tape( 'the function throws an error if provided a callback function argument which is not a function (options)', function test( t ) { + var values; + var i; + var x; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + [], + {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + minBy( x, value, {} ); + }; + } +}); + +tape( 'the function calculates the minimum value of an array via a callback function', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = minBy( x, accessor ); + t.strictEqual( v, -8.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = minBy( x, accessor ); + t.strictEqual( v, -10.0, 'returns expected value' ); + + x = [ -0.0, 0.0, -0.0 ]; + v = minBy( x, accessor ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = minBy( x, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = minBy( x, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the minimum value of an array via a callback function (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = minBy( toAccessorArray( x ), accessor ); + t.strictEqual( v, -8.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = minBy( toAccessorArray( x ), accessor ); + t.strictEqual( v, -10.0, 'returns expected value' ); + + x = [ -0.0, 0.0, -0.0 ]; + v = minBy( toAccessorArray( x ), accessor ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = minBy( toAccessorArray( x ), accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = minBy( toAccessorArray( x ), accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the minimum value of an array (array-like object)', function test( t ) { + var x; + var v; + + x = { + 'length': 6, + '0': 1.0, + '1': -2.0, + '2': -4.0, + '3': 5.0, + '4': 0.0, + '5': 3.0 + }; + v = minBy( x, accessor ); + t.strictEqual( v, -8.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports providing a callback execution context', function test( t ) { + var ctx; + var x; + + x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; + ctx = { + 'count': 0 + }; + minBy( x, accessor, ctx ); + + t.strictEqual( ctx.count, x.length, 'returns expected value' ); + t.end(); + + function accessor( v ) { + this.count += 1; // eslint-disable-line no-invalid-this + return v * 2.0; + } +}); + +tape( 'if provided an empty array, the function returns `NaN`', function test( t ) { + var v = minBy( [], accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an empty array, the function returns `NaN` (accessors)', function test( t ) { + var v = minBy( toAccessorArray( [] ), accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an array containing a single element, the function returns the first element applying callback function', function test( t ) { + var v = minBy( [ 1.0 ], accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an array containing a single element, the function returns the first element applying callback function (accessors)', function test( t ) { + var v = minBy( toAccessorArray( [ 1.0 ] ), accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + t.end(); +}); From 628896c49ac5615a018480ae27b4d0c897515371 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 1 Jun 2025 21:20:01 +0000 Subject: [PATCH 2/2] refactor: update docs and tests --- 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: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - 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 --- --- .../@stdlib/stats/array/min-by/README.md | 8 +- .../@stdlib/stats/array/min-by/docs/repl.txt | 4 +- .../stats/array/min-by/docs/types/index.d.ts | 26 ++--- .../@stdlib/stats/array/min-by/lib/main.js | 3 +- .../@stdlib/stats/array/min-by/test/test.js | 100 ++++++++++++------ 5 files changed, 86 insertions(+), 55 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/array/min-by/README.md b/lib/node_modules/@stdlib/stats/array/min-by/README.md index 3cd6e5b3dc02..1dcc2f446d59 100644 --- a/lib/node_modules/@stdlib/stats/array/min-by/README.md +++ b/lib/node_modules/@stdlib/stats/array/min-by/README.md @@ -57,11 +57,11 @@ The function has the following parameters: - **clbk**: callback function. - **thisArg**: execution context (_optional_). -The invoked callback is provided four arguments: +The invoked callback is provided three arguments: -- **value**: array element. -- **aidx**: array index. -- **array**: input array/collection. +- **value**: current array element. +- **index**: current array index. +- **array**: input array. To set the callback execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt index 9c017a8b6316..30b78f6bf9fd 100644 --- a/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/array/min-by/docs/repl.txt @@ -6,8 +6,8 @@ The callback function is provided three arguments: - - value: array element. - - aidx: array index. + - value: current array element. + - index: current array index. - array: the input array. The callback function should return a numeric value. diff --git a/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts index 1398a905e6c7..210585e9633f 100644 --- a/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/array/min-by/docs/types/index.d.ts @@ -32,44 +32,44 @@ type InputArray = NumericArray | Collection | AccessorArrayLike; * * @returns accessed value */ -type Nullary = ( this: U ) => number | void; +type Nullary = ( this: ThisArg ) => number | void; /** * Returns an accessed value. * -* @param value - array element +* @param value - current array element * @returns accessed value */ -type Unary = ( this: U, value: T ) => number | void; +type Unary = ( this: ThisArg, value: T ) => number | void; /** * Returns an accessed value. * -* @param value - array element -* @param aidx - array index +* @param value - current array element +* @param index - current array index * @returns accessed value */ -type Binary = ( this: U, value: T, aidx: number ) => number | void; +type Binary = ( this: ThisArg, value: T, index: number ) => number | void; /** * Returns an accessed value. * -* @param value - array element -* @param aidx - array index +* @param value - current array element +* @param index - current array index * @param array - input array * @returns accessed value */ -type Ternary = ( this: U, value: T, aidx: number, array: Collection ) => number | void; +type Ternary = ( this: ThisArg, value: T, index: number, array: U ) => number | void; /** * Returns an accessed value. * -* @param value - array element -* @param aidx - array index +* @param value - current array element +* @param index - current array index * @param array - input array * @returns accessed value */ -type Callback = Nullary | Unary | Binary | Ternary; +type Callback = Nullary | Unary | Binary | Ternary; /** * Computes the minimum value of an array via a callback function. @@ -89,7 +89,7 @@ type Callback = Nullary | Unary | Binary | Ternary; * var v = minBy( x, accessor ); * // returns -10.0 */ -declare function minBy( x: InputArray, clbk: Callback, thisArg?: ThisParameterType> ): number; +declare function minBy( x: U, clbk: Callback, thisArg?: ThisParameterType> ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js b/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js index 6f71af465ac4..648de1a465ff 100644 --- a/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/array/min-by/lib/main.js @@ -46,6 +46,7 @@ var GENERIC_DTYPE = 'generic'; * @param {*} [thisArg] - execution context * @throws {TypeError} first argument must be an array-like object * @throws {TypeError} first argument must have a supported data type +* @throws {TypeError} second argument must be a function * @returns {number} minimum value * * @example @@ -68,7 +69,7 @@ function minBy( x, clbk, thisArg ) { throw new TypeError( format( 'invalid argument. First argument must have one of the following data types: "%s". Data type: `%s`.', join( IDTYPES, '", "' ), dt ) ); } if ( !isFunction( clbk ) ) { - throw new TypeError( format( 'invalid argument. Callback function must be a function. Value: `%s`.', clbk ) ); + throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', clbk ) ); } return strided( x.length, x, 1, 0, wrapper ); diff --git a/lib/node_modules/@stdlib/stats/array/min-by/test/test.js b/lib/node_modules/@stdlib/stats/array/min-by/test/test.js index fdf9a9389d75..1d70149765ba 100644 --- a/lib/node_modules/@stdlib/stats/array/min-by/test/test.js +++ b/lib/node_modules/@stdlib/stats/array/min-by/test/test.js @@ -74,7 +74,7 @@ tape( 'the function throws an error if provided a first argument which is not an function badValue( value ) { return function badValue() { - minBy( value ); + minBy( value, accessor ); }; } }); @@ -94,12 +94,12 @@ tape( 'the function throws an error if provided a first argument which has an un function badValue( value ) { return function badValue() { - minBy( value ); + minBy( value, accessor ); }; } }); -tape( 'the function throws an error if provided a callback function argument which is not a function', function test( t ) { +tape( 'the function throws an error if provided a second argument which is not a function', function test( t ) { var values; var i; var x; @@ -128,35 +128,6 @@ tape( 'the function throws an error if provided a callback function argument whi } }); -tape( 'the function throws an error if provided a callback function argument which is not a function (options)', function test( t ) { - var values; - var i; - var x; - - x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; - values = [ - '5', - 5, - NaN, - null, - void 0, - true, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - minBy( x, value, {} ); - }; - } -}); - tape( 'the function calculates the minimum value of an array via a callback function', function test( t ) { var x; var v; @@ -231,6 +202,10 @@ tape( 'the function calculates the minimum value of an array (array-like object) }); tape( 'the function supports providing a callback execution context', function test( t ) { + var expected; + var indices; + var values; + var arrays; var ctx; var x; @@ -238,13 +213,68 @@ tape( 'the function supports providing a callback execution context', function t ctx = { 'count': 0 }; + indices = []; + values = []; + arrays = []; minBy( x, accessor, ctx ); t.strictEqual( ctx.count, x.length, 'returns expected value' ); + + expected = [ 0, 1, 2, 3, 4 ]; + t.deepEqual( indices, expected, 'returns expected value' ); + + expected = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; + t.deepEqual( values, expected, 'returns expected value' ); + + expected = [ x, x, x, x, x ]; + t.deepEqual( arrays, expected, 'returns expected value' ); + t.end(); + + function accessor( v, idx, arr ) { + this.count += 1; // eslint-disable-line no-invalid-this + indices.push( idx ); + values.push( v ); + arrays.push( arr ); + return v * 2.0; + } +}); + +tape( 'the function supports providing a callback execution context (accessors)', function test( t ) { + var expected; + var indices; + var values; + var arrays; + var ctx; + var ax; + var x; + + x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; + ax = toAccessorArray( x ); + ctx = { + 'count': 0 + }; + indices = []; + values = []; + arrays = []; + minBy( ax, accessor, ctx ); + + t.strictEqual( ctx.count, x.length, 'returns expected value' ); + + expected = [ 0, 1, 2, 3, 4 ]; + t.deepEqual( indices, expected, 'returns expected value' ); + + expected = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; + t.deepEqual( values, expected, 'returns expected value' ); + + expected = [ ax, ax, ax, ax, ax ]; + t.deepEqual( arrays, expected, 'returns expected value' ); t.end(); - function accessor( v ) { + function accessor( v, idx, arr ) { this.count += 1; // eslint-disable-line no-invalid-this + indices.push( idx ); + values.push( v ); + arrays.push( arr ); return v * 2.0; } }); @@ -261,13 +291,13 @@ tape( 'if provided an empty array, the function returns `NaN` (accessors)', func t.end(); }); -tape( 'if provided an array containing a single element, the function returns the first element applying callback function', function test( t ) { +tape( 'if provided an array containing a single element, the function returns the result of applying a provided callback function to that element', function test( t ) { var v = minBy( [ 1.0 ], accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); t.end(); }); -tape( 'if provided an array containing a single element, the function returns the first element applying callback function (accessors)', function test( t ) { +tape( 'if provided an array containing a single element, the function returns the result of applying a provided callback function to that element (accessors)', function test( t ) { var v = minBy( toAccessorArray( [ 1.0 ] ), accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); t.end();