diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/README.md b/lib/node_modules/@stdlib/stats/base/mskmax/README.md index 4cd8d8b245cf..8a2c4526b889 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/mskmax/README.md @@ -52,20 +52,17 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **strideX**: index increment for `x`. +- **strideX**: stride length for `x`. - **mask**: mask [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation. -- **strideMask**: index increment for `mask`. +- **strideMask**: stride length for `mask`. -The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the maximum value of every other element in `x`, +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the maximum value of every other element in `x`, ```javascript -var floor = require( '@stdlib/math/base/special/floor' ); - var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0 ]; var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ]; -var N = floor( x.length / 2 ); -var v = mskmax( N, x, 2, mask, 2 ); +var v = mskmax( 4, x, 2, mask, 2 ); // returns 4.0 ``` @@ -76,7 +73,6 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t ```javascript var Float64Array = require( '@stdlib/array/float64' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element @@ -84,9 +80,7 @@ var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = mskmax( N, x1, 2, mask1, 2 ); +var v = mskmax( 4, x1, 2, mask1, 2 ); // returns 4.0 ``` @@ -107,16 +101,13 @@ The function has the following additional parameters: - **offsetX**: starting index for `x`. - **offsetMask**: starting index for `mask`. -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 calculate the maximum value for every other value in `x` starting from the second value +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the maximum value for every other value in `x` starting from the second value ```javascript -var floor = require( '@stdlib/math/base/special/floor' ); - var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ]; var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ]; -var N = floor( x.length / 2 ); -var v = mskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = mskmax.ndarray( 4, x, 2, 1, mask, 2, 1 ); // returns 4.0 ``` @@ -130,6 +121,8 @@ var v = mskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - Depending on the environment, the typed versions ([`dmskmax`][@stdlib/stats/base/dmskmax], [`smskmax`][@stdlib/stats/base/smskmax], etc.) are likely to be significantly more performant. +- 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]). + @@ -142,27 +135,18 @@ var v = mskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var mskmax = require( '@stdlib/stats/base/mskmax' ); -var mask; -var x; -var i; - -x = new Float64Array( 10 ); -mask = new Uint8Array( x.length ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - mask[ i ] = 1; - } else { - mask[ i ] = 0; - } - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = uniform( 10, -50.0, 50.0, { + 'dtype': 'float64' +}); console.log( x ); + +var mask = bernoulli( x.length, 0.2, { + 'dtype': 'uint8' +}); console.log( mask ); var v = mskmax( x.length, x, 1, mask, 1 ); @@ -197,6 +181,10 @@ console.log( v ); [mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array + +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor + + [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.js index dd5bf0fa3087..cac5e215f67a 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.js @@ -21,13 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var mskmax = require( './../lib/mskmax.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,20 +46,8 @@ var mskmax = require( './../lib/mskmax.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = []; - mask = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - mask.push( 1 ); - } else { - mask.push( 0 ); - } - x.push( ( randu()*20.0 ) - 10.0 ); - } + var mask = bernoulli( len, 0.2, options ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.ndarray.js index 01f8ebce2869..488be6af62f9 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/benchmark/benchmark.ndarray.js @@ -21,13 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var mskmax = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,20 +46,8 @@ var mskmax = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = []; - mask = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - mask.push( 1 ); - } else { - mask.push( 0 ); - } - x.push( ( randu()*20.0 ) - 10.0 ); - } + var mask = bernoulli( len, 0.2, options ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/mskmax/docs/repl.txt index 021c7c19acd7..5f05ce13813f 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/mskmax/docs/repl.txt @@ -2,8 +2,8 @@ {{alias}}( N, x, strideX, mask, strideMask ) Computes the maximum value of a strided array according to a mask. - The `N` and `stride` parameters determine which elements are accessed at - runtime. + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. Indexing is relative to the first index. To introduce offsets, use a typed array views. @@ -25,13 +25,13 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. mask: Array|TypedArray Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. Returns ------- @@ -46,11 +46,10 @@ > {{alias}}( x.length, x, 1, mask, 1 ) 2.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ]; > mask = [ 0, 0, 0, 0, 0, 0, 1 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, x, 2, mask, 2 ) + > {{alias}}( 3, x, 2, mask, 2 ) 2.0 // Using view offsets: @@ -58,10 +57,10 @@ > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > var mask0 = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1 ] ); > var mask1 = new {{alias:@stdlib/array/uint8}}( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > {{alias}}( N, x1, 2, mask1, 2 ) + > {{alias}}( 3, x1, 2, mask1, 2 ) 2.0 + {{alias}}.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) Computes the maximum value of a strided array according to a mask and using alternative indexing semantics. @@ -79,7 +78,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -88,7 +87,7 @@ Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. offsetMask: integer Starting index for `mask`. @@ -109,8 +108,7 @@ // Using offset parameter: > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ]; > mask = [ 0, 0, 0, 0, 0, 0, 1 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1, mask, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1, mask, 2, 1 ) 2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/index.d.ts index 33cee8d115f0..fcd7a6396036 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/index.d.ts @@ -20,7 +20,12 @@ /// -import { NumericArray } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; /** * Interface describing `mskmax`. @@ -31,9 +36,9 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param mask - mask array - * @param strideMask - `mask` stride length + * @param strideMask - stride length for `mask` * @returns maximum value * * @example @@ -43,17 +48,17 @@ interface Routine { * var v = mskmax( x.length, x, 1, mask, 1 ); * // returns 2.0 */ - ( N: number, x: NumericArray, strideX: number, mask: NumericArray, strideMask: number ): number; + ( N: number, x: InputArray, strideX: number, mask: InputArray, strideMask: number ): number; /** * Computes the maximum value of a strided array according to a mask and using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param offsetX - `x` starting index * @param mask - mask array - * @param strideMask - `mask` stride length + * @param strideMask - stride length for `mask` * @param offsetMask - `mask` starting index * @returns maximum value * @@ -64,7 +69,7 @@ interface Routine { * var v = mskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); * // returns 2.0 */ - ndarray( N: number, x: NumericArray, strideX: number, offsetX: number, mask: NumericArray, strideMask: number, offsetMask: number ): number; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number, mask: InputArray, strideMask: number, offsetMask: number ): number; } /** @@ -72,9 +77,9 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param strideX - `x` stride length +* @param strideX - stride length for `x` * @param mask - mask array -* @param strideMask - `mask` stride length +* @param strideMask - stride length for `mask` * @returns maximum value * * @example diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/test.ts index 9f4b98a1f868..23d95292e5cf 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/mskmax/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import mskmax = require( './index' ); @@ -27,6 +28,7 @@ import mskmax = require( './index' ); const mask = new Uint8Array( 10 ); mskmax( x.length, x, 1, mask, 1 ); // $ExpectType number + mskmax( x.length, new AccessorArray( x ), 1, mask, 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -123,6 +125,7 @@ import mskmax = require( './index' ); const mask = new Uint8Array( 10 ); mskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number + mskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, new AccessorArray( mask ), 1, 0 ); // $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/mskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/mskmax/examples/index.js index 7b6ffb5d7974..184d62eabd46 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/examples/index.js @@ -18,27 +18,18 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var mskmax = require( './../lib' ); -var mask; -var x; -var i; - -x = new Float64Array( 10 ); -mask = new Uint8Array( x.length ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - mask[ i ] = 1; - } else { - mask[ i ] = 0; - } - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = uniform( 10, -50.0, 50.0, { + 'dtype': 'float64' +}); console.log( x ); + +var mask = bernoulli( x.length, 0.2, { + 'dtype': 'uint8' +}); console.log( mask ); var v = mskmax( x.length, x, 1, mask, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/mskmax/lib/accessors.js new file mode 100644 index 000000000000..ef34ff006cf4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/mskmax/lib/accessors.js @@ -0,0 +1,115 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); + + +// MAIN // + +/** +* Computes the maximum value of a strided array according to a mask. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @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 for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Object} mask - mask array object +* @param {Collection} mask.data - mask array data +* @param {Array} mask.accessors - mask element accessors +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` +* @returns {Object} output maximum value +* +* @example +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* +* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; +* var mask = [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ]; +* +* var v = mskmax( 5, arraylike2object( toAccessorArray( x ) ), 2, 1, arraylike2object( toAccessorArray( mask ) ), 2, 1 ); +* // returns 4.0 +*/ +function mskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + var xbuf; + var mbuf; + var xget; + var mget; + var max; + var ix; + var im; + var v; + var i; + + // Cache references to array data: + xbuf = x.data; + mbuf = mask.data; + + // Cache references to element accessors: + xget = x.accessors[ 0 ]; + mget = mask.accessors[ 0 ]; + + if ( N <= 0 ) { + return NaN; + } + ix = offsetX; + im = offsetMask; + for ( i = 0; i < N; i++ ) { + if ( mget( mbuf, im ) === 0 ) { + break; + } + ix += strideX; + im += strideMask; + } + if ( i === N ) { + return NaN; + } + max = xget( xbuf, ix ); + if ( isnan( max ) ) { + return max; + } + i += 1; + for ( i; i < N; i++ ) { + ix += strideX; + im += strideMask; + if ( mget( mbuf, im ) ) { + continue; + } + v = xget( xbuf, ix ); + if ( isnan( v ) ) { + return v; + } + if ( v > max || ( v === max && isPositiveZero( v ) ) ) { + max = v; + } + } + return max; +} + + +// EXPORTS // + +module.exports = mskmax; diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/lib/mskmax.js b/lib/node_modules/@stdlib/stats/base/mskmax/lib/mskmax.js index 890845a89f0e..840a17e22ec3 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/lib/mskmax.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/lib/mskmax.js @@ -20,8 +20,8 @@ // MODULES // -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -44,55 +44,7 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); * // returns 2.0 */ function mskmax( N, x, strideX, mask, strideMask ) { - var max; - var ix; - var im; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( strideX < 0 ) { - ix = (1-N) * strideX; - } else { - ix = 0; - } - if ( strideMask < 0 ) { - im = (1-N) * strideMask; - } else { - im = 0; - } - for ( i = 0; i < N; i++ ) { - if ( mask[ im ] === 0 ) { - break; - } - ix += strideX; - im += strideMask; - } - if ( i === N ) { - return NaN; - } - max = x[ ix ]; - if ( isnan( max ) ) { - return max; - } - i += 1; - for ( i; i < N; i++ ) { - ix += strideX; - im += strideMask; - if ( mask[ im ] ) { - continue; - } - v = x[ ix ]; - if ( isnan( v ) ) { - return v; - } - if ( v > max || ( v === max && isPositiveZero( v ) ) ) { - max = v; - } - } - return max; + return ndarray( N, x, strideX, stride2offset( N, strideX ), mask, strideMask, stride2offset( N, strideMask ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/mskmax/lib/ndarray.js index cab6d678a276..1badcc70d2b5 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/lib/ndarray.js @@ -22,6 +22,8 @@ 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 // @@ -31,33 +33,37 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - input array -* @param {integer} strideX - `x` stride length -* @param {NonNegativeInteger} offsetX - `x` starting index +* @param {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` * @param {NumericArray} mask - mask array -* @param {integer} strideMask - `mask` stride length -* @param {NonNegativeInteger} offsetMask - `mask` starting index +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` * @returns {number} maximum value * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); -* * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; * var mask = [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ]; -* var N = floor( x.length / 2 ); * -* var v = mskmax( N, x, 2, 1, mask, 2, 1 ); +* var v = mskmax( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ function mskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { var max; var ix; var im; + var ox; + var om; var v; var i; if ( N <= 0 ) { return NaN; } + ox = arraylike2object( x ); + om = arraylike2object( mask ); + if ( ox.accessorProtocol || om.accessorProtocol ) { + return accessors( N, ox, strideX, offsetX, om, strideMask, offsetMask ); + } ix = offsetX; im = offsetMask; for ( i = 0; i < N; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/test/test.mskmax.js b/lib/node_modules/@stdlib/stats/base/mskmax/test/test.mskmax.js index a9996fc514a7..74fbddf6ed46 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/test/test.mskmax.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/test/test.mskmax.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float64Array = require( '@stdlib/array/float64' ); var Uint8Array = require( '@stdlib/array/uint8' ); @@ -100,6 +100,64 @@ tape( 'the function calculates the maximum value of a strided array according to t.end(); }); +tape( 'the function calculates the maximum value of a strided array according to a mask (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ]; + mask = [ 0, 0, 0, 1, 0, 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ -4.0, 0.0, NaN, 5.0 ]; + mask = [ 0, 0, 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, '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 mask; var x; @@ -133,7 +191,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -162,8 +219,43 @@ tape( 'the function supports `stride` parameters', function test( t ) { 1 ]; - N = floor( x.length / 2 ); - v = mskmax( N, x, 2, mask, 2 ); + v = mskmax( 5, x, 2, mask, 2 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessor)', function test( t ) { + var mask; + 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, + 5.0, // 4 + 6.0 + ]; + mask = [ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1 + ]; + + v = mskmax( 5, toAccessorArray( x ), 2, toAccessorArray( mask ), 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -171,7 +263,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -200,8 +291,43 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = mskmax( N, x, -2, mask, -2 ); + v = mskmax( 5, x, -2, mask, -2 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ + 5.0, // 4 + 6.0, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + mask = [ + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = mskmax( 5, toAccessorArray( x ), -2, toAccessorArray( mask ), -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -212,7 +338,6 @@ tape( 'the function supports view offsets', function test( t ) { var mask1; var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -244,9 +369,51 @@ tape( 'the function supports view offsets', function test( t ) { x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor( x1.length/2 ); - v = mskmax( N, x1, 2, mask1, 2 ); + v = mskmax( 5, x1, 2, mask1, 2 ); + t.strictEqual( v, 4.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessor)', function test( t ) { + var mask0; + var mask1; + 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, + 5.0, // 4 + 6.0 + ]); + mask0 = new Uint8Array([ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = mskmax( 5, toAccessorArray( x1 ), 2, toAccessorArray( mask1 ), 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/mskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/mskmax/test/test.ndarray.js index 7eac296b1bac..45bb7d89a4dd 100644 --- a/lib/node_modules/@stdlib/stats/base/mskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mskmax/test/test.ndarray.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var mskmax = require( './../lib/ndarray.js' ); @@ -98,6 +98,64 @@ tape( 'the function calculates the maximum value of a strided array according to t.end(); }); +tape( 'the function calculates the maximum value of a strided array according to a mask (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ]; + mask = [ 0, 0, 0, 1, 0, 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ -4.0, 0.0, NaN, 5.0 ]; + mask = [ 0, 0, 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = mskmax( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, '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 mask; var x; @@ -131,7 +189,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -160,8 +217,43 @@ tape( 'the function supports `stride` parameters', function test( t ) { 1 ]; - N = floor( x.length / 2 ); - v = mskmax( N, x, 2, 0, mask, 2, 0 ); + v = mskmax( 5, x, 2, 0, mask, 2, 0 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessor)', function test( t ) { + var mask; + 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, + 5.0, // 4 + 6.0 + ]; + mask = [ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1 + ]; + + v = mskmax( 5, toAccessorArray( x ), 2, 0, toAccessorArray( mask ), 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -169,7 +261,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -198,8 +289,43 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = mskmax( N, x, -2, 8, mask, -2, 8 ); + v = mskmax( 5, x, -2, 8, mask, -2, 8 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ + 5.0, // 4 + 6.0, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + mask = [ + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = mskmax( 5, toAccessorArray( x ), -2, 8, toAccessorArray( mask ), -2, 8 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -207,7 +333,6 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { tape( 'the function supports `offset` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -235,9 +360,44 @@ tape( 'the function supports `offset` parameters', function test( t ) { 1, 1 // 4 ]; - N = floor( x.length / 2 ); - v = mskmax( N, x, 2, 1, mask, 2, 1 ); + v = mskmax( 5, x, 2, 1, mask, 2, 1 ); + t.strictEqual( v, 4.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `offset` parameters (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 5.0, + 6.0 // 4 + ]; + mask = [ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 1, + 1 // 4 + ]; + + v = mskmax( 5, toAccessorArray( x ), 2, 1, toAccessorArray( mask ), 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end();