From e0f3cf7e528a8da0c454fcb51afd91fb2c2f1ac6 Mon Sep 17 00:00:00 2001 From: Mayur Jogade Date: Tue, 8 Sep 2026 15:54:33 +0530 Subject: [PATCH] feat: add C implementation for `stats/base/ndarray/snanmskmin` Ref: https://github.com/stdlib-js/stdlib/issues/14034 --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: 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: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanmskmin/README.md | 168 +++++++++++ .../ndarray/snanmskmin/benchmark/benchmark.js | 2 +- .../snanmskmin/benchmark/benchmark.native.js | 141 ++++++++++ .../ndarray/snanmskmin/benchmark/c/Makefile | 146 ++++++++++ .../snanmskmin/benchmark/c/benchmark.length.c | 197 +++++++++++++ .../stats/base/ndarray/snanmskmin/binding.gyp | 170 ++++++++++++ .../ndarray/snanmskmin/examples/c/Makefile | 146 ++++++++++ .../ndarray/snanmskmin/examples/c/example.c | 84 ++++++ .../base/ndarray/snanmskmin/include.gypi | 53 ++++ .../stdlib/stats/base/ndarray/snanmskmin.h | 40 +++ .../base/ndarray/snanmskmin/lib/index.js | 16 +- .../base/ndarray/snanmskmin/lib/native.js | 63 +++++ .../base/ndarray/snanmskmin/manifest.json | 110 ++++++++ .../base/ndarray/snanmskmin/package.json | 5 + .../base/ndarray/snanmskmin/src/Makefile | 70 +++++ .../stats/base/ndarray/snanmskmin/src/addon.c | 65 +++++ .../stats/base/ndarray/snanmskmin/src/main.c | 41 +++ .../base/ndarray/snanmskmin/test/test.js | 232 ++-------------- .../base/ndarray/snanmskmin/test/test.main.js | 253 +++++++++++++++++ .../ndarray/snanmskmin/test/test.native.js | 262 ++++++++++++++++++ 20 files changed, 2058 insertions(+), 206 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/include/stdlib/stats/base/ndarray/snanmskmin.h create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/test/test.main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/README.md index 849c3c5adfd4..148bdeec9e08 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskmin/README.md @@ -103,6 +103,174 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/ndarray/snanmskmin.h" +``` + +#### stdlib_stats_snanmskmin( arrays ) + +Computes the minimum value of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values. + +```c +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include + +// Create an ndarray: +const float data[] = { 1.0f, -2.0f, 0.0f/0.0f, 4.0f }; +int64_t shape[] = { 4 }; +int64_t strides[] = { STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT }; +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + +struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Create a mask ndarray: +const uint8_t mdata[] = { 0, 1, 0, 0 }; +int64_t mstrides[] = { STDLIB_NDARRAY_UINT8_BYTES_PER_ELEMENT }; + +struct ndarray *mask = stdlib_ndarray_allocate( STDLIB_NDARRAY_UINT8, mdata, 1, shape, mstrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Compute the minimum value: +const struct ndarray *arrays[] = { x, mask }; +float v = stdlib_stats_snanmskmin( arrays ); +// returns 1.0f + +// Free allocated memory: +stdlib_ndarray_free( x ); +stdlib_ndarray_free( mask ); +``` + +The function accepts the following arguments: + +- **arrays**: `[in] struct ndarray**` list containing the following ndarrays: + + - `[in] struct ndarray*` a one-dimensional input ndarray. + - `[in] struct ndarray*` a one-dimensional mask ndarray. + +```c +float stdlib_stats_snanmskmin( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/ndarray/snanmskmin.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include +#include +#include + +int main( void ) { + // Create a data buffer: + const float data[] = { 1.0f, -2.0f, 3.0f, -4.0f, 0.0f/0.0f, -6.0f, 7.0f, -8.0f }; + + // Specify the number of array dimensions: + const int64_t ndims = 1; + + // Specify the array shape: + int64_t shape[] = { 4 }; + + // Specify the array strides: + int64_t strides[] = { 2*STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT }; + + // Specify the byte offset: + const int64_t offset = 0; + + // Specify the array order: + const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR; + + // Specify the index mode: + const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR; + + // Specify the subscript index modes: + int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + const int64_t nsubmodes = 1; + + // Create an ndarray: + struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + if ( x == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Create a mask ndarray: + const uint8_t mdata[] = { 0, 1, 0, 0 }; + int64_t mstrides[] = { STDLIB_NDARRAY_UINT8_BYTES_PER_ELEMENT }; + struct ndarray *mask = stdlib_ndarray_allocate( STDLIB_NDARRAY_UINT8, mdata, ndims, shape, mstrides, offset, order, imode, nsubmodes, submodes ); + if ( mask == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { x, mask }; + + // Compute the minimum value: + float v = stdlib_stats_snanmskmin( arrays ); + + // Print the result: + printf( "min: %f\n", v ); + + // Free allocated memory: + stdlib_ndarray_free( x ); + stdlib_ndarray_free( mask ); +} +``` + +
+ + + +
+ + + +