From fae5a4e745b6412546ffcb03be63dd8376d4d3be Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Tue, 18 Mar 2025 19:57:22 +0000 Subject: [PATCH 01/19] feat: add accessor protocol and refactor stats/base/nanmskmax --- 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: 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/base/nanmskmax/README.md | 65 ++---- .../base/nanmskmax/benchmark/benchmark.js | 26 +-- .../nanmskmax/benchmark/benchmark.ndarray.js | 26 +-- .../stats/base/nanmskmax/docs/repl.txt | 26 ++- .../base/nanmskmax/docs/types/index.d.ts | 23 +- .../stats/base/nanmskmax/docs/types/test.ts | 5 +- .../stats/base/nanmskmax/examples/index.js | 31 +-- .../stats/base/nanmskmax/lib/accessors.js | 109 ++++++++++ .../stats/base/nanmskmax/lib/nanmskmax.js | 54 +---- .../stats/base/nanmskmax/lib/ndarray.js | 22 +- .../base/nanmskmax/test/test.nanmskmax.js | 199 +++++++++++++++++- .../stats/base/nanmskmax/test/test.ndarray.js | 198 ++++++++++++++++- 12 files changed, 588 insertions(+), 196 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index 80f9a8825e57..c3e0c0627cef 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -44,7 +44,7 @@ Computes the maximum value of a strided array `x` according to a `mask`, ignorin var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; var mask = [ 0, 0, 1, 0, 0 ]; -var v = nanmskmax( x.length, x, 1, mask, 1 ); +var v = nanmskmax( 5, x, 1, mask, 1 ); // returns 2.0 ``` @@ -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 int 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 = nanmskmax( N, x, 2, mask, 2 ); +var v = nanmskmax( 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 = nanmskmax( N, x1, 2, mask1, 2 ); +var v = nanmskmax( 4, x1, 2, mask1, 2 ); // returns 4.0 ``` @@ -98,7 +92,7 @@ Computes the maximum value of a strided array according to a `mask`, ignoring `N var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; var mask = [ 0, 0, 1, 0, 0 ]; -var v = nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); +var v = nanmskmax.ndarray( 5, x, 1, 0, mask, 1, 0 ); // returns 2.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 a 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 x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ]; +var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ]; -var v = nanmskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = nanmskmax.ndarray( 5, x, 2, 1, mask, 2, 1 ); // returns 4.0 ``` @@ -130,6 +121,7 @@ var v = nanmskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - Depending on the environment, the typed versions ([`dnanmskmax`][@stdlib/stats/base/dnanmskmax], [`snanmskmax`][@stdlib/stats/base/snanmskmax], 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,31 +134,18 @@ var v = nanmskmax.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 nanmskmax = require( '@stdlib/stats/base/nanmskmax' ); -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; - } - if ( randu() < 0.1 ) { - x[ i ] = NaN; - } else { - 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 = nanmskmax( x.length, x, 1, mask, 1 ); @@ -215,6 +194,8 @@ console.log( v ); [@stdlib/stats/base/snanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmskmax +[@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/base/nanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js index 3c20c49e8410..d8b65f682268 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js @@ -21,13 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var nanmskmax = require( './../lib/nanmskmax.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,20 +46,8 @@ var nanmskmax = require( './../lib/nanmskmax.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/nanmskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js index 3e90c0f9c003..86ddb8cf5250 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js @@ -21,13 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var nanmskmax = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,20 +46,8 @@ var nanmskmax = 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/nanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt index a729dc9b93b7..8a52f705a782 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt @@ -3,8 +3,8 @@ Computes the maximum value of a strided array according to a mask and ignoring `NaN` values. - 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. @@ -26,13 +26,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 ------- @@ -47,11 +47,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: @@ -59,10 +58,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, ignoring `NaN` values and using alternative indexing semantics. @@ -80,7 +79,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -89,7 +88,7 @@ Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. offsetMask: integer Starting index for `mask`. @@ -104,14 +103,13 @@ // Standard Usage: > var x = [ 1.0, -2.0, 2.0, 4.0, NaN ]; > var mask = [ 0, 0, 0, 1, 0 ]; - > {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 ) + > {{alias}}.ndarray( 5, x, 1, 0, mask, 1, 0 ) 2.0 // 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/nanmskmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/index.d.ts index 4fc274500b05..3c679e916a03 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/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 `nanmskmax`. @@ -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 = nanmskmax( 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, ignoring `NaN` values 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 = nanmskmax.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/nanmskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts index 44dda91afe96..908251d8a1f6 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanmskmax = require( './index' ); @@ -26,7 +27,7 @@ import nanmskmax = require( './index' ); const x = new Float64Array( 10 ); const mask = new Uint8Array( 10 ); - nanmskmax( x.length, x, 1, mask, 1 ); // $ExpectType number + nanmskmax( 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... @@ -122,7 +123,7 @@ import nanmskmax = require( './index' ); const x = new Float64Array( 10 ); const mask = new Uint8Array( 10 ); - nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number + nanmskmax.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/nanmskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js index cc3b2bd343cb..2aad2fa6092d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js @@ -18,31 +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 nanmskmax = 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; - } - if ( randu() < 0.1 ) { - x[ i ] = NaN; - } else { - 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 = nanmskmax( x.length, x, 1, mask, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js new file mode 100644 index 000000000000..9c5035122e06 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js @@ -0,0 +1,109 @@ +/** +* @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, ignoring `NaN` values. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Object} x - input array object +* @param {Collection} x.data - input array data +* @param {Array} x.accessors - input array element accessor +* @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 array element accessor +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` +* @returns {number} maximum value +* +* @example +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var mask = toAccessorArray( [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ] ); +* +* var v = nanmskmax( 5, arraylike2object( x ), 2, 1, arraylike2object( mask ), 2, 1 ); +* // returns 4.0 +*/ +function nanmskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + var xbuf; + var xget; + var mbuf; + 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 ]; + + ix = offsetX; + im = offsetMask; + for ( i = 0; i < N; i++ ) { + v = xget( xbuf, ix ); + if ( v === v && mget( mbuf, im ) === 0 ) { + break; + } + ix += strideX; + im += strideMask; + } + if ( i === N ) { + return NaN; + } + max = v; + i += 1; + for ( i; i < N; i++ ) { + ix += strideX; + im += strideMask; + if ( mget( mbuf, im ) ) { + continue; + } + v = xget( xbuf, ix ); + if ( isnan( v ) ) { + continue; + } + if ( v > max || ( v === max && isPositiveZero( v ) ) ) { + max = v; + } + } + return max; +} + + +// EXPORTS // + +module.exports = nanmskmax; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js index 1f56acde9903..eb46efe8c803 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.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,53 +44,9 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); * // returns 2.0 */ function nanmskmax( 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++ ) { - v = x[ ix ]; - if ( v === v && mask[ im ] === 0 ) { - break; - } - ix += strideX; - im += strideMask; - } - if ( i === N ) { - return NaN; - } - max = v; - i += 1; - for ( i; i < N; i++ ) { - ix += strideX; - im += strideMask; - if ( mask[ im ] ) { - continue; - } - v = x[ ix ]; - if ( isnan( v ) ) { - continue; - } - if ( v > max || ( v === max && isPositiveZero( v ) ) ) { - max = v; - } - } - return max; + var offsetMask = stride2offset( N, strideMask ); + var offsetX = stride2offset( N, strideX ); + return ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); } diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/ndarray.js index d8384e0b01dd..ec09a7fe54e0 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/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 = nanmskmax( N, x, 2, 1, mask, 2, 1 ); +* var v = nanmskmax( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ function nanmskmax( 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/nanmskmax/test/test.nanmskmax.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js index 66eadb2a43d2..6b43e95723a9 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js @@ -21,7 +21,7 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -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, ignoring NaN values (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); + mask = toAccessorArray( [ 0, 0, 0, 1, 0, 0, 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = toAccessorArray( [ -4.0, NaN, -5.0 ] ); + mask = toAccessorArray( [ 0, 1, 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = toAccessorArray( [ -0.0, 0.0, NaN, -0.0 ] ); + mask = toAccessorArray( [ 0, 0, 1, 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ -4.0, 0.0, NaN, 5.0 ] ); + mask = toAccessorArray( [ 0, 0, 0, 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = toAccessorArray( [ NaN ] ); + mask = toAccessorArray( [ 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN ] ); + mask = toAccessorArray( [ 1 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 1, 1 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 1, 0 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 0, 1 ] ); + v = nanmskmax( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 0, 0 ] ); + v = nanmskmax( x.length, x, 1, 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; @@ -166,8 +223,47 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmax( N, x, 2, mask, 2 ); + v = nanmskmax( 6, x, 2, mask, 2 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessors)', 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, + NaN, // 5 + NaN + ]; + mask = [ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1, + 0, // 5 + 0 + ]; + + v = nanmskmax( 6, toAccessorArray( x ), 2, toAccessorArray( mask ), 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -175,7 +271,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; @@ -208,8 +303,47 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmax( N, x, -2, mask, -2 ); + v = nanmskmax( 6, x, -2, mask, -2 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ + NaN, // 5 + NaN, + 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 = [ + 0, // 5 + 0, + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = nanmskmax( 6, toAccessorArray( x ), -2, toAccessorArray( mask ), -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -220,7 +354,6 @@ tape( 'the function supports view offsets', function test( t ) { var mask1; var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -256,9 +389,55 @@ 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 = nanmskmax( N, x1, 2, mask1, 2 ); + v = nanmskmax( 6, x1, 2, mask1, 2 ); + t.strictEqual( v, 4.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessors)', 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, + NaN, // 5 + NaN + ]); + mask0 = new Uint8Array([ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1, + 0, // 5 + 0 + ]); + + 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 = nanmskmax( 6, 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/nanmskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js index 69996b73e54f..6394c080653c 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js @@ -21,7 +21,7 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var nanmskmax = 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, ignoring NaN values (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); + mask = toAccessorArray( [ 0, 0, 0, 1, 0, 0, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = toAccessorArray( [ -4.0, NaN, -5.0 ] ); + mask = toAccessorArray( [ 0, 1, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = toAccessorArray( [ -0.0, 0.0, NaN, -0.0 ] ); + mask = toAccessorArray( [ 0, 0, 1, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ -4.0, 0.0, NaN, 5.0 ] ); + mask = toAccessorArray( [ 0, 0, 0, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = toAccessorArray( [ NaN ] ); + mask = toAccessorArray( [ 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN ] ); + mask = toAccessorArray( [ 1 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 1, 1 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 1, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 0, 1 ] ); + v = nanmskmax( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = toAccessorArray( [ NaN, NaN ] ); + mask = toAccessorArray( [ 0, 0 ] ); + v = nanmskmax( x.length, x, 1, 0, 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; @@ -164,8 +221,89 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmax( N, x, 2, 0, mask, 2, 0 ); + v = nanmskmax( 5, x, 2, 0, mask, 2, 0 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessors)', 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, + NaN, // 5 + NaN + ]; + mask = [ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1, + 0, // 5 + 0 + ]; + + x = toAccessorArray( x ); + + v = nanmskmax( 5, x, 2, 0, toAccessorArray( mask ), 2, 0 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', function test( t ) { + var mask; + var x; + var v; + + x = [ + NaN, // 5 + NaN, + 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 = [ + 0, // 5 + 0, + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = nanmskmax( 5, x, -2, 10, mask, -2, 10 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -173,7 +311,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; @@ -206,16 +343,56 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmax( N, x, -2, 10, mask, -2, 10 ); + x = toAccessorArray( x ); + + v = nanmskmax( 5, x, -2, 10, toAccessorArray( mask ), -2, 10 ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `offset` parameters', 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 + NaN, + NaN // 5 + ]; + mask = [ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 1, + 1, // 4 + 0, + 0 // 5 + ]; + + v = nanmskmax( 5, x, 2, 1, mask, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); }); tape( 'the function supports `offset` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -247,9 +424,10 @@ tape( 'the function supports `offset` parameters', function test( t ) { 0, 0 // 5 ]; - N = floor( x.length / 2 ); - v = nanmskmax( N, x, 2, 1, mask, 2, 1 ); + x = toAccessorArray( x ); + + v = nanmskmax( 5, x, 2, 1, toAccessorArray( mask ), 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); From 644c8d4201b89b5455c0b4d8405ac1b3617bdfe1 Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Sun, 6 Apr 2025 19:21:37 +0000 Subject: [PATCH 02/19] refactor: refactored lib folder's file to align with existing style --- 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: 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: na - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmskmax/README.md | 16 +++--- .../base/nanmskmax/benchmark/benchmark.js | 2 +- .../stats/base/nanmskmax/docs/repl.txt | 8 +-- .../stats/base/nanmskmax/docs/types/test.ts | 2 + .../@stdlib/stats/base/nanmskmax/lib/index.js | 13 +++-- .../@stdlib/stats/base/nanmskmax/lib/main.js | 28 +++++++++- .../stats/base/nanmskmax/lib/nanmskmax.js | 55 ------------------- .../test/{test.nanmskmax.js => test.main.js} | 2 +- .../stats/base/nanmskmax/test/test.ndarray.js | 12 ++-- 9 files changed, 56 insertions(+), 82 deletions(-) delete mode 100644 lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js rename lib/node_modules/@stdlib/stats/base/nanmskmax/test/{test.nanmskmax.js => test.main.js} (99%) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index c3e0c0627cef..b4f67b9bd90b 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -56,31 +56,31 @@ The function has the following parameters: - **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**: stride length for `mask`. -The `N` and stride parameters determine which elements int the strided arrays 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 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 x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0, NaN, NaN ]; +var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 1, 1 ]; -var v = nanmskmax( 4, x, 2, mask, 2 ); +var v = nanmskmax( 5, x, 2, mask, 2 ); // returns 4.0 ``` Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views. - + ```javascript var Float64Array = require( '@stdlib/array/float64' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); +var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1, 1, 1 ] ); var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var v = nanmskmax( 4, x1, 2, mask1, 2 ); +var v = nanmskmax( 5, x1, 2, mask1, 2 ); // returns 4.0 ``` diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js index d8b65f682268..05ad43d4a7f0 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js @@ -26,7 +26,7 @@ var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; -var nanmskmax = require( './../lib/nanmskmax.js' ); +var nanmskmax = require( './../lib/main.js' ); // VARIABLES // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt index 8a52f705a782..dc8266d2eddb 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt @@ -44,7 +44,7 @@ // Standard Usage: > var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; > var mask = [ 0, 0, 1, 0, 0 ]; - > {{alias}}( x.length, x, 1, mask, 1 ) + > {{alias}}( 5, x, 1, mask, 1 ) 2.0 // Using `N` and stride parameters: @@ -107,9 +107,9 @@ 2.0 // 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 ]; - > {{alias}}.ndarray( 3, x, 2, 1, mask, 2, 1 ) + > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0, NaN, NaN ]; + > mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 1 ]; + > {{alias}}.ndarray( 4, x, 2, 1, mask, 2, 1 ) 2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts index 908251d8a1f6..b3cf9a9d760f 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts @@ -27,6 +27,7 @@ import nanmskmax = require( './index' ); const x = new Float64Array( 10 ); const mask = new Uint8Array( 10 ); + nanmskmax( x.length, x, 1, mask, 1 ); // $ExpectType number nanmskmax( x.length, new AccessorArray( x ), 1, mask, 1 ); // $ExpectType number } @@ -123,6 +124,7 @@ import nanmskmax = require( './index' ); const x = new Float64Array( 10 ); const mask = new Uint8Array( 10 ); + nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number nanmskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, new AccessorArray( mask ), 1, 0 ); // $ExpectType number } diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js index 71c9bf768eda..652e68be97c7 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js @@ -29,24 +29,29 @@ * var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; * var mask = [ 0, 0, 1, 0, 0 ]; * -* var v = nanmskmax( x.length, x, 1 ); +* var v = nanmskmax( 5, x, 1 ); * // returns 2.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanmskmax = require( '@stdlib/stats/base/nanmskmax' ); * * 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 = nanmskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); +* var v = nanmskmax.ndarray( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ // MODULES // +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 // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js index 7288b7bc3bbd..628ea5aceb32 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js @@ -20,14 +20,36 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanmskmax = require( './nanmskmax.js' ); +// MODULES // + +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanmskmax, 'ndarray', ndarray ); +/** +* Computes the maximum value of a strided array according to a mask, ignoring `NaN` values. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - `x` stride length +* @param {NumericArray} mask - mask array +* @param {integer} strideMask - `mask` stride length +* @returns {number} maximum value +* +* @example +* var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; +* var mask = [ 0, 0, 1, 0, 0 ]; +* +* var v = nanmskmax( 5, x, 1, mask, 1 ); +* // returns 2.0 +*/ +function nanmskmax( N, x, strideX, mask, strideMask ) { + var offsetMask = stride2offset( N, strideMask ); + var offsetX = stride2offset( N, strideX ); + return ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js deleted file mode 100644 index eb46efe8c803..000000000000 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/nanmskmax.js +++ /dev/null @@ -1,55 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); -var ndarray = require( './ndarray.js' ); - - -// MAIN // - -/** -* Computes the maximum value of a strided array according to a mask, ignoring `NaN` values. -* -* @param {PositiveInteger} N - number of indexed elements -* @param {NumericArray} x - input array -* @param {integer} strideX - `x` stride length -* @param {NumericArray} mask - mask array -* @param {integer} strideMask - `mask` stride length -* @returns {number} maximum value -* -* @example -* var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; -* var mask = [ 0, 0, 1, 0, 0 ]; -* -* var v = nanmskmax( x.length, x, 1, mask, 1 ); -* // returns 2.0 -*/ -function nanmskmax( N, x, strideX, mask, strideMask ) { - var offsetMask = stride2offset( N, strideMask ); - var offsetX = stride2offset( N, strideX ); - return ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); -} - - -// EXPORTS // - -module.exports = nanmskmax; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js similarity index 99% rename from lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js rename to lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js index 6b43e95723a9..f6fad23752fa 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.nanmskmax.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js @@ -26,7 +26,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float64Array = require( '@stdlib/array/float64' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var nanmskmax = require( './../lib/nanmskmax.js' ); +var nanmskmax = require( './../lib/main.js' ); // TESTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js index 6394c080653c..6c26e4e5f815 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js @@ -221,7 +221,7 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0 ]; - v = nanmskmax( 5, x, 2, 0, mask, 2, 0 ); + v = nanmskmax( 6, x, 2, 0, mask, 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -263,7 +263,7 @@ tape( 'the function supports `stride` parameters (accessors)', function test( t x = toAccessorArray( x ); - v = nanmskmax( 5, x, 2, 0, toAccessorArray( mask ), 2, 0 ); + v = nanmskmax( 6, x, 2, 0, toAccessorArray( mask ), 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -303,7 +303,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - v = nanmskmax( 5, x, -2, 10, mask, -2, 10 ); + v = nanmskmax( 6, x, -2, 10, mask, -2, 10 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -345,7 +345,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { x = toAccessorArray( x ); - v = nanmskmax( 5, x, -2, 10, toAccessorArray( mask ), -2, 10 ); + v = nanmskmax( 6, x, -2, 10, toAccessorArray( mask ), -2, 10 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -385,7 +385,7 @@ tape( 'the function supports `offset` parameters', function test( t ) { 0 // 5 ]; - v = nanmskmax( 5, x, 2, 1, mask, 2, 1 ); + v = nanmskmax( 6, x, 2, 1, mask, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -427,7 +427,7 @@ tape( 'the function supports `offset` parameters', function test( t ) { x = toAccessorArray( x ); - v = nanmskmax( 5, x, 2, 1, toAccessorArray( mask ), 2, 1 ); + v = nanmskmax( 6, x, 2, 1, toAccessorArray( mask ), 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); From 32243fd78dfa82c4e355deaf5763c17d846dd098 Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Tue, 8 Apr 2025 14:22:52 +0000 Subject: [PATCH 03/19] docs: update test description for better clearity --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmskmax/test/test.ndarray.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js index 6c26e4e5f815..ebb08347c211 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js @@ -309,7 +309,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { t.end(); }); -tape( 'the function supports negative `stride` parameters', function test( t ) { +tape( 'the function supports negative `stride` parameters (accessors)', function test( t ) { var mask; var x; var v; @@ -391,7 +391,7 @@ tape( 'the function supports `offset` parameters', function test( t ) { t.end(); }); -tape( 'the function supports `offset` parameters', function test( t ) { +tape( 'the function supports `offset` parameters (accessors)', function test( t ) { var mask; var x; var v; From f313044d487f737d27e83e4047a3a73412307a4e Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 12:50:54 +0000 Subject: [PATCH 04/19] docs: update README for clarity and formatting --- 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: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmskmax/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index 954324651dde..fe87434e3c27 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -38,13 +38,13 @@ var nanmskmax = require( '@stdlib/stats/base/nanmskmax' ); #### nanmskmax( N, x, strideX, mask, strideMask ) -Computes the maximum value of a strided array `x` according to a `mask`, ignoring `NaN` values. +Computes the maximum value of a strided array according to a `mask`, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; var mask = [ 0, 0, 1, 0, 0 ]; -var v = nanmskmax( 5, x, 1, mask, 1 ); +var v = nanmskmax( x.length, x, 1, mask, 1 ); // returns 2.0 ``` @@ -92,7 +92,7 @@ Computes the maximum value of a strided array according to a `mask`, ignoring `N var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; var mask = [ 0, 0, 1, 0, 0 ]; -var v = nanmskmax.ndarray( 5, x, 1, 0, mask, 1, 0 ); +var v = nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // returns 2.0 ``` @@ -101,7 +101,7 @@ 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 parameters support indexing semantics based on a starting indices. 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 parameter support indexing semantics based on a starting indices. For example, to calculate the maximum value for every other element in `x` starting from the second element ```javascript var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ]; @@ -182,6 +182,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/dnanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmax @@ -194,8 +196,6 @@ console.log( v ); [@stdlib/stats/strided/snanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskmax -[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor - From 905e2cde38fa0444012b7f9689124e3bd2074e92 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 13:04:43 +0000 Subject: [PATCH 05/19] docs: update benchmark files for consistency and clarity --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmskmax/benchmark/benchmark.js | 7 +++++-- .../stats/base/nanmskmax/benchmark/benchmark.ndarray.js | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js index 05ad43d4a7f0..cc0689829558 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js @@ -46,8 +46,11 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = bernoulli( len, 0.2, options ); - var x = uniform( len, -10.0, 10.0, options ); + var mask; + var x; + + mask = bernoulli( len, 0.2, options ); + x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js index 86ddb8cf5250..361ecd32ddbf 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js @@ -46,8 +46,11 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = bernoulli( len, 0.2, options ); - var x = uniform( len, -10.0, 10.0, options ); + var mask; + var x; + + mask = bernoulli( len, 0.2, options ); + x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { From e4f37ed4d072b3fd012016725d813b800114d1d3 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 13:10:02 +0000 Subject: [PATCH 06/19] fix: update example usage --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js | 2 +- lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js index 652e68be97c7..3185c9183315 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; * var mask = [ 0, 0, 1, 0, 0 ]; * -* var v = nanmskmax( 5, x, 1 ); +* var v = nanmskmax( x.length, x, 1 ); * // returns 2.0 * * @example diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js index 628ea5aceb32..eb46efe8c803 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/main.js @@ -20,8 +20,6 @@ // MODULES // -// MODULES // - var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); @@ -42,7 +40,7 @@ var ndarray = require( './ndarray.js' ); * var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; * var mask = [ 0, 0, 1, 0, 0 ]; * -* var v = nanmskmax( 5, x, 1, mask, 1 ); +* var v = nanmskmax( x.length, x, 1, mask, 1 ); * // returns 2.0 */ function nanmskmax( N, x, strideX, mask, strideMask ) { From 14a6e06e89067f2950e707a460ea085ee49f14fc Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 13:15:05 +0000 Subject: [PATCH 07/19] docs: update documentation for nanmskmax function --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt | 6 +++--- .../@stdlib/stats/base/nanmskmax/docs/types/test.ts | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt index dc8266d2eddb..6d55d5bb2562 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt @@ -3,7 +3,7 @@ Computes the maximum value of a strided array according to a mask and ignoring `NaN` values. - The `N` and stride parameters determine which elements in the strided arrays + 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 offsets, use a typed @@ -44,7 +44,7 @@ // Standard Usage: > var x = [ 1.0, -2.0, 4.0, 2.0, NaN ]; > var mask = [ 0, 0, 1, 0, 0 ]; - > {{alias}}( 5, x, 1, mask, 1 ) + > {{alias}}( x.length, x, 1, mask, 1 ) 2.0 // Using `N` and stride parameters: @@ -103,7 +103,7 @@ // Standard Usage: > var x = [ 1.0, -2.0, 2.0, 4.0, NaN ]; > var mask = [ 0, 0, 0, 1, 0 ]; - > {{alias}}.ndarray( 5, x, 1, 0, mask, 1, 0 ) + > {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 ) 2.0 // Using offset parameter: diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts index b3cf9a9d760f..a6fd2845f9ae 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts @@ -125,7 +125,7 @@ import nanmskmax = require( './index' ); const mask = new Uint8Array( 10 ); nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number - nanmskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, new AccessorArray( mask ), 1, 0 ); // $ExpectType number + nanmskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, mask, 1, 0 ); // $ExpectType number } // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... From 22bcdb07ab7105b278b2d46e19c3ad415d762747 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 13:18:46 +0000 Subject: [PATCH 08/19] test: fix accessor test cases --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/nanmskmax/test/test.main.js | 31 +++++++++++++ .../stats/base/nanmskmax/test/test.ndarray.js | 43 +++++++++++++++---- 2 files changed, 65 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js index f6fad23752fa..2165915aa045 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js @@ -175,6 +175,23 @@ 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 mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + mask = toAccessorArray( [ 0.0, 0.0 ] ); + + v = nanmskmax( 0, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmskmax( -1, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { var mask; var x; @@ -189,6 +206,20 @@ 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 element (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + mask = toAccessorArray( [ 0.0, 0.0 ] ); + + v = nanmskmax( 1, x, 1, mask, 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports `stride` parameters', function test( t ) { var mask; var x; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js index 708405d6f862..b8f442bf7c50 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js @@ -173,6 +173,23 @@ 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 mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + mask = toAccessorArray( [ 0.0, 0.0 ] ); + + v = nanmskmax( 0, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmskmax( -1, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { var mask; var x; @@ -187,6 +204,20 @@ 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 element (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + mask = toAccessorArray( [ 0.0, 0.0 ] ); + + v = nanmskmax( 1, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports `stride` parameters', function test( t ) { var mask; var x; @@ -261,9 +292,7 @@ tape( 'the function supports `stride` parameters (accessors)', function test( t 0 ]; - x = toAccessorArray( x ); - - v = nanmskmax( 6, x, 2, 0, toAccessorArray( mask ), 2, 0 ); + v = nanmskmax( 6, toAccessorArray( x ), 2, 0, toAccessorArray( mask ), 2, 0 ); // eslint-disable-line max-len t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -343,9 +372,7 @@ tape( 'the function supports negative `stride` parameters (accessors)', function 0 ]; - x = toAccessorArray( x ); - - v = nanmskmax( 6, x, -2, 10, toAccessorArray( mask ), -2, 10 ); + v = nanmskmax( 6, toAccessorArray( x ), -2, 10, toAccessorArray( mask ), -2, 10 ); // eslint-disable-line max-len t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -425,9 +452,7 @@ tape( 'the function supports `offset` parameters (accessors)', function test( t 0 // 5 ]; - x = toAccessorArray( x ); - - v = nanmskmax( 6, x, 2, 1, toAccessorArray( mask ), 2, 1 ); + v = nanmskmax( 6, toAccessorArray( x ), 2, 1, toAccessorArray( mask ), 2, 1 ); // eslint-disable-line max-len t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); From 80dd4d4ec702e9c29af3e2820f201fc33e24b3fe Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Thu, 19 Jun 2025 13:36:41 +0000 Subject: [PATCH 09/19] docs: update examples in nanmskmax --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmskmax/docs/repl.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt index 6d55d5bb2562..a095d57d7a1e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt @@ -48,17 +48,17 @@ 2.0 // Using `N` and stride parameters: - > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ]; + > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ]; > mask = [ 0, 0, 0, 0, 0, 0, 1 ]; - > {{alias}}( 3, x, 2, mask, 2 ) + > {{alias}}( 4, x, 2, mask, 2 ) 2.0 // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] ); + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > 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 ); - > {{alias}}( 3, x1, 2, mask1, 2 ) + > {{alias}}( 4, x1, 2, mask1, 2 ) 2.0 From c7bab83da03a54dacb6a94265ddf14dc91542ebe Mon Sep 17 00:00:00 2001 From: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> Date: Thu, 19 Jun 2025 19:56:51 +0530 Subject: [PATCH 10/19] fix: examples Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> --- .../stats/base/nanmskmax/examples/index.js | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js index 2aad2fa6092d..5bca1fc1b5d3 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/examples/index.js @@ -18,18 +18,22 @@ 'use strict'; -var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var nanmskmax = require( './../lib' ); -var x = uniform( 10, -50.0, 50.0, { - 'dtype': 'float64' -}); +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); -var mask = bernoulli( x.length, 0.2, { - 'dtype': 'uint8' -}); +var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) ); console.log( mask ); var v = nanmskmax( x.length, x, 1, mask, 1 ); From 9620a1eb659330b34967cd79bcdd03881752b91b Mon Sep 17 00:00:00 2001 From: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> Date: Thu, 19 Jun 2025 20:01:11 +0530 Subject: [PATCH 11/19] fix: examples in README Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> --- .../@stdlib/stats/base/nanmskmax/README.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index fe87434e3c27..65240071f52c 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -134,18 +134,22 @@ var v = nanmskmax.ndarray( 5, x, 2, 1, mask, 2, 1 ); ```javascript -var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var nanmskmax = require( '@stdlib/stats/base/nanmskmax' ); -var x = uniform( 10, -50.0, 50.0, { - 'dtype': 'float64' -}); +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); -var mask = bernoulli( x.length, 0.2, { - 'dtype': 'uint8' -}); +var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) ); console.log( mask ); var v = nanmskmax( x.length, x, 1, mask, 1 ); From 35b874cd8ce5bafa607d828694c89a49f98002dd Mon Sep 17 00:00:00 2001 From: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> Date: Thu, 19 Jun 2025 20:08:17 +0530 Subject: [PATCH 12/19] refactor: benchmark Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> --- .../base/nanmskmax/benchmark/benchmark.js | 29 ++++++++++++------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js index cc0689829558..f55d44450373 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.js @@ -21,23 +21,30 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var nanmskmax = require( './../lib/main.js' ); -// VARIABLES // - -var options = { - 'dtype': 'generic' -}; - - // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -49,8 +56,8 @@ function createBenchmark( len ) { var mask; var x; - mask = bernoulli( len, 0.2, options ); - x = uniform( len, -10.0, 10.0, options ); + x = filledarrayBy( len, 'generic', rand ); + mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) ); return benchmark; function benchmark( b ) { From 44963b196d9639c6c493452c16600d149581c5f2 Mon Sep 17 00:00:00 2001 From: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> Date: Thu, 19 Jun 2025 20:08:26 +0530 Subject: [PATCH 13/19] refactor: benchmark Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com> --- .../nanmskmax/benchmark/benchmark.ndarray.js | 29 ++++++++++++------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js index 361ecd32ddbf..de4664c6ee43 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/benchmark/benchmark.ndarray.js @@ -21,23 +21,30 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var nanmskmax = require( './../lib/ndarray.js' ); -// VARIABLES // - -var options = { - 'dtype': 'generic' -}; - - // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -49,8 +56,8 @@ function createBenchmark( len ) { var mask; var x; - mask = bernoulli( len, 0.2, options ); - x = uniform( len, -10.0, 10.0, options ); + x = filledarrayBy( len, 'generic', rand ); + mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) ); return benchmark; function benchmark( b ) { From 355a9bc8496001f4c9b89ccd22e9ed97d6846a38 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 17:52:54 -0700 Subject: [PATCH 14/19] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanmskmax/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index 65240071f52c..6fbebf74a533 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -60,7 +60,7 @@ The `N` and stride parameters determine which elements in the strided arrays are ```javascript var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0, NaN, NaN ]; -var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 1, 1 ]; +var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ]; var v = nanmskmax( 5, x, 2, mask, 2 ); // returns 4.0 @@ -77,7 +77,7 @@ var Uint8Array = require( '@stdlib/array/uint8' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1, 1, 1 ] ); +var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ] ); var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var v = nanmskmax( 5, x1, 2, mask1, 2 ); From cfa964c9a1722eb799e2559ba7adc42f2b0074c6 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 17:54:27 -0700 Subject: [PATCH 15/19] docs: update copy Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanmskmax/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md index 6fbebf74a533..df35d6ad1471 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/README.md @@ -101,7 +101,7 @@ 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 support indexing semantics based on a starting indices. For example, to calculate the maximum value for every other element in `x` starting from the second element +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 element in `x` starting from the second element ```javascript var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ]; From ce365aa73fa7cfd47fdb2e247cd8f3d60c7a8482 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 17:56:29 -0700 Subject: [PATCH 16/19] docs: update example Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt index a095d57d7a1e..a8af1f8b1823 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/docs/repl.txt @@ -108,7 +108,7 @@ // Using offset parameter: > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0, NaN, NaN ]; - > mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 1 ]; + > mask = [ 0, 0, 0, 0, 0, 0, 1, 0, 0 ]; > {{alias}}.ndarray( 4, x, 2, 1, mask, 2, 1 ) 2.0 From 34d2633102d78710973f402b4e753131e685961f Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 17:57:52 -0700 Subject: [PATCH 17/19] docs: fix missing private annotation Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js index 9c5035122e06..6a64615df846 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/lib/accessors.js @@ -29,6 +29,7 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); /** * Computes the maximum value of a strided array according to a mask, ignoring `NaN` values. * +* @private * @param {PositiveInteger} N - number of indexed elements * @param {Object} x - input array object * @param {Collection} x.data - input array data From 3eb7fa399fd14702d1005aab47da0be3791d5e59 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 18:02:20 -0700 Subject: [PATCH 18/19] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/base/nanmskmax/test/test.main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js index 2165915aa045..62e26fc28703 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.main.js @@ -181,7 +181,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu var v; x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - mask = toAccessorArray( [ 0.0, 0.0 ] ); + mask = toAccessorArray( [ 0, 0 ] ); v = nanmskmax( 0, x, 1, mask, 1 ); t.strictEqual( isnan( v ), true, 'returns expected value' ); @@ -212,7 +212,7 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first var v; x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - mask = toAccessorArray( [ 0.0, 0.0 ] ); + mask = toAccessorArray( [ 0, 0 ] ); v = nanmskmax( 1, x, 1, mask, 1 ); t.strictEqual( v, 1.0, 'returns expected value' ); From 87810c67986ef39c1e7dfdcfa828d78a3334dcd0 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Jun 2025 18:03:00 -0700 Subject: [PATCH 19/19] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/base/nanmskmax/test/test.ndarray.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js index b8f442bf7c50..bb27f60a4df8 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmax/test/test.ndarray.js @@ -179,7 +179,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu var v; x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - mask = toAccessorArray( [ 0.0, 0.0 ] ); + mask = toAccessorArray( [ 0, 0 ] ); v = nanmskmax( 0, x, 1, 0, mask, 1, 0 ); t.strictEqual( isnan( v ), true, 'returns expected value' ); @@ -210,7 +210,7 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first var v; x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - mask = toAccessorArray( [ 0.0, 0.0 ] ); + mask = toAccessorArray( [ 0, 0 ] ); v = nanmskmax( 1, x, 1, 0, mask, 1, 0 ); t.strictEqual( v, 1.0, 'returns expected value' );