diff --git a/lib/node_modules/@stdlib/stats/base/max-by/README.md b/lib/node_modules/@stdlib/stats/base/max-by/README.md
index 307c67ea8779..8f3a8d32a4e9 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/README.md
+++ b/lib/node_modules/@stdlib/stats/base/max-by/README.md
@@ -30,9 +30,9 @@ limitations under the License.
var maxBy = require( '@stdlib/stats/base/max-by' );
```
-#### maxBy( N, x, stride, clbk\[, thisArg] )
+#### maxBy( N, x, strideX, clbk\[, thisArg] )
-Calculates the maximum value of strided array `x` via a callback function.
+Computes the maximum value of a strided array via a callback function.
```javascript
function accessor( v ) {
@@ -49,7 +49,7 @@ The function has the following parameters:
- **N**: number of indexed elements.
- **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions).
-- **stride**: index increment.
+- **strideX**: stride length for `x`.
- **clbk**: callback function.
- **thisArg**: execution context (_optional_).
@@ -81,19 +81,16 @@ var cnt = context.count;
// returns 8
```
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element
```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
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 N = floor( x.length / 2 );
-var v = maxBy( N, x, 2, accessor );
+var v = maxBy( 4, x, 2, accessor );
// returns 8.0
```
@@ -101,7 +98,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
```javascript
var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
function accessor( v ) {
return v * 2.0;
@@ -112,16 +108,15 @@ var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
// Create an offset view...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-var N = floor( x0.length/2 );
// Access every other element...
-var v = maxBy( N, x1, 2, accessor );
+var v = maxBy( 3, x1, 2, accessor );
// returns -4.0
```
-#### maxBy.ndarray( N, x, stride, offset, clbk\[, thisArg] )
+#### maxBy.ndarray( N, x, strideX, offsetX, clbk\[, thisArg] )
-Calculates the maximum value of strided array `x` via a callback function and using alternative indexing semantics.
+Computes the maximum value of a strided array via a callback function and using alternative indexing semantics.
```javascript
function accessor( v ) {
@@ -136,9 +131,9 @@ var v = maxBy.ndarray( x.length, x, 1, 0, accessor );
The function has the following additional parameters:
-- **offset**: starting index.
+- **offsetX**: starting index.
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
```javascript
function accessor( v ) {
@@ -162,6 +157,7 @@ var v = maxBy.ndarray( 3, x, 1, x.length-3, accessor );
- If `N <= 0`, both functions return `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**.
+- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
- When possible, prefer using [`dmax`][@stdlib/stats/strided/dmax], [`smax`][@stdlib/stats/strided/smax], and/or [`max`][@stdlib/stats/base/max], as, depending on the environment, these interfaces are likely to be significantly more performant.
@@ -175,15 +171,16 @@ var v = maxBy.ndarray( 3, x, 1, x.length-3, accessor );
```javascript
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var maxBy = require( '@stdlib/stats/base/max-by' );
function accessor( v ) {
return v * 2.0;
}
-var x = filledarrayBy( 10, 'float64', discreteUniform( -50, 50 ) );
+var x = discreteUniform( 10, -50, 50, {
+ 'dtype': 'float64'
+});
console.log( x );
var v = maxBy( x.length, x, 1, accessor );
@@ -220,6 +217,8 @@ console.log( v );
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
[@stdlib/stats/strided/dmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmax
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.js
index 1fa249e06191..6ca96b0d908c 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.js
@@ -21,11 +21,18 @@
// MODULES //
var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+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 maxBy = require( './../lib/max_by.js' );
+var maxBy = require( './../lib/main.js' );
+
+
+// VARIABLES //
+
+var options = {
+ 'dtype': 'generic'
+};
// FUNCTIONS //
@@ -49,13 +56,7 @@ function accessor( value ) {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
- var x;
- var i;
-
- x = [];
- for ( i = 0; i < len; i++ ) {
- x.push( ( randu()*20.0 ) - 10.0 );
- }
+ var x = uniform( len, -10, 10, options );
return benchmark;
function benchmark( b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.ndarray.js
index 6d6c35b06fd6..876d2bf0f00b 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.ndarray.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/benchmark/benchmark.ndarray.js
@@ -21,13 +21,20 @@
// MODULES //
var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+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 maxBy = require( './../lib/ndarray.js' );
+// VARIABLES //
+
+var options = {
+ 'dtype': 'generic'
+};
+
+
// FUNCTIONS //
/**
@@ -49,13 +56,7 @@ function accessor( value ) {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
- var x;
- var i;
-
- x = [];
- for ( i = 0; i < len; i++ ) {
- x.push( ( randu()*20.0 ) - 10.0 );
- }
+ var x = uniform( len, -10, 10, options );
return benchmark;
function benchmark( b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/max-by/docs/repl.txt
index 177b7b5f91ff..f233953226bd 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/docs/repl.txt
+++ b/lib/node_modules/@stdlib/stats/base/max-by/docs/repl.txt
@@ -1,9 +1,9 @@
-{{alias}}( N, x, stride, clbk[, thisArg] )
- Calculates the maximum value of a strided array via a callback function.
+{{alias}}( N, x, strideX, clbk[, thisArg] )
+ Computes the maximum value of a strided array via a callback function.
- The `N` and `stride` parameters determine which elements in `x` are accessed
- at runtime.
+ The `N` and stride parameters determine which elements in the strided array
+ are accessed at runtime.
Indexing is relative to the first index. To introduce an offset, use typed
array views.
@@ -31,8 +31,8 @@
Input array/collection. If provided an object, the object must be array-
like (excluding strings and functions).
- stride: integer
- Index increment for `x`.
+ strideX: integer
+ Stride length.
clbk: Function
Callback function.
@@ -53,25 +53,24 @@
> {{alias}}( x.length, x, 1, accessor )
8.0
- // Using `N` and `stride` parameters:
+ // Using `N` and stride parameters:
> x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];
- > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
- > {{alias}}( N, x, 2, accessor )
+ > {{alias}}( 3, x, 2, accessor )
8.0
// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
- > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
- > {{alias}}( N, x1, 2, accessor )
+ > {{alias}}( 3, x1, 2, accessor )
-4.0
-{{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] )
+
+{{alias}}.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )
Calculates the maximum value of a strided array via a callback function and
using alternative indexing semantics.
While typed array views mandate a view offset based on the underlying
- buffer, the `offset` parameter supports indexing semantics based on a
+ buffer, the offset parameter supports indexing semantics based on a
starting index.
Parameters
@@ -83,11 +82,11 @@
Input array/collection. If provided an object, the object must be array-
like (excluding strings and functions).
- stride: integer
- Index increment for `x`.
+ strideX: integer
+ Stride length.
- offset: integer
- Starting index of `x`.
+ offsetX: integer
+ Starting index.
clbk: Function
Callback function.
@@ -110,8 +109,7 @@
// Using an index offset:
> x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
- > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
- > {{alias}}.ndarray( N, x, 2, 1, accessor )
+ > {{alias}}.ndarray( 3, x, 2, 1, accessor )
-4.0
See Also
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/max-by/docs/types/index.d.ts
index 71733418f849..6d004459841d 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/docs/types/index.d.ts
+++ b/lib/node_modules/@stdlib/stats/base/max-by/docs/types/index.d.ts
@@ -20,7 +20,12 @@
///
-import { Collection } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection | AccessorArrayLike;
/**
* Returns an accessed value.
@@ -83,7 +88,7 @@ type Callback = Nullary | Unary | Binary | Ternary |
*/
interface Routine {
/**
- * Calculates the maximum value of a strided array via a callback function.
+ * Computes the maximum value of a strided array via a callback function.
*
* ## Notes
*
@@ -98,7 +103,7 @@ interface Routine {
*
* @param N - number of indexed elements
* @param x - input array
- * @param stride - stride length
+ * @param strideX - stride length
* @param clbk - callback
* @param thisArg - execution context
* @returns maximum value
@@ -113,10 +118,10 @@ interface Routine {
* var v = maxBy( x.length, x, 1, accessor );
* // returns 8.0
*/
- ( N: number, x: Collection, stride: number, clbk: Callback, thisArg?: ThisParameterType> ): number;
+ ( N: number, x: InputArray, strideX: number, clbk: Callback, thisArg?: ThisParameterType> ): number;
/**
- * Calculates the maximum value of a strided array via a callback function and using alternative indexing semantics.
+ * Computes the maximum value of a strided array via a callback function and using alternative indexing semantics.
*
* ## Notes
*
@@ -131,8 +136,8 @@ interface Routine {
*
* @param N - number of indexed elements
* @param x - input array
- * @param stride - stride length
- * @param offset - starting index
+ * @param strideX - stride length
+ * @param offsetX - starting index
* @param clbk - callback
* @param thisArg - execution context
* @returns maximum value
@@ -147,11 +152,11 @@ interface Routine {
* var v = maxBy.ndarray( x.length, x, 1, 0, accessor );
* // returns 8.0
*/
- ndarray( N: number, x: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): number;
+ ndarray( N: number, x: InputArray, strideX: number, offsetX: number, clbk: Callback, thisArg?: ThisParameterType> ): number;
}
/**
-* Calculates the maximum value of a strided array via a callback function.
+* Computes the maximum value of a strided array via a callback function
*
* ## Notes
*
@@ -166,7 +171,7 @@ interface Routine {
*
* @param N - number of indexed elements
* @param x - input array
-* @param stride - stride length
+* @param strideX - stride length
* @param clbk - callback
* @param thisArg - execution context
* @returns maximum value
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/max-by/docs/types/test.ts
index d03925870c1c..9b853d4d14b7 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/docs/types/test.ts
+++ b/lib/node_modules/@stdlib/stats/base/max-by/docs/types/test.ts
@@ -16,6 +16,7 @@
* limitations under the License.
*/
+import AccessorArray = require( '@stdlib/array/base/accessor' );
import maxBy = require( './index' );
const accessor = (): number => {
@@ -30,7 +31,10 @@ const accessor = (): number => {
const x = new Float64Array( 10 );
maxBy( x.length, x, 1, accessor ); // $ExpectType number
+ maxBy( x.length, new AccessorArray( x ), 1, accessor ); // $ExpectType number
+
maxBy( x.length, x, 1, accessor, {} ); // $ExpectType number
+ maxBy( x.length, new AccessorArray( x ), 1, accessor, {} ); // $ExpectType number
}
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -70,7 +74,7 @@ const accessor = (): number => {
maxBy( x.length, x, undefined, accessor ); // $ExpectError
maxBy( x.length, x, [], accessor ); // $ExpectError
maxBy( x.length, x, {}, accessor ); // $ExpectError
- maxBy( x.length, x, ( x: number, accessor ): number => x, accessor ); // $ExpectError
+ maxBy( x.length, x, ( x: number ): number => x, accessor ); // $ExpectError
}
// The compiler throws an error if the function is provided a fourth argument which is not a function...
@@ -102,7 +106,10 @@ const accessor = (): number => {
const x = new Float64Array( 10 );
maxBy.ndarray( x.length, x, 1, 0, accessor ); // $ExpectType number
+ maxBy.ndarray( x.length, new AccessorArray( x ), 1, 0, accessor ); // $ExpectType number
+
maxBy.ndarray( x.length, x, 1, 0, accessor, {} ); // $ExpectType number
+ maxBy.ndarray( x.length, new AccessorArray( x ), 1, 0, accessor, {} ); // $ExpectType number
}
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/examples/index.js b/lib/node_modules/@stdlib/stats/base/max-by/examples/index.js
index 97c2ec301baa..690901aa0b79 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/examples/index.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/examples/index.js
@@ -18,15 +18,16 @@
'use strict';
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var maxBy = require( './../lib' );
function accessor( v ) {
return v * 2.0;
}
-var x = filledarrayBy( 10, 'float64', discreteUniform( -50, 50 ) );
+var x = discreteUniform( 10, -50, 50, {
+ 'dtype': 'float64'
+});
console.log( x );
var v = maxBy( x.length, x, 1, accessor );
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/lib/max_by.js b/lib/node_modules/@stdlib/stats/base/max-by/lib/accessors.js
similarity index 56%
rename from lib/node_modules/@stdlib/stats/base/max-by/lib/max_by.js
rename to lib/node_modules/@stdlib/stats/base/max-by/lib/accessors.js
index 6e96876bf109..3aea7c81a582 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/lib/max_by.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/lib/accessors.js
@@ -1,7 +1,7 @@
/**
* @license Apache-2.0
*
-* Copyright (c) 2020 The Stdlib Authors.
+* 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.
@@ -27,60 +27,68 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
// MAIN //
/**
-* Calculates the maximum value of a strided array via a callback function.
+* Computes the maximum value of a strided array via a callback function.
*
+* @private
* @param {PositiveInteger} N - number of indexed elements
-* @param {Collection} x - input array/collection
-* @param {integer} stride - index increment
+* @param {Object} x - input array object
+* @param {Collection} x.data - input array data
+* @param {Array} x.accessors - array element accessors
+* @param {integer} strideX - stride length
+* @param {NonNegativeInteger} offsetX - starting index
* @param {Callback} clbk - callback
* @param {*} [thisArg] - execution context
* @returns {number} maximum value
*
* @example
-* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
+* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
+* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+*
+* var x = toAccessorArray( [ -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 = maxBy( x.length, x, 1, accessor );
+* var v = maxBy( x.length, arraylike2object( x ), 1, 0, accessor );
* // returns 8.0
*/
-function maxBy( N, x, stride, clbk, thisArg ) {
+function maxBy( N, x, strideX, offsetX, clbk, thisArg ) {
+ var xbuf;
+ var get;
var max;
var ix;
var v;
var i;
- if ( N <= 0 ) {
- return NaN;
- }
- if ( N === 1 || stride === 0 ) {
- v = clbk.call( thisArg, x[ 0 ], 0, 0, x );
+ // Cache reference to array data:
+ xbuf = x.data;
+
+ // Cache a reference to the element accessor:
+ get = x.accessors[ 0 ];
+
+ if ( N === 1 || strideX === 0 ) {
+ v = clbk.call( thisArg, get( xbuf, offsetX ), 0, offsetX, x );
if ( v === void 0 ) {
return NaN;
}
return v;
}
- if ( stride < 0 ) {
- ix = (1-N) * stride;
- } else {
- ix = 0;
- }
+ ix = offsetX;
for ( i = 0; i < N; i++ ) {
- max = clbk.call( thisArg, x[ ix ], i, ix, x );
+ max = clbk.call( thisArg, get( xbuf, ix ), i, ix, x );
if ( max !== void 0 ) {
break;
}
- ix += stride;
+ ix += strideX;
}
if ( i === N ) {
return NaN;
}
i += 1;
for ( i; i < N; i++ ) {
- ix += stride;
- v = clbk.call( thisArg, x[ ix ], i, ix, x );
+ ix += strideX;
+ v = clbk.call( thisArg, get( xbuf, ix ), i, ix, x );
if ( v === void 0 ) {
continue;
}
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/lib/index.js b/lib/node_modules/@stdlib/stats/base/max-by/lib/index.js
index 29304e7b467b..b5c92edef686 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/lib/index.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/lib/index.js
@@ -19,7 +19,7 @@
'use strict';
/**
-* Calculate the maximum value of a strided array via a callback function.
+* Compute the maximum value of a strided array via a callback function.
*
* @module @stdlib/stats/base/max-by
*
@@ -50,11 +50,18 @@
// MODULES //
-var maxBy = require( './main.js' );
+var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'ndarray', ndarray );
// EXPORTS //
-module.exports = maxBy;
+module.exports = main;
-// exports: { "ndarray": "maxBy.ndarray" }
+// exports: { "ndarray": "main.ndarray" }
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/lib/main.js b/lib/node_modules/@stdlib/stats/base/max-by/lib/main.js
index fa380c09009f..3ba2841f9105 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/lib/main.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/lib/main.js
@@ -20,14 +20,35 @@
// MODULES //
-var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
-var maxBy = require( './max_by.js' );
+var stride2offset = require( '@stdlib/strided/base/stride2offset' );
var ndarray = require( './ndarray.js' );
// MAIN //
-setReadOnly( maxBy, 'ndarray', ndarray );
+/**
+* Computes the maximum value of a strided array via a callback function.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Collection} x - input array
+* @param {integer} strideX - index increment
+* @param {Callback} clbk - callback
+* @param {*} [thisArg] - execution context
+* @returns {number} maximum 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 = maxBy( x.length, x, 1, accessor );
+* // returns 8.0
+*/
+function maxBy( N, x, strideX, clbk, thisArg ) {
+ return ndarray( N, x, strideX, stride2offset( N, strideX ), clbk, thisArg );
+}
// EXPORTS //
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/max-by/lib/ndarray.js
index 33b0e651c893..5245d4a46403 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/lib/ndarray.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/lib/ndarray.js
@@ -22,17 +22,19 @@
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
+var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+var accessors = require( './accessors.js' );
// MAIN //
/**
-* Calculates the maximum value of a strided array via a callback function.
+* Computes the maximum value of a strided array via a callback function.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Collection} x - input array/collection
-* @param {integer} stride - index increment
-* @param {NonNegativeInteger} offset - starting index
+* @param {integer} strideX - index increment
+* @param {NonNegativeInteger} offsetX - starting index
* @param {Callback} clbk - callback
* @param {*} [thisArg] - execution context
* @returns {number} maximum value
@@ -47,36 +49,41 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
* var v = maxBy( x.length, x, 1, 0, accessor );
* // returns 8.0
*/
-function maxBy( N, x, stride, offset, clbk, thisArg ) {
+function maxBy( N, x, strideX, offsetX, clbk, thisArg ) {
var max;
var ix;
+ var o;
var v;
var i;
if ( N <= 0 ) {
return NaN;
}
- if ( N === 1 || stride === 0 ) {
- v = clbk.call( thisArg, x[ 0 ], 0, 0, x );
+ o = arraylike2object( x );
+ if ( o.accessorProtocol ) {
+ return accessors( N, o, strideX, offsetX, clbk, thisArg );
+ }
+ if ( N === 1 || strideX === 0 ) {
+ v = clbk.call( thisArg, x[ offsetX ], 0, offsetX, x );
if ( v === void 0 ) {
return NaN;
}
return v;
}
- ix = offset;
+ ix = offsetX;
for ( i = 0; i < N; i++ ) {
max = clbk.call( thisArg, x[ ix ], i, ix, x );
if ( max !== void 0 ) {
break;
}
- ix += stride;
+ ix += strideX;
}
if ( i === N ) {
return NaN;
}
i += 1;
for ( i; i < N; i++ ) {
- ix += stride;
+ ix += strideX;
v = clbk.call( thisArg, x[ ix ], i, ix, x );
if ( v === void 0 ) {
continue;
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/test/test.max_by.js b/lib/node_modules/@stdlib/stats/base/max-by/test/test.max_by.js
index 17ecf49651b9..1fa3a24b8bad 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/test/test.max_by.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/test/test.max_by.js
@@ -21,11 +21,11 @@
// MODULES //
var tape = require( 'tape' );
-var floor = require( '@stdlib/math/base/special/floor' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
+var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var Float64Array = require( '@stdlib/array/float64' );
-var maxBy = require( './../lib/max_by.js' );
+var maxBy = require( './../lib/main.js' );
// FUNCTIONS //
@@ -75,11 +75,11 @@ tape( 'the function calculates the maximum value of a strided array via a callba
v = maxBy( x.length, x, 1, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
- x = new Array( 5 ); // sparse array
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( x.length, x, 1, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
- x = new Array( 5 ); // sparse array
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
x[ 2 ] = 1.0;
v = maxBy( x.length, x, 1, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
@@ -87,6 +87,42 @@ tape( 'the function calculates the maximum value of a strided array via a callba
t.end();
});
+tape( 'the function calculates the maximum value of a strided 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 = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( v, 10.0, 'returns expected value' );
+
+ x = [ -4.0, -5.0 ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( v, -8.0, 'returns expected value' );
+
+ x = [ -0.0, 0.0, -0.0 ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isPositiveZero( v ), true, 'returns expected value' );
+
+ x = [ NaN ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = [ NaN, NaN ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
+ x[ 2 ] = 1.0;
+ v = maxBy( x.length, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) {
var x;
var v;
@@ -102,6 +138,21 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu
t.end();
});
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( 0, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ v = maxBy( -1, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element', function test( t ) {
var x;
var v;
@@ -111,7 +162,7 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
v = maxBy( 1, x, 1, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
- x = new Array( 1 ); // sparse array
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( 1, x, 1, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
@@ -119,8 +170,24 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
t.end();
});
+tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( 1, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
+
+ v = maxBy( 1, toAccessorArray( x ), 1, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function supports a `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -135,15 +202,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
2.0
];
- N = floor( x.length / 2 );
- v = maxBy( N, x, 2, accessor );
+ v = maxBy( 4, x, 2, accessor );
+
+ t.strictEqual( v, 8.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 2.0, // 1
+ -7.0,
+ -2.0, // 2
+ 3.0,
+ 4.0, // 3
+ 2.0
+ ];
+
+ v = maxBy( 4, toAccessorArray( x ), 2, accessor );
t.strictEqual( v, 8.0, 'returns expected value' );
t.end();
});
tape( 'the function supports a negative `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -158,8 +244,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
2.0
];
- N = floor( x.length / 2 );
- v = maxBy( N, x, -2, accessor );
+ v = maxBy( 4, x, -2, accessor );
+
+ t.strictEqual( v, 8.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 3
+ 2.0,
+ 2.0, // 2
+ -7.0,
+ -2.0, // 1
+ 3.0,
+ 4.0, // 0
+ 2.0
+ ];
+
+ v = maxBy( 4, toAccessorArray( x ), -2, accessor );
t.strictEqual( v, 8.0, 'returns expected value' );
t.end();
@@ -174,7 +280,7 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
v = maxBy( x.length, x, 0, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
- x = new Array( 1 ); // sparse array
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( 1, x, 0, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
@@ -182,10 +288,26 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
t.end();
});
+tape( 'if provided a `stride` parameter equal to `0`, the function returns the first accessed element (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( x.length, toAccessorArray( x ), 0, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
+
+ v = maxBy( 1, toAccessorArray( x ), 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function supports view offsets', function test( t ) {
var x0;
var x1;
- var N;
var v;
x0 = new Float64Array([
@@ -201,9 +323,33 @@ tape( 'the function supports view offsets', function test( t ) {
]);
x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
- N = floor(x1.length / 2);
- v = maxBy( N, x1, 2, accessor );
+ v = maxBy( 4, x1, 2, accessor );
+ t.strictEqual( v, 8.0, 'returns expected value' );
+
+ t.end();
+});
+
+tape( 'the function supports view offsets (accessors)', function test( t ) {
+ var x0;
+ var x1;
+ var v;
+
+ x0 = new Float64Array([
+ 2.0,
+ 1.0, // 0
+ 2.0,
+ -2.0, // 1
+ -2.0,
+ 2.0, // 2
+ 3.0,
+ 4.0, // 3
+ 6.0
+ ]);
+
+ x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+ v = maxBy( 4, toAccessorArray( x1 ), 2, accessor );
t.strictEqual( v, 8.0, 'returns expected value' );
t.end();
@@ -227,3 +373,22 @@ tape( 'the function supports providing a callback execution context', function t
return v * 2.0;
}
});
+
+tape( 'the function supports providing a callback execution context (accessors)', function test( t ) {
+ var ctx;
+ var x;
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ ctx = {
+ 'count': 0
+ };
+ maxBy( x.length, toAccessorArray( x ), 1, 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;
+ }
+});
diff --git a/lib/node_modules/@stdlib/stats/base/max-by/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/max-by/test/test.ndarray.js
index 71d780a82fb8..649a6036ef71 100644
--- a/lib/node_modules/@stdlib/stats/base/max-by/test/test.ndarray.js
+++ b/lib/node_modules/@stdlib/stats/base/max-by/test/test.ndarray.js
@@ -21,9 +21,9 @@
// MODULES //
var tape = require( 'tape' );
-var floor = require( '@stdlib/math/base/special/floor' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
+var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var maxBy = require( './../lib/ndarray.js' );
@@ -74,11 +74,11 @@ tape( 'the function calculates the maximum value of a strided array via a callba
v = maxBy( x.length, x, 1, 0, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
- x = new Array( 5 ); // sparse array
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( x.length, x, 1, 0, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
- x = new Array( 5 ); // sparse array
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
x[ 2 ] = 1.0;
v = maxBy( x.length, x, 1, 0, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
@@ -86,6 +86,42 @@ tape( 'the function calculates the maximum value of a strided array via a callba
t.end();
});
+tape( 'the function calculates the maximum value of a strided 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 = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( v, 10.0, 'returns expected value' );
+
+ x = [ -4.0, -5.0 ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( v, -8.0, 'returns expected value' );
+
+ x = [ -0.0, 0.0, -0.0 ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isPositiveZero( v ), true, 'returns expected value' );
+
+ x = [ NaN ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = [ NaN, NaN ];
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array
+ x[ 2 ] = 1.0;
+ v = maxBy( x.length, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) {
var x;
var v;
@@ -101,6 +137,21 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu
t.end();
});
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( 0, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ v = maxBy( -1, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element', function test( t ) {
var x;
var v;
@@ -110,7 +161,7 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
v = maxBy( 1, x, 1, 0, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
- x = new Array( 1 ); // sparse array
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( 1, x, 1, 0, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
@@ -118,8 +169,24 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
t.end();
});
+tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( 1, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
+
+ v = maxBy( 1, toAccessorArray( x ), 1, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function supports a `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -134,15 +201,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
2.0
];
- N = floor( x.length / 2 );
- v = maxBy( N, x, 2, 0, accessor );
+ v = maxBy( 4, x, 2, 0, accessor );
+
+ t.strictEqual( v, 8.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 2.0, // 1
+ -7.0,
+ -2.0, // 2
+ 3.0,
+ 4.0, // 3
+ 2.0
+ ];
+
+ v = maxBy( 4, toAccessorArray( x ), 2, 0, accessor );
t.strictEqual( v, 8.0, 'returns expected value' );
t.end();
});
tape( 'the function supports a negative `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -157,8 +243,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
2.0
];
- N = floor( x.length / 2 );
- v = maxBy( N, x, -2, 6, accessor );
+ v = maxBy( 4, x, -2, 6, accessor );
+
+ t.strictEqual( v, 8.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 3
+ 2.0,
+ 2.0, // 2
+ -7.0,
+ -2.0, // 1
+ 3.0,
+ 4.0, // 0
+ 2.0
+ ];
+
+ v = maxBy( 4, toAccessorArray( x ), -2, 6, accessor );
t.strictEqual( v, 8.0, 'returns expected value' );
t.end();
@@ -173,7 +279,7 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
v = maxBy( x.length, x, 0, 0, accessor );
t.strictEqual( v, 2.0, 'returns expected value' );
- x = new Array( 1 ); // sparse array
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
v = maxBy( 1, x, 0, 0, accessor );
t.strictEqual( isnan( v ), true, 'returns expected value' );
@@ -181,6 +287,23 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
t.end();
});
+tape( 'if provided a `stride` parameter equal to `0`, the function returns the first accessed element (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+ v = maxBy( x.length, toAccessorArray( x ), 0, 0, accessor );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array
+
+ v = maxBy( 1, toAccessorArray( x ), 0, 0, accessor );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function supports an offset parameter', function test( t ) {
var x;
var v;
@@ -200,6 +323,25 @@ tape( 'the function supports an offset parameter', function test( t ) {
t.end();
});
+tape( 'the function supports an offset parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0,
+ -2.0, // 0
+ 3.0,
+ 4.0, // 1
+ 5.0,
+ -6.0 // 2
+ ];
+
+ v = maxBy( 3, toAccessorArray( x ), 2, 1, 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;
@@ -218,3 +360,22 @@ tape( 'the function supports providing a callback execution context', function t
return v * 2.0;
}
});
+
+tape( 'the function supports providing a callback execution context (accessors)', function test( t ) {
+ var ctx;
+ var x;
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ ctx = {
+ 'count': 0
+ };
+ maxBy( x.length, toAccessorArray( x ), 1, 0, 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;
+ }
+});