@stdlib/stats-base-snanvariance 0.2.2 → 0.2.3

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -243,10 +243,10 @@ console.log( v );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats-base/dnanvariance`][@stdlib/stats/base/dnanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats-base/nanvariance`][@stdlib/stats/base/nanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values.</span>
+-   <span class="package-name">[`@stdlib/stats-strided/dnanvariance`][@stdlib/stats/strided/dnanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values.</span>
+-   <span class="package-name">[`@stdlib/stats-strided/nanvariance`][@stdlib/stats/strided/nanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values.</span>
 -   <span class="package-name">[`@stdlib/stats-base/snanstdev`][@stdlib/stats/base/snanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats-base/svariance`][@stdlib/stats/base/svariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array.</span>
+-   <span class="package-name">[`@stdlib/stats-strided/svariance`][@stdlib/stats/strided/svariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array.</span>
 
 </section>
 
@@ -278,7 +278,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -291,8 +291,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanvariance.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanvariance
 
-[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml?query=branch:v0.2.3
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanvariance/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanvariance?branch=main
@@ -304,8 +304,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -332,13 +332,13 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 <!-- <related-links> -->
 
-[@stdlib/stats/base/dnanvariance]: https://www.npmjs.com/package/@stdlib/stats-base-dnanvariance
+[@stdlib/stats/strided/dnanvariance]: https://www.npmjs.com/package/@stdlib/stats-strided-dnanvariance
 
-[@stdlib/stats/base/nanvariance]: https://www.npmjs.com/package/@stdlib/stats-base-nanvariance
+[@stdlib/stats/strided/nanvariance]: https://www.npmjs.com/package/@stdlib/stats-strided-nanvariance
 
 [@stdlib/stats/base/snanstdev]: https://www.npmjs.com/package/@stdlib/stats-base-snanstdev
 
-[@stdlib/stats/base/svariance]: https://www.npmjs.com/package/@stdlib/stats-base-svariance
+[@stdlib/stats/strided/svariance]: https://www.npmjs.com/package/@stdlib/stats-strided-svariance
 
 <!-- </related-links> -->
 

package/include/stdlib/stats/base/snanvariance.h

@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Header file containing function declarations.
-*/
 #ifndef STDLIB_STATS_BASE_SNANVARIANCE_H
 #define STDLIB_STATS_BASE_SNANVARIANCE_H
 

package/manifest.json

@@ -1,42 +1,83 @@
 {
-	"options": {},
-	"fields": [
-		{
-			"field": "src",
-			"resolve": true,
-			"relative": true
-		},
-		{
-			"field": "include",
-			"resolve": true,
-			"relative": true
-		},
-		{
-			"field": "libraries",
-			"resolve": false,
-			"relative": false
-		},
-		{
-			"field": "libpath",
-			"resolve": true,
-			"relative": false
-		}
-	],
-	"confs": [
-		{
-			"src": [
-				"./src/snanvariance.c"
-			],
-			"include": [
-				"./include"
-			],
-			"libraries": [
-				"-lm"
-			],
-			"libpath": [],
-			"dependencies": [
-				"@stdlib/stats-base-snanvariancepn"
-			]
-		}
-	]
+  "options": {
+    "task": "build"
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "task": "build",
+      "src": [
+        "./src/snanvariance.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/napi-export",
+        "@stdlib/napi-argv",
+        "@stdlib/napi-argv-int64",
+        "@stdlib/napi-argv-float",
+        "@stdlib/napi-argv-strided-float32array",
+        "@stdlib/stats-base-snanvariancepn",
+        "@stdlib/napi-create-double"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "src": [
+        "./src/snanvariance.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/stats-base-snanvariancepn"
+      ]
+    },
+    {
+      "task": "examples",
+      "src": [
+        "./src/snanvariance.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/stats-base-snanvariancepn"
+      ]
+    }
+  ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-snanvariance",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Calculate the variance of a single-precision floating-point strided array ignoring NaN values.",
   "license": "Apache-2.0",
   "author": {
@@ -34,11 +34,17 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-error": "^0.2.2",
-    "@stdlib/stats-base-snanvariancepn": "^0.2.1",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
-    "@stdlib/utils-library-manifest": "^0.2.2",
-    "@stdlib/utils-try-require": "^0.2.2"
+    "@stdlib/assert-is-error": "^0.2.3",
+    "@stdlib/napi-argv": "^0.2.3",
+    "@stdlib/napi-argv-float": "^0.2.3",
+    "@stdlib/napi-argv-int64": "^0.2.3",
+    "@stdlib/napi-argv-strided-float32array": "^0.2.3",
+    "@stdlib/napi-create-double": "^0.0.3",
+    "@stdlib/napi-export": "^0.3.1",
+    "@stdlib/stats-base-snanvariancepn": "^0.2.2",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3",
+    "@stdlib/utils-library-manifest": "^0.2.4",
+    "@stdlib/utils-try-require": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {
@@ -81,7 +87,6 @@
     "single",
     "float32array"
   ],
-  "__stdlib__": {},
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/stdlib"

package/src/addon.c

@@ -0,0 +1,45 @@
+/**
+* @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.
+*/
+
+#include "stdlib/stats/base/snanvariance.h"
+#include "stdlib/napi/export.h"
+#include "stdlib/napi/argv.h"
+#include "stdlib/napi/argv_int64.h"
+#include "stdlib/napi/argv_float.h"
+#include "stdlib/napi/argv_strided_float32array.h"
+#include "stdlib/napi/create_double.h"
+#include <node_api.h>
+
+/**
+* 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, 4 );
+	STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 );
+	STDLIB_NAPI_ARGV_FLOAT( env, correction, argv, 1 );
+	STDLIB_NAPI_ARGV_INT64( env, stride, argv, 3 );
+	STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, stride, argv, 2 );
+	STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_snanvariance( N, correction, X, stride ), v );
+	return v;
+}
+
+STDLIB_NAPI_MODULE_EXPORT_FCN( addon )

package/src/addon.cpp

@@ -1,130 +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/snanvariance.h"
-#include <node_api.h>
-#include <stdint.h>
-#include <stdlib.h>
-#include <stdbool.h>
-#include <assert.h>
-
-/**
-* Add-on namespace.
-*/
-namespace stdlib_stats_base_snanvariance {
-
-	/**
-	* Computes the variance of a single-precision floating-point strided array ignoring `NaN` values.
-	*
-	* ## Notes
-	*
-	* -   When called from JavaScript, the function expects four arguments:
-	*
-	*     -   `N`: number of indexed elements
-	*     -   `correction`: degrees of freedom adjustment
-	*     -   `X`: input array
-	*     -   `stride`: stride length
-	*/
-	napi_value node_snanvariance( napi_env env, napi_callback_info info ) {
-		napi_status status;
-
-		size_t argc = 4;
-		napi_value argv[ 4 ];
-		status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr );
-		assert( status == napi_ok );
-
-		if ( argc < 4 ) {
-			napi_throw_error( env, nullptr, "invalid invocation. Must provide 4 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;
-		}
-
-		napi_valuetype vtype1;
-		status = napi_typeof( env, argv[ 1 ], &vtype1 );
-		assert( status == napi_ok );
-		if ( vtype1 != napi_number ) {
-			napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a number." );
-			return nullptr;
-		}
-
-		bool res;
-		status = napi_is_typedarray( env, argv[ 2 ], &res );
-		assert( status == napi_ok );
-		if ( res == false ) {
-			napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a Float32Array." );
-			return nullptr;
-		}
-
-		napi_valuetype vtype3;
-		status = napi_typeof( env, argv[ 3 ], &vtype3 );
-		assert( status == napi_ok );
-		if ( vtype3 != napi_number ) {
-			napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a number." );
-			return nullptr;
-		}
-
-		int64_t N;
-		status = napi_get_value_int64( env, argv[ 0 ], &N );
-		assert( status == napi_ok );
-
-		double correction;
-		status = napi_get_value_double( env, argv[ 1 ], &correction );
-		assert( status == napi_ok );
-
-		int64_t stride;
-		status = napi_get_value_int64( env, argv[ 3 ], &stride );
-		assert( status == napi_ok );
-
-		napi_typedarray_type vtype2;
-		size_t xlen;
-		void *X;
-		status = napi_get_typedarray_info( env, argv[ 2 ], &vtype2, &xlen, &X, nullptr, nullptr );
-		assert( status == napi_ok );
-		if ( vtype2 != napi_float32_array ) {
-			napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a Float32Array." );
-			return nullptr;
-		}
-		if ( (N-1)*llabs(stride) >= (int64_t)xlen ) {
-			napi_throw_range_error( env, nullptr, "invalid argument. Third 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_snanvariance( N, (float)correction, (float *)X, stride ), &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_snanvariance, NULL, &fcn );
-		assert( status == napi_ok );
-		return fcn;
-	}
-
-	NAPI_MODULE( NODE_GYP_MODULE_NAME, Init )
-} // end namespace stdlib_stats_base_snanvariance