@stdlib/math-base-assert-is-probability 0.2.2 → 0.2.4

package/NOTICE

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

package/README.md

@@ -79,18 +79,19 @@ bool = isProbability( NaN );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var isProbability = require( '@stdlib/math-base-assert-is-probability' );
 
-var bool;
-var x;
-var i;
+var opts = {
+    'dtype': 'float64'
+};
+var x = uniform( 100, -1.0, 1.0, opts );
 
-for ( i = 0; i < 100; i++ ) {
-    x = ( randu()*2.0 ) - 1.0;
-    bool = isProbability( x );
-    console.log( '%d is %s', x, ( bool ) ? 'a probability' : 'not a probability' );
+function isProbabilityWrapper( value ) {
+    return ( isProbability( value ) ) ? 'a probability' : 'not a probability';
 }
+logEachMap( '%0.4f is %s', x, isProbabilityWrapper );
 ```
 
 </section>
@@ -128,6 +129,8 @@ for ( i = 0; i < 100; i++ ) {
 Tests if a double-precision floating-point number is a probability.
 
 ```c
+#include <stdbool.h>
+
 bool out = stdlib_base_is_probability( 0.5 );
 // returns true
 
@@ -171,7 +174,7 @@ int main( void ) {
     double x;
     bool v;
     int i;
-    
+
     for ( i = 0; i < 100; i++ ) {
         x = ( ( (double)rand() / (double)RAND_MAX ) * 2.0 ) - 1.0;
         v = stdlib_base_is_probability( x );
@@ -222,7 +225,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>
 
@@ -235,8 +238,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-probability.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-probability
 
-[test-image]: https://github.com/stdlib-js/math-base-assert-is-probability/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/math-base-assert-is-probability/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/math-base-assert-is-probability/actions/workflows/test.yml/badge.svg?branch=v0.2.4
+[test-url]: https://github.com/stdlib-js/math-base-assert-is-probability/actions/workflows/test.yml?query=branch:v0.2.4
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-probability/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-probability?branch=main
@@ -248,8 +251,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
 

package/manifest.json

@@ -1,5 +1,7 @@
 {
-  "options": {},
+  "options": {
+    "task": "build"
+  },
   "fields": [
     {
       "field": "src",
@@ -24,6 +26,36 @@
   ],
   "confs": [
     {
+      "task": "build",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/napi-argv",
+        "@stdlib/napi-argv-double",
+        "@stdlib/napi-create-int32",
+        "@stdlib/napi-export"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": []
+    },
+    {
+      "task": "examples",
       "src": [
         "./src/main.c"
       ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-base-assert-is-probability",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Test if a double-precision floating-point number is a probability.",
   "license": "Apache-2.0",
   "author": {
@@ -33,7 +33,11 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/utils-library-manifest": "^0.2.1"
+    "@stdlib/napi-argv": "^0.2.2",
+    "@stdlib/napi-argv-double": "^0.2.1",
+    "@stdlib/napi-create-int32": "^0.0.3",
+    "@stdlib/napi-export": "^0.3.0",
+    "@stdlib/utils-library-manifest": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {

package/src/addon.c

@@ -17,74 +17,25 @@
 */
 
 #include "stdlib/math/base/assert/is_probability.h"
+#include "stdlib/napi/argv.h"
+#include "stdlib/napi/argv_double.h"
+#include "stdlib/napi/create_int32.h"
+#include "stdlib/napi/export.h"
 #include <node_api.h>
 #include <stdint.h>
-#include <assert.h>
 
 /**
 * Receives JavaScript callback invocation data.
 *
-* @private
 * @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 ) {
-	napi_status status;
-
-	// Get callback arguments:
-	size_t argc = 1;
-	napi_value argv[ 1 ];
-	status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL );
-	assert( status == napi_ok );
-
-	// Check whether we were provided the correct number of arguments:
-	if ( argc < 1 ) {
-		status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-	if ( argc > 1 ) {
-		status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	napi_valuetype vtype0;
-	status = napi_typeof( env, argv[ 0 ], &vtype0 );
-	assert( status == napi_ok );
-	if ( vtype0 != napi_number ) {
-		status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a number." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	double x;
-	status = napi_get_value_double( env, argv[ 0 ], &x );
-	assert( status == napi_ok );
-
-	bool result = stdlib_base_is_probability( x );
-
-	napi_value v;
-	status = napi_create_int32( env, (int32_t)result, &v );
-	assert( status == napi_ok );
-
-	return v;
-}
-
-/**
-* Initializes a Node-API module.
-*
-* @private
-* @param env      environment under which the function is invoked
-* @param exports  exports object
-* @return         main export
-*/
-static napi_value init( napi_env env, napi_value exports ) {
-	napi_value fcn;
-	napi_status status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, addon, NULL, &fcn );
-	assert( status == napi_ok );
-	return fcn;
+	STDLIB_NAPI_ARGV( env, info, argv, argc, 1 );
+	STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 );
+	STDLIB_NAPI_CREATE_INT32( env, (int32_t)stdlib_base_is_probability( x ), out );
+	return out;
 }
 
-NAPI_MODULE( NODE_GYP_MODULE_NAME, init )
+STDLIB_NAPI_MODULE_EXPORT_FCN( addon )

package/src/main.c

@@ -23,7 +23,7 @@
 * Tests if a double-precision floating-point number is a probability.
 *
 * @param x    input value
-* @return	  output value
+* @return     output value
 *
 * @example
 * #include <stdbool.h>
@@ -35,5 +35,5 @@
 * // returns false
 */
 bool stdlib_base_is_probability( const double x ) {
-    return ( x >= 0.0 && x <= 1.0 );
+	return ( x >= 0.0 && x <= 1.0 );
 }