From 9fa6bc9cdb8e856fcb359861e8ffbd4efa68dcfc Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 24 Dec 2025 01:31:24 +0530 Subject: [PATCH 1/8] feat: stats/strided/mskmidrange --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../stats/strided/mskmidrange/README.md | 210 +++++++++ .../mskmidrange/benchmark/benchmark.js | 99 +++++ .../benchmark/benchmark.ndarray.js | 99 +++++ .../stats/strided/mskmidrange/docs/repl.txt | 116 +++++ .../strided/mskmidrange/docs/types/index.d.ts | 104 +++++ .../strided/mskmidrange/docs/types/test.ts | 250 +++++++++++ .../strided/mskmidrange/examples/index.js | 36 ++ .../strided/mskmidrange/lib/accessors.js | 117 +++++ .../stats/strided/mskmidrange/lib/index.js | 56 +++ .../stats/strided/mskmidrange/lib/main.js | 35 ++ .../strided/mskmidrange/lib/mskmidrange.js | 53 +++ .../stats/strided/mskmidrange/lib/ndarray.js | 109 +++++ .../stats/strided/mskmidrange/package.json | 78 ++++ .../stats/strided/mskmidrange/test/test.js | 38 ++ .../mskmidrange/test/test.mskmidrange.js | 420 ++++++++++++++++++ .../strided/mskmidrange/test/test.ndarray.js | 404 +++++++++++++++++ 16 files changed, 2224 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/accessors.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/mskmidrange.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js create mode 100644 lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md b/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md new file mode 100644 index 000000000000..92416557d506 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md @@ -0,0 +1,210 @@ + + +# mskmidrange + +> Calculate the [mid-range][mid-range] of a strided array according to a mask. + +
+ +The [**mid-range**][mid-range], or **mid-extreme**, is the arithmetic mean of the maximum and minimum values in a data set. The measure is the midpoint of the range and a measure of central tendency. + +
+ + + +
+ +## Usage + +```javascript +var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); +``` + +#### mskmidrange( N, x, strideX, mask, strideMask ) + +Computes the [mid-range][mid-range] of a strided array `x` according to a `mask`. + +```javascript +var x = [ 1.0, -2.0, 4.0, 2.0 ]; +var mask = [ 0, 0, 1, 0 ]; + +var v = mskmidrange( x.length, x, 1, mask, 1 ); +// returns 0.0 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. +- **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**: stride length for `mask`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [mid-range][mid-range] 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 v = mskmidrange( 4, x, 2, mask, 2 ); +// returns -1.5 +``` + +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 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 mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var v = mskmidrange( 4, x1, 2, mask1, 2 ); +// returns 1.0 +``` + +#### mskmidrange.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) + +Computes the [mid-range][mid-range] of a strided array according to a `mask` and using alternative indexing semantics. + +```javascript +var x = [ 1.0, -2.0, 4.0, 2.0 ]; +var mask = [ 0, 0, 1, 0 ]; + +var v = mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, 0 ); +// returns 0.0 +``` + +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 starting indices. For example, to calculate the [mid-range][mid-range] of every other value in `x` starting from the second value + +```javascript +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 v = mskmidrange.ndarray( 4, x, 2, 1, mask, 2, 1 ); +// returns 1.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `NaN`. +- Depending on the environment, the typed versions ([`dmskmidrange`][@stdlib/stats/strided/dmskmidrange], [`smskmidrange`][@stdlib/stats/strided/smskmidrange], 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]). + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); + +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 = mskmidrange( x.length, x, 1, mask, 1 ); +console.log( v ); +``` + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/stats/strided/dmskmidrange`][@stdlib/stats/strided/dmskmidrange]: calculate the mid-range of a double-precision floating-point strided array according to a mask. +- [`@stdlib/stats/strided/midrange`][@stdlib/stats/strided/midrange]: calculate the mid-range of a strided array. +- [`@stdlib/stats/strided/mskmax`][@stdlib/stats/strided/mskmax]: calculate the maximum value of a strided array according to a mask. +- [`@stdlib/stats/strided/mskmin`][@stdlib/stats/strided/mskmin]: calculate the minimum value of a strided array according to a mask. +- [`@stdlib/stats/strided/nanmidrange`][@stdlib/stats/strided/nanmidrange]: calculate the mid-range of a strided array, ignoring NaN values. +- [`@stdlib/stats/strided/smskmidrange`][@stdlib/stats/strided/smskmidrange]: calculate the mid-range of a single-precision floating-point strided array according to a mask. + +
+ + + + + +
+ +[mid-range]: https://en.wikipedia.org/wiki/Mid-range + +[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 + + + +[@stdlib/stats/strided/dmskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmskmidrange + +[@stdlib/stats/strided/midrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/midrange + +[@stdlib/stats/strided/mskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmax + +[@stdlib/stats/strided/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmin + +[@stdlib/stats/strided/nanmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmidrange + +[@stdlib/stats/strided/smskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/smskmidrange + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js new file mode 100644 index 000000000000..55ea8c89b71e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js @@ -0,0 +1,99 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var mskmidrange = require( './../lib/mskmidrange.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var mask = bernoulli( len, 0.2, options ); + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = mskmidrange( x.length, x, 1, mask, 1 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..241a34940e4a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.ndarray.js @@ -0,0 +1,99 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var mskmidrange = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var mask = bernoulli( len, 0.2, options ); + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt new file mode 100644 index 000000000000..bc5bb9ff8a8e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt @@ -0,0 +1,116 @@ + +{{alias}}( N, x, strideX, mask, strideMask ) + Computes the mid-range of a strided array according to a mask. + + 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 typed + array views. + + 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. + + If `N <= 0`, the function returns `NaN`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Array|TypedArray + Input array. + + strideX: integer + Stride length for `x`. + + mask: Array|TypedArray + Mask array. + + strideMask: integer + Stride length for `mask`. + + Returns + ------- + out: number + Mid-range. + + Examples + -------- + // Standard Usage: + > var x = [ 1.0, -2.0, 4.0, 2.0 ]; + > var mask = [ 0, 0, 1, 0 ]; + > {{alias}}( x.length, x, 1, mask, 1 ) + 0.0 + + // 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 ]; + > {{alias}}( 3, x, 2, mask, 2 ) + 0.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 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 ) + 0.0 + + +{{alias}}.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) + Computes the mid-range of a strided array according to a mask and using + alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the `offset` parameter supports indexing semantics based on a + starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Array|TypedArray + Input array. + + strideX: integer + Stride length for `x`. + + offsetX: integer + Starting index for `x`. + + mask: Array|TypedArray + Mask array. + + strideMask: integer + Stride length for `mask`. + + offsetMask: integer + Starting index for `mask`. + + Returns + ------- + out: number + Mid-range. + + Examples + -------- + // Standard Usage: + > var x = [ 1.0, -2.0, 2.0, 4.0 ]; + > var mask = [ 0, 0, 0, 1 ]; + > {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 ) + 0.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 ) + 0.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/index.d.ts new file mode 100644 index 000000000000..6b93b3347a61 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/index.d.ts @@ -0,0 +1,104 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; + +/** +* Interface describing `mskmidrange`. +*/ +interface Routine { + /** + * Computes the mid-range of a strided array according to a mask. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @param mask - mask array + * @param strideMask - stride length for `mask` + * @returns mid-range + * + * @example + * var x = [ 1.0, -2.0, 4.0, 2.0 ]; + * var mask = [ 0, 0, 1, 0 ]; + * + * var v = mskmidrange( x.length, x, 1, mask, 1 ); + * // returns 0.0 + */ + ( N: number, x: InputArray, strideX: number, mask: InputArray, strideMask: number ): number; + + /** + * Computes the mid-range 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 - stride length for `x` + * @param offsetX - `x` starting index + * @param mask - mask array + * @param strideMask - stride length for `mask` + * @param offsetMask - `mask` starting index + * @returns mid-range + * + * @example + * var x = [ 1.0, -2.0, 4.0, 2.0 ]; + * var mask = [ 0, 0, 1, 0 ]; + * + * var v = mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, 0 ); + * // returns 0.0 + */ + ndarray( N: number, x: InputArray, strideX: number, offsetX: number, mask: InputArray, strideMask: number, offsetMask: number ): number; +} + +/** +* Computes the mid-range of a strided array according to a mask. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - stride length for `x` +* @param mask - mask array +* @param strideMask - stride length for `mask` +* @returns mid-range +* +* @example +* var x = [ 1.0, -2.0, 4.0, 2.0 ]; +* var mask = [ 0, 0, 1, 0 ]; +* +* var v = mskmidrange( x.length, x, 1, mask, 1 ); +* // returns 0.0 +* +* @example +* var x = [ 1.0, -2.0, 4.0, 2.0 ]; +* var mask = [ 0, 0, 1, 0 ]; +* +* var v = mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, 0 ); +* // returns 0.0 +*/ +declare var mskmidrange: Routine; + + +// EXPORTS // + +export = mskmidrange; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/test.ts new file mode 100644 index 000000000000..a3838b1e0cae --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/types/test.ts @@ -0,0 +1,250 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import AccessorArray = require( '@stdlib/array/base/accessor' ); +import mskmidrange = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange( x.length, x, 1, mask, 1 ); // $ExpectType number + mskmidrange( x.length, new AccessorArray( x ), 1, new AccessorArray( mask ), 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange( '10', x, 1, mask, 1 ); // $ExpectError + mskmidrange( true, x, 1, mask, 1 ); // $ExpectError + mskmidrange( false, x, 1, mask, 1 ); // $ExpectError + mskmidrange( null, x, 1, mask, 1 ); // $ExpectError + mskmidrange( undefined, x, 1, mask, 1 ); // $ExpectError + mskmidrange( [], x, 1, mask, 1 ); // $ExpectError + mskmidrange( {}, x, 1, mask, 1 ); // $ExpectError + mskmidrange( ( x: number ): number => x, x, 1, mask, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a numeric array... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange( x.length, 10, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, '10', 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, true, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, false, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, null, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, undefined, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, [ '1' ], 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, {}, 1, mask, 1 ); // $ExpectError + mskmidrange( x.length, ( x: number ): number => x, 1, mask, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange( x.length, x, '10', mask, 1 ); // $ExpectError + mskmidrange( x.length, x, true, mask, 1 ); // $ExpectError + mskmidrange( x.length, x, false, mask, 1 ); // $ExpectError + mskmidrange( x.length, x, null, mask, 1 ); // $ExpectError + mskmidrange( x.length, x, undefined, mask, 1 ); // $ExpectError + mskmidrange( x.length, x, [], mask, 1 ); // $ExpectError + mskmidrange( x.length, x, {}, mask, 1 ); // $ExpectError + mskmidrange( x.length, x, ( x: number ): number => x, mask, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a numeric array... +{ + const x = new Float64Array( 10 ); + + mskmidrange( x.length, x, 1, 10, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, '10', 1 ); // $ExpectError + mskmidrange( x.length, x, 1, true, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, false, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, null, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, undefined, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, [ '1' ], 1 ); // $ExpectError + mskmidrange( x.length, x, 1, {}, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange( x.length, x, 1, mask, '10' ); // $ExpectError + mskmidrange( x.length, x, 1, mask, true ); // $ExpectError + mskmidrange( x.length, x, 1, mask, false ); // $ExpectError + mskmidrange( x.length, x, 1, mask, null ); // $ExpectError + mskmidrange( x.length, x, 1, mask, undefined ); // $ExpectError + mskmidrange( x.length, x, 1, mask, [] ); // $ExpectError + mskmidrange( x.length, x, 1, mask, {} ); // $ExpectError + mskmidrange( x.length, x, 1, mask, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange(); // $ExpectError + mskmidrange( x.length ); // $ExpectError + mskmidrange( x.length, x, 1 ); // $ExpectError + mskmidrange( x.length, x, 1, mask ); // $ExpectError + mskmidrange( x.length, x, 1, mask, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number + mskmidrange.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... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( '10', x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( true, x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( false, x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( null, x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( undefined, x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( [], x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( {}, x, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( ( x: number ): number => x, x, 1, 0, mask, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a numeric array... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, 10, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, '10', 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, true, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, false, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, null, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, undefined, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, [ '1' ], 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, {}, 1, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, ( x: number ): number => x, 1, 0, mask, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, x, '10', 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, true, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, false, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, null, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, undefined, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, [], 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, {}, 0, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, ( x: number ): number => x, 0, mask, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, x, 1, '10', mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, true, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, false, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, null, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, undefined, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, [], mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, {}, mask, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, ( x: number ): number => x, mask, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a numeric array... +{ + const x = new Float64Array( 10 ); + + mskmidrange.ndarray( x.length, 1, 0, 10, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, '10', 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, true, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, false, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, null, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, undefined, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, [ '1' ], 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, {}, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, x, 1, 0, mask, '10', 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, true, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, false, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, null, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, undefined, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, [], 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, {}, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, '10' ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, true ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, false ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, null ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, undefined ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, [] ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, {} ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const mask = new Uint8Array( 10 ); + + mskmidrange.ndarray(); // $ExpectError + mskmidrange.ndarray( x.length ); // $ExpectError + mskmidrange.ndarray( x.length, x ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1 ); // $ExpectError + mskmidrange.ndarray( x.length, x, 1, 0, mask, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/examples/index.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/examples/index.js new file mode 100644 index 000000000000..8a824fc0b748 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/examples/index.js @@ -0,0 +1,36 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var mskmidrange = require( './../lib' ); + +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 = mskmidrange( x.length, x, 1, mask, 1 ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/accessors.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/accessors.js new file mode 100644 index 000000000000..d2f0aebc1bd7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/accessors.js @@ -0,0 +1,117 @@ +/** +* @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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); + + +// MAIN // + +/** +* Computes the mid-range 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 {number} mid-range +* +* @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 = mskmidrange( 5, arraylike2object( toAccessorArray( x ) ), 2, 1, arraylike2object( toAccessorArray( mask ) ), 2, 1 ); +* // returns 1.0 +*/ +function mskmidrange( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + var xbuf; + var mbuf; + var xget; + var mget; + var max; + var min; + 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++ ) { + if ( mget( mbuf, im ) === 0 ) { + break; + } + ix += strideX; + im += strideMask; + } + if ( i === N ) { + return NaN; + } + min = xget( xbuf, ix ); + if ( isnan( min ) ) { + return min; + } + max = min; + 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 < min || ( v === min && isNegativeZero( v ) ) ) { + min = v; + } else if ( v > max || ( v === max && isPositiveZero( v ) ) ) { + max = v; + } + } + return ( max + min ) / 2.0; +} + + +// EXPORTS // + +module.exports = mskmidrange; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js new file mode 100644 index 000000000000..473929700e76 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js @@ -0,0 +1,56 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Compute the mid-range of a strided array according to a mask. +* +* @module @stdlib/stats/strided/mskmidrange +* +* @example +* var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); +* +* var x = [ 1.0, -2.0, 4.0, 2.0 ]; +* var mask = [ 0, 0, 1, 0 ]; +* +* var v = mskmidrange( x.length, x, 1, mask, 1 ); +* // returns 0.0 +* +* @example +* var floor = require( '@stdlib/math/base/special/floor' ); +* var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); +* +* 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 = mskmidrange.ndarray( N, x, 2, 1, mask, 2, 1 ); +* // returns 1.0 +*/ + +// MODULES // + +var mskmidrange = require( './main.js' ); + + +// EXPORTS // + +module.exports = mskmidrange; + +// exports: { "ndarray": "mskmidrange.ndarray" } diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/main.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/main.js new file mode 100644 index 000000000000..19f8b7215a1e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/main.js @@ -0,0 +1,35 @@ +/** +* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var mskmidrange = require( './mskmidrange.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( mskmidrange, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = mskmidrange; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/mskmidrange.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/mskmidrange.js new file mode 100644 index 000000000000..c1bc0b3d42a4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/mskmidrange.js @@ -0,0 +1,53 @@ +/** +* @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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +/** +* Computes the mid-range of a strided array according to a mask. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - stride length for `x` +* @param {NumericArray} mask - mask array +* @param {integer} strideMask - stride length for `mask` +* @returns {number} mid-range +* +* @example +* var x = [ 1.0, -2.0, 4.0, 2.0 ]; +* var mask = [ 0, 0, 1, 0 ]; +* +* var v = mskmidrange( x.length, x, 1, mask, 1 ); +* // returns 0.0 +*/ +function mskmidrange( N, x, strideX, mask, strideMask ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ), mask, strideMask, stride2offset( N, strideMask ) ); +} + + +// EXPORTS // + +module.exports = mskmidrange; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/ndarray.js new file mode 100644 index 000000000000..0825074b2b01 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/ndarray.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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); + + +// MAIN // + +/** +* Computes the mid-range of a strided array according to a mask. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {NumericArray} mask - mask array +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` +* @returns {number} mid-range +* +* @example +* 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 = mskmidrange( 5, x, 2, 1, mask, 2, 1 ); +* // returns 1.0 +*/ +function mskmidrange( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + var max; + var min; + 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++ ) { + if ( mask[ im ] === 0 ) { + break; + } + ix += strideX; + im += strideMask; + } + if ( i === N ) { + return NaN; + } + min = x[ ix ]; + if ( isnan( min ) ) { + return min; + } + max = min; + 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 < min || ( v === min && isNegativeZero( v ) ) ) { + min = v; + } else if ( v > max || ( v === max && isPositiveZero( v ) ) ) { + max = v; + } + } + return ( max + min ) / 2.0; +} + + +// EXPORTS // + +module.exports = mskmidrange; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/package.json b/lib/node_modules/@stdlib/stats/strided/mskmidrange/package.json new file mode 100644 index 000000000000..75d7f38c7b59 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/package.json @@ -0,0 +1,78 @@ +{ + "name": "@stdlib/stats/strided/mskmidrange", + "version": "0.0.0", + "description": "Calculate the mid-range of a strided array according to a mask.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": "./lib/main.js", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "midrange", + "maximum", + "max", + "minimum", + "min", + "range", + "extremes", + "domain", + "extent", + "dispersion", + "strided", + "strided array", + "masked", + "mask", + "masked array", + "typed", + "array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.js new file mode 100644 index 000000000000..6b07498963e4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.js @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var mskmidrange = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof mskmidrange, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof mskmidrange.ndarray, 'function', 'method is a function' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js new file mode 100644 index 000000000000..e4f2787e2df3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js @@ -0,0 +1,420 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Uint8Array = require( '@stdlib/array/uint8' ); +var mskmidrange = require( './../lib/mskmidrange.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof mskmidrange, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( mskmidrange.length, 5, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the mid-range of a strided array according to a mask', 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 = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ -4.0, 0.0, NaN, 5.0 ]; + mask = [ 0, 0, 0, 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = mskmidrange( x.length, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the mid-range 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 = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmidrange( 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 = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = mskmidrange( 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; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 0, x, 1, mask, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = mskmidrange( -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 element', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 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; + 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 = mskmidrange( 5, x, 2, mask, 2 ); + + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x ), 2, toAccessorArray( mask ), 2 ); + + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', 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 = mskmidrange( 5, x, -2, mask, -2 ); + + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x ), -2, toAccessorArray( mask ), -2 ); + + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', 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 = mskmidrange( 5, x1, 2, mask1, 2 ); + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x1 ), 2, toAccessorArray( mask1 ), 2 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js new file mode 100644 index 000000000000..dfe71a6bec50 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js @@ -0,0 +1,404 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var 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 mskmidrange = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof mskmidrange, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.strictEqual( mskmidrange.length, 7, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the mid-range of a strided array according to a mask', 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 = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmidrange( x.length, x, 1, 0, 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 = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = mskmidrange( x.length, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the mid-range 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 = mskmidrange( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + mask = [ 0, 0, 1, 0 ]; + v = mskmidrange( 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 = mskmidrange( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = mskmidrange( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = mskmidrange( 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 = mskmidrange( 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 = mskmidrange( 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 = mskmidrange( 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 = mskmidrange( 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; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 0, x, 1, 0, mask, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = mskmidrange( -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 element', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 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; + 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 = mskmidrange( 5, x, 2, 0, mask, 2, 0 ); + + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x ), 2, 0, toAccessorArray( mask ), 2, 0 ); + + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', 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 = mskmidrange( 5, x, -2, 8, mask, -2, 8 ); + + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x ), -2, 8, toAccessorArray( mask ), -2, 8 ); + + t.strictEqual( v, 1.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 + ]; + mask = [ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 1, + 1 // 4 + ]; + + v = mskmidrange( 5, x, 2, 1, mask, 2, 1 ); + t.strictEqual( v, 1.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 = mskmidrange( 5, toAccessorArray( x ), 2, 1, toAccessorArray( mask ), 2, 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); From 9b60a5edf83b06dfd8e705bd8572d27f1f41ce9d Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:17:45 -0800 Subject: [PATCH 2/8] Apply suggestions from code review Signed-off-by: Athan --- .../stats/strided/mskmidrange/README.md | 29 ++----------------- 1 file changed, 3 insertions(+), 26 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md b/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md index 92416557d506..0b9af650b569 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/README.md @@ -40,7 +40,7 @@ var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); #### mskmidrange( N, x, strideX, mask, strideMask ) -Computes the [mid-range][mid-range] of a strided array `x` according to a `mask`. +Computes the [mid-range][mid-range] of a strided array according to a mask. ```javascript var x = [ 1.0, -2.0, 4.0, 2.0 ]; @@ -88,7 +88,7 @@ var v = mskmidrange( 4, x1, 2, mask1, 2 ); #### mskmidrange.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) -Computes the [mid-range][mid-range] of a strided array according to a `mask` and using alternative indexing semantics. +Computes the [mid-range][mid-range] of a strided array according to a mask and using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, 4.0, 2.0 ]; @@ -103,7 +103,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 starting indices. For example, to calculate the [mid-range][mid-range] of 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 [mid-range][mid-range] of every other value in `x` starting from the second value ```javascript var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ]; @@ -162,17 +162,6 @@ console.log( v );
-* * * - -## See Also - -- [`@stdlib/stats/strided/dmskmidrange`][@stdlib/stats/strided/dmskmidrange]: calculate the mid-range of a double-precision floating-point strided array according to a mask. -- [`@stdlib/stats/strided/midrange`][@stdlib/stats/strided/midrange]: calculate the mid-range of a strided array. -- [`@stdlib/stats/strided/mskmax`][@stdlib/stats/strided/mskmax]: calculate the maximum value of a strided array according to a mask. -- [`@stdlib/stats/strided/mskmin`][@stdlib/stats/strided/mskmin]: calculate the minimum value of a strided array according to a mask. -- [`@stdlib/stats/strided/nanmidrange`][@stdlib/stats/strided/nanmidrange]: calculate the mid-range of a strided array, ignoring NaN values. -- [`@stdlib/stats/strided/smskmidrange`][@stdlib/stats/strided/smskmidrange]: calculate the mid-range of a single-precision floating-point strided array according to a mask. -
@@ -189,22 +178,10 @@ console.log( v ); [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray - - [@stdlib/stats/strided/dmskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmskmidrange -[@stdlib/stats/strided/midrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/midrange - -[@stdlib/stats/strided/mskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmax - -[@stdlib/stats/strided/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmin - -[@stdlib/stats/strided/nanmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmidrange - [@stdlib/stats/strided/smskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/smskmidrange - - From a640006e71d1ba1b354984390b2415ce9d361605 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:33:42 -0800 Subject: [PATCH 3/8] docs: update copy Signed-off-by: Athan --- .../@stdlib/stats/strided/mskmidrange/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt index bc5bb9ff8a8e..0cc0374bd3a5 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt @@ -66,8 +66,8 @@ alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a - starting index. + buffer, the offset parameters support indexing semantics based on starting + indices. Parameters ---------- From c12da0f89a9162f89074edbb0ce3a0eaad9ff013 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:34:26 -0800 Subject: [PATCH 4/8] docs: update comment Signed-off-by: Athan --- .../@stdlib/stats/strided/mskmidrange/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt index 0cc0374bd3a5..add7b301b93e 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/docs/repl.txt @@ -105,7 +105,7 @@ > {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 ) 0.0 - // Using offset parameter: + // Using offset parameters: > 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 ) From 3813d33a16823683ab1ced5fcd9d8c625eaf8411 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:37:36 -0800 Subject: [PATCH 5/8] docs: update example Signed-off-by: Athan --- .../@stdlib/stats/strided/mskmidrange/lib/index.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js index 473929700e76..d351450e3feb 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/lib/index.js @@ -33,14 +33,12 @@ * // returns 0.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var mskmidrange = require( '@stdlib/stats/strided/mskmidrange' ); * * 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 = mskmidrange.ndarray( N, x, 2, 1, mask, 2, 1 ); +* var v = mskmidrange.ndarray( 5, x, 2, 1, mask, 2, 1 ); * // returns 1.0 */ From eee979b9b4a91051d24ca5953cd46a73a40765cd Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:41:08 -0800 Subject: [PATCH 6/8] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js | 2 +- .../@stdlib/stats/strided/mskmidrange/test/test.ndarray.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js index e4f2787e2df3..81edffef2444 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js @@ -175,7 +175,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu t.end(); }); -tape( 'if provided an `N` parameter equal to `1`, the function returns the element', function test( t ) { +tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', function test( t ) { var mask; var x; var v; diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js index dfe71a6bec50..6226aef799cc 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js @@ -173,7 +173,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu t.end(); }); -tape( 'if provided an `N` parameter equal to `1`, the function returns the element', function test( t ) { +tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', function test( t ) { var mask; var x; var v; From dac2d24b323949d0185496eddec06d3e4714def7 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:42:03 -0800 Subject: [PATCH 7/8] test: add test Signed-off-by: Athan --- .../strided/mskmidrange/test/test.mskmidrange.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js index 81edffef2444..60d32d5f94cb 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.mskmidrange.js @@ -189,6 +189,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 indexed element (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 1, toAccessorArray( x ), 1, toAccessorArray( 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; From 1983345ca4dc7942ef9920ce22801dde02095500 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 24 Dec 2025 02:42:51 -0800 Subject: [PATCH 8/8] test: add test Signed-off-by: Athan --- .../stats/strided/mskmidrange/test/test.ndarray.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js index 6226aef799cc..9a7d7e0aa220 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/test/test.ndarray.js @@ -187,6 +187,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 indexed element (accessor)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0, 0, 0, 0 ]; + + v = mskmidrange( 1, toAccessorArray( x ), 1, 0, toAccessorArray( 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;