feat: add C ndarray interface and refactor implementation

aayush0325 · aayush0325 · commit c780e169ac79 · 2025-01-13T07:51:15.000Z
---
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: passed
  - 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
---
diff --git a/lib/node_modules/@stdlib/stats/base/dmeanli/include/stdlib/stats/base/dmeanli.h b/lib/node_modules/@stdlib/stats/base/dmeanli/include/stdlib/stats/base/dmeanli.h
@@ -19,7 +19,7 @@
 #ifndef STDLIB_STATS_BASE_DMEANLI_H
 #define STDLIB_STATS_BASE_DMEANLI_H
 
-#include <stdint.h>
+#include "stdlib/blas/base/shared.h"
 
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
@@ -31,7 +31,12 @@ extern "C" {
 /**
 * Computes the arithmetic mean of a double-precision floating-point strided array using a one-pass trial mean algorithm.
 */
-double stdlib_strided_dmeanli( const int64_t N, const double *X, const int64_t stride );
+double API_SUFFIX(stdlib_strided_dmeanli)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
+
+/**
+* Computes the arithmetic mean of a double-precision floating-point strided array using a one-pass trial mean algorithm and alternative indexing semantics.
+*/
+double API_SUFFIX(stdlib_strided_dmeanli_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
 
 #ifdef __cplusplus
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dmeanli/manifest.json b/lib/node_modules/@stdlib/stats/base/dmeanli/manifest.json
@@ -1,6 +1,7 @@
 {
   "options": {
-    "task": "build"
+    "task": "build",
+    "wasm": false
   },
   "fields": [
     {
@@ -27,17 +28,18 @@
   "confs": [
     {
       "task": "build",
+      "wasm": false,
       "src": [
-        "./src/dmeanli.c"
+        "./src/main.c"
       ],
       "include": [
         "./include"
       ],
-      "libraries": [
-        "-lm"
-      ],
+      "libraries": [],
       "libpath": [],
       "dependencies": [
+        "@stdlib/blas/base/shared",
+        "@stdlib/strided/base/stride2offset",
         "@stdlib/blas/ext/base/dapxsum",
         "@stdlib/napi/export",
         "@stdlib/napi/argv",
@@ -48,33 +50,52 @@
     },
     {
       "task": "benchmark",
+      "wasm": false,
       "src": [
-        "./src/dmeanli.c"
+        "./src/main.c"
       ],
       "include": [
         "./include"
       ],
-      "libraries": [
-        "-lm"
-      ],
+      "libraries": [],
       "libpath": [],
       "dependencies": [
+        "@stdlib/blas/base/shared",
+        "@stdlib/strided/base/stride2offset",
         "@stdlib/blas/ext/base/dapxsum"
       ]
     },
     {
       "task": "examples",
+      "wasm": false,
       "src": [
-        "./src/dmeanli.c"
+        "./src/main.c"
       ],
       "include": [
         "./include"
       ],
-      "libraries": [
-        "-lm"
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/blas/base/shared",
+        "@stdlib/strided/base/stride2offset",
+        "@stdlib/blas/ext/base/dapxsum"
+      ]
+    },
+    {
+      "task": "",
+      "wasm": true,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
       ],
+      "libraries": [],
       "libpath": [],
       "dependencies": [
+        "@stdlib/blas/base/shared",
+        "@stdlib/strided/base/stride2offset",
         "@stdlib/blas/ext/base/dapxsum"
       ]
     }
diff --git a/lib/node_modules/@stdlib/stats/base/dmeanli/src/addon.c b/lib/node_modules/@stdlib/stats/base/dmeanli/src/addon.c
@@ -17,6 +17,7 @@
 */
 
 #include "stdlib/stats/base/dmeanli.h"
+#include "stdlib/blas/base/shared.h"
 #include "stdlib/napi/export.h"
 #include "stdlib/napi/argv.h"
 #include "stdlib/napi/argv_int64.h"
@@ -34,10 +35,27 @@
 static napi_value addon( napi_env env, napi_callback_info info ) {
 	STDLIB_NAPI_ARGV( env, info, argv, argc, 3 );
 	STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 );
-	STDLIB_NAPI_ARGV_INT64( env, stride, argv, 2 );
-	STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, stride, argv, 1 );
-	STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmeanli( N, X, stride ), v );
+	STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 );
+	STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 );
+	STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dmeanli)( N, X, strideX ), v );
 	return v;
 }
 
-STDLIB_NAPI_MODULE_EXPORT_FCN( addon )
+/**
+* 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_method( napi_env env, napi_callback_info info ) {
+	STDLIB_NAPI_ARGV( env, info, argv, argc, 4 );
+	STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 );
+	STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 );
+	STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 );
+	STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 );
+	STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dmeanli_ndarray)( N, X, strideX, offsetX ), v );
+	return v;
+}
+
+STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method )
diff --git a/lib/node_modules/@stdlib/stats/base/dmeanli/src/main.c b/lib/node_modules/@stdlib/stats/base/dmeanli/src/main.c
@@ -18,7 +18,8 @@
 
 #include "stdlib/stats/base/dmeanli.h"
 #include "stdlib/blas/ext/base/dapxsum.h"
-#include <stdint.h>
+#include "stdlib/blas/base/shared.h"
+#include "stdlib/strided/base/stride2offset.h"
 
 /**
 * Computes the arithmetic mean of a double-precision floating-point strided array using a one-pass trial mean algorithm.
@@ -27,24 +28,31 @@
 *
 * -   Ling, Robert F. 1974. "Comparison of Several Algorithms for Computing Sample Means and Variances." _Journal of the American Statistical Association_ 69 (348). American Statistical Association, Taylor & Francis, Ltd.: 859–66. doi:[10.2307/2286154](https://doi.org/10.2307/2286154).
 *
-* @param N       number of indexed elements
-* @param X       input array
-* @param stride  stride length
-* @return        output value
+* @param N        number of indexed elements
+* @param X        input array
+* @param strideX  stride length
+* @return         output value
 */
-double stdlib_strided_dmeanli( const int64_t N, const double *X, const int64_t stride ) {
-	int64_t ix;
+double API_SUFFIX(stdlib_strided_dmeanli)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) {
+	const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX );
+	return API_SUFFIX(stdlib_strided_dmeanli_ndarray)( N, X, strideX, ox );
+}
 
+/**
+* Computes the arithmetic mean of a double-precision floating-point strided array using a one-pass trial mean algorithm and alternative indexing semantics.
+*
+* @param N        number of indexed elements
+* @param X        input array
+* @param strideX  stride length
+* @param offsetX  starting index for X
+* @return         output value
+*/
+double API_SUFFIX(stdlib_strided_dmeanli_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {
 	if ( N <= 0 ) {
 		return 0.0 / 0.0; // NaN
 	}
-	if ( N == 1 || stride == 0 ) {
-		return X[ 0 ];
-	}
-	if ( stride < 0 ) {
-		ix = (1-N) * stride;
-	} else {
-		ix = 0;
+	if ( N == 1 || strideX == 0 ) {
+		return X[ offsetX ];
 	}
-	return X[ ix ] + ( stdlib_strided_dapxsum( N-1, -X[ ix ], X+( (stride > 0) ? stride : 0 ), stride ) / (double)N );
+	return X[ offsetX ] + ( API_SUFFIX(stdlib_strided_dapxsum_ndarray)( N-1, -X[ offsetX ], X, strideX, offsetX + strideX ) / (double)N );
 }
