From 411076be16ccdfd99ef1664bef8640bb87560529 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Fri, 6 Jun 2025 14:32:03 +0000 Subject: [PATCH 1/3] refactor: update `stats/base/snanmskmin` native addon from C++ to C --- 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: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - 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/snanmskmin/include.gypi | 2 +- .../stats/base/snanmskmin/manifest.json | 45 +++++- .../@stdlib/stats/base/snanmskmin/src/addon.c | 46 ++++++ .../stats/base/snanmskmin/src/addon.cpp | 153 ------------------ 4 files changed, 91 insertions(+), 155 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/snanmskmin/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/snanmskmin/src/addon.cpp diff --git a/lib/node_modules/@stdlib/stats/base/snanmskmin/include.gypi b/lib/node_modules/@stdlib/stats/base/snanmskmin/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/stats/base/snanmskmin/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/snanmskmin/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_UINT8ARRAY( env, Mask, N, strideMask, argv, 3 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_snanmskmin( N, X, strideX, Mask, strideMask ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/stats/base/snanmskmin/src/addon.cpp b/lib/node_modules/@stdlib/stats/base/snanmskmin/src/addon.cpp deleted file mode 100644 index 6580302d0358..000000000000 --- a/lib/node_modules/@stdlib/stats/base/snanmskmin/src/addon.cpp +++ /dev/null @@ -1,153 +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. -*/ - -#include "stdlib/stats/base/snanmskmin.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_snanmskmin { - - /** - * Computes the minimum value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values. - * - * ## Notes - * - * - When called from JavaScript, the function expects five arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `strideX`: `X` stride length - * - `Mask`: mask array - * - `strideMask`: `Mask` stride length - */ - napi_value node_snanmskmin( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 5; - napi_value argv[ 5 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 5 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 5 arguments." ); - return nullptr; - } - - napi_valuetype vtype0; - status = napi_typeof( env, argv[ 0 ], &vtype0 ); - assert( status == napi_ok ); - if ( vtype0 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. First argument must be a number." ); - return nullptr; - } - - bool res1; - status = napi_is_typedarray( env, argv[ 1 ], &res1 ); - assert( status == napi_ok ); - if ( res1 == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - - napi_valuetype vtype2; - status = napi_typeof( env, argv[ 2 ], &vtype2 ); - assert( status == napi_ok ); - if ( vtype2 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a number." ); - return nullptr; - } - - bool res3; - status = napi_is_typedarray( env, argv[ 3 ], &res3 ); - assert( status == napi_ok ); - if ( res3 == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a Uint8Array." ); - return nullptr; - } - - napi_valuetype vtype4; - status = napi_typeof( env, argv[ 4 ], &vtype4 ); - assert( status == napi_ok ); - if ( vtype4 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fifth argument must be a number." ); - return nullptr; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - int64_t strideX; - status = napi_get_value_int64( env, argv[ 2 ], &strideX ); - assert( status == napi_ok ); - - int64_t strideMask; - status = napi_get_value_int64( env, argv[ 4 ], &strideMask ); - assert( status == napi_ok ); - - napi_typedarray_type vtype1; - size_t xlen; - void *X; - status = napi_get_typedarray_info( env, argv[ 1 ], &vtype1, &xlen, &X, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype1 != napi_float32_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - if ( (N-1)*llabs(strideX) >= (int64_t)xlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Second argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_typedarray_type vtype3; - size_t mlen; - void *Mask; - status = napi_get_typedarray_info( env, argv[ 3 ], &vtype3, &mlen, &Mask, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype3 != napi_uint8_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a Uint8Array." ); - return nullptr; - } - if ( (N-1)*llabs(strideMask) >= (int64_t)mlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Fourth argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_value v; - status = napi_create_double( env, (double)stdlib_strided_snanmskmin( N, (float *)X, strideX, (uint8_t *)Mask, strideMask ), &v ); - assert( status == napi_ok ); - - return v; - } - - napi_value Init( napi_env env, napi_value exports ) { - napi_status status; - napi_value fcn; - status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, node_snanmskmin, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_snanmskmin From 3699c4df42e1f788d3ee6159cc56bb0e27ffe182 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Fri, 6 Jun 2025 15:31:44 +0000 Subject: [PATCH 2/3] feat: add C ndarray interface and refactor implementation for `stats/base/snanmskmin` --- 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - 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/snanmskmin/README.md | 195 ++++++++++++++---- .../base/snanmskmin/benchmark/benchmark.js | 32 +-- .../snanmskmin/benchmark/benchmark.native.js | 32 +-- .../snanmskmin/benchmark/benchmark.ndarray.js | 32 +-- .../benchmark/benchmark.ndarray.native.js | 32 +-- .../stats/base/snanmskmin/docs/repl.txt | 24 +-- .../base/snanmskmin/examples/c/example.c | 10 +- .../stats/base/snanmskmin/examples/index.js | 31 +-- .../include/stdlib/stats/base/snanmskmin.h | 8 +- .../stats/base/snanmskmin/lib/index.js | 4 +- .../stats/base/snanmskmin/lib/ndarray.js | 4 +- .../base/snanmskmin/lib/ndarray.native.js | 20 +- .../stats/base/snanmskmin/lib/snanmskmin.js | 52 +---- .../stats/base/snanmskmin/manifest.json | 50 +++-- .../@stdlib/stats/base/snanmskmin/src/addon.c | 25 ++- .../snanmskmin/src/{snanmskmin.c => main.c} | 40 ++-- .../base/snanmskmin/test/test.ndarray.js | 13 +- .../snanmskmin/test/test.ndarray.native.js | 15 +- .../base/snanmskmin/test/test.snanmskmin.js | 13 +- .../snanmskmin/test/test.snanmskmin.native.js | 13 +- 20 files changed, 372 insertions(+), 273 deletions(-) rename lib/node_modules/@stdlib/stats/base/snanmskmin/src/{snanmskmin.c => main.c} (57%) diff --git a/lib/node_modules/@stdlib/stats/base/snanmskmin/README.md b/lib/node_modules/@stdlib/stats/base/snanmskmin/README.md index 2e268678b313..5e49a0c4232e 100644 --- a/lib/node_modules/@stdlib/stats/base/snanmskmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/snanmskmin/README.md @@ -18,6 +18,8 @@ limitations under the License. --> + + # snanmskmin > Calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values. @@ -38,7 +40,7 @@ var snanmskmin = require( '@stdlib/stats/base/snanmskmin' ); #### snanmskmin( N, x, strideX, mask, strideMask ) -Computes the minimum value of a single-precision floating-point strided array `x` according to a `mask`, ignoring `NaN` values. +Computes the minimum value of a single-precision floating-point strided array according to a `mask`, ignoring `NaN` values. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -55,22 +57,20 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **strideX**: index increment for `x`. +- **strideX**: stride length for `x`. - **mask**: mask [`Uint8Array`][@stdlib/array/uint8]. 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 minimum value of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the minimum value of every other element in `x`, ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 1.0, 2.0, 7.0, -2.0, -4.0, 3.0, -5.0, -6.0 ] ); var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); -var N = floor( x.length / 2 ); -var v = snanmskmin( N, x, 2, mask, 2 ); +var v = snanmskmin( 4, x, 2, mask, 2 ); // returns -4.0 ``` @@ -81,7 +81,6 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element @@ -89,9 +88,7 @@ var x1 = new Float32Array( 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 = snanmskmin( N, x1, 2, mask1, 2 ); +var v = snanmskmin( 4, x1, 2, mask1, 2 ); // returns -2.0 ``` @@ -115,18 +112,16 @@ 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 minimum 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, offset parameters support indexing semantics based on starting indices. For example, to calculate the minimum value for every other element in `x` starting from the second element ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ] ); var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); -var N = floor( x.length / 2 ); -var v = snanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = snanmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 ); // returns -2.0 ``` @@ -151,31 +146,22 @@ var v = snanmskmin.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 Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var snanmskmin = require( '@stdlib/stats/base/snanmskmin' ); -var mask; -var x; -var i; - -x = new Float32Array( 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 ); +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; } + return uniform( -50.0, 50.0 ); } + +var x = filledarrayBy( 10, 'float32', rand ); console.log( x ); + +var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) ); console.log( mask ); var v = snanmskmin( x.length, x, 1, mask, 1 ); @@ -186,6 +172,145 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/snanmskmin.h" +``` + +#### stdlib_strided_snanmskmin( N, \*X, strideX, \*Mask, strideMask ) + +Computes the minimum value of a single-precision floating-point strided array according to a `mask`, ignoring `NaN` values. + +```c +#include + +const float x[] = { 1.0f, -2.0f, 4.0f, 2.0f, 0.0f/0.0f }; +const uint8_t mask[] = { 0, 0, 1, 0, 0 }; + +float v = stdlib_strided_snanmskmin( 5, x, 1, mask, 1 ); +// returns -2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Mask**: `[in] uint8_t*` mask 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**: `[in] CBLAS_INT` stride length for `Mask`. + +```c +float stdlib_strided_snanmskmin( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); +``` + +#### stdlib_strided_snanmskmin_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask ) + +Computes the minimum value of a single-precision floating-point strided array according to a `mask`, ignoring `NaN` values and using alternative indexing semantics. + +```c +#include + +const float x[] = { 1.0f, -2.0f, 4.0f, 2.0f, 0.0f/0.0f }; +const uint8_t mask[] = { 0, 0, 1, 0, 0 }; + +float v = stdlib_strided_snanmskmin_ndarray( 5, x, 1, 0, mask, 1, 0 ); +// returns -2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Mask**: `[in] uint8_t*` mask 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**: `[in] CBLAS_INT` stride length for `Mask`. +- **offsetMask**: `[in] CBLAS_INT` starting index for `Mask`. + +```c +float stdlib_strided_snanmskmin_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/snanmskmin.h" +#include +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 0.0f/0.0f, 0.0f/0.0f }; + + // Create a mask array: + const uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride lengths: + const int strideX = 2; + const int strideMask = 2; + + // Compute the minimum value: + float v = stdlib_strided_snanmskmin( N, x, strideX, mask, strideMask ); + + // Print the result: + printf( "min: %f\n", v ); +} +``` + +
+ + + +
+ + + +
+ +
+ + +