refactor: use in-house macros for building native addon bindings

anandkaranubc · anandkaranubc · commit 63b7891a0338 · 2025-05-27T11:56:50.000-07:00
---
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: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: passed
  - 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/math/base/special/frexp/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/frexp/benchmark/benchmark.js
@@ -21,7 +21,7 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var isArray = require( '@stdlib/assert/is-array' );
 var pkg = require( './../package.json' ).name;
 var frexp = require( './../lib' );
@@ -34,11 +34,12 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = uniform( 100, -5.0e6, 5.0e6 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu()*1.0e7 ) - 5.0e6;
-		y = frexp( x );
-		if ( typeof out !== 'object' ) {
+		y = frexp( x[ i%x.length ] );
+		if ( typeof y !== 'object' ) {
 			b.fail( 'should return an array' );
 		}
 	}
@@ -57,11 +58,11 @@ bench( pkg+':assign', function benchmark( b ) {
 	var i;
 
 	out = [ 0.0, 0.0 ];
+	x = uniform( 100, -5.0e6, 5.0e6 );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu()*1.0e7 ) - 5.0e6;
-		y = frexp.assign( x, out, 1, 0 );
+		y = frexp.assign( x[ i%x.length ], out, 1, 0 );
 		if ( typeof out !== 'object' ) {
 			b.fail( 'should return an array' );
 		}
diff --git a/lib/node_modules/@stdlib/math/base/special/frexp/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/frexp/benchmark/benchmark.native.js
@@ -22,8 +22,8 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
-var isArray = require( '@stdlib/assert/is-array' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isFloat64Array = require( '@stdlib/assert/is-float64array' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -43,17 +43,18 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = uniform( 100, -5.0e6, 5.0e6 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu()*1.0e7 ) - 5.0e6;
-		y = frexp( x );
+		y = frexp( x[ i%x.length ] );
 		if ( typeof y !== 'object' ) {
-			b.fail( 'should return an array' );
+			b.fail( 'should return an object' );
 		}
 	}
 	b.toc();
-	if ( !isArray( y ) ) {
-		b.fail( 'should return an array' );
+	if ( !isFloat64Array( y ) ) {
+		b.fail( 'should return a Float64Array' );
 	}
 	b.pass( 'benchmark finished' );
 	b.end();
diff --git a/lib/node_modules/@stdlib/math/base/special/frexp/lib/native.js b/lib/node_modules/@stdlib/math/base/special/frexp/lib/native.js
@@ -31,36 +31,36 @@ var addon = require( './../src/addon.node' );
 *
 * @private
 * @param {number} x - input value
-* @returns {Array<number>} output array
+* @returns {Float64Array} output array
 *
 * @example
 * var out = frexp( 4.0 );
-* // returns [ 0.5, 3 ]
+* // returns <Float64Array>[ 0.5, 3 ]
 *
 * @example
 * var out = frexp( 0.0 );
-* // returns [ 0.0, 0 ]
+* // returns <Float64Array>[ 0.0, 0 ]
 *
 * @example
 * var out = frexp( -0.0 );
-* // returns [ -0.0, 0 ]
+* // returns <Float64Array>[ -0.0, 0 ]
 *
 * @example
 * var out = frexp( NaN );
-* // returns [ NaN, 0 ]
+* // returns <Float64Array>[ NaN, 0 ]
 *
 * @example
 * var out = frexp( Infinity );
-* // returns [ Infinity , 0 ]
+* // returns <Float64Array>[ Infinity , 0 ]
 *
 * @example
 * var out = frexp( -Infinity );
-* // returns [ -Infinity , 0 ]
+* // returns <Float64Array>[ -Infinity , 0 ]
 */
 function frexp( x ) {
 	var out = new Float64Array( 2 );
-	addon( out, x );
-	return [ out[ 0 ], out[ 1 ] ];
+	addon( x, out );
+	return out;
 }
 
 
diff --git a/lib/node_modules/@stdlib/math/base/special/frexp/manifest.json b/lib/node_modules/@stdlib/math/base/special/frexp/manifest.json
@@ -1,5 +1,7 @@
 {
-  "options": {},
+  "options": {
+    "task": "build"
+  },
   "fields": [
     {
       "field": "src",
@@ -24,6 +26,7 @@
   ],
   "confs": [
     {
+      "task": "build",
       "src": [
         "./src/main.c"
       ],
@@ -33,15 +36,55 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
+        "@stdlib/napi/argv",
+        "@stdlib/napi/argv-double",
+        "@stdlib/napi/argv-float64array",
+        "@stdlib/napi/export",
         "@stdlib/math/base/assert/is-infinite",
         "@stdlib/math/base/assert/is-nan",
-        "@stdlib/math/base/special/abs",
         "@stdlib/number/float64/base/normalize",
         "@stdlib/number/float64/base/exponent",
         "@stdlib/number/float64/base/from-words",
-        "@stdlib/number/float32/base/to-word"
+        "@stdlib/number/float64/base/to-words"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/assert/is-infinite",
+        "@stdlib/math/base/assert/is-nan",
+        "@stdlib/number/float64/base/normalize",
+        "@stdlib/number/float64/base/exponent",
+        "@stdlib/number/float64/base/from-words",
+        "@stdlib/number/float64/base/to-words"
+      ]
+    },
+    {
+      "task": "examples",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/assert/is-infinite",
+        "@stdlib/math/base/assert/is-nan",
+        "@stdlib/number/float64/base/normalize",
+        "@stdlib/number/float64/base/exponent",
+        "@stdlib/number/float64/base/from-words",
+        "@stdlib/number/float64/base/to-words"
       ]
     }
   ]
 }
-
diff --git a/lib/node_modules/@stdlib/math/base/special/frexp/src/addon.c b/lib/node_modules/@stdlib/math/base/special/frexp/src/addon.c
@@ -17,9 +17,12 @@
 */
 
 #include "stdlib/math/base/special/frexp.h"
+#include "stdlib/napi/argv.h"
+#include "stdlib/napi/argv_double.h"
+#include "stdlib/napi/argv_float64array.h"
+#include "stdlib/napi/export.h"
 #include <node_api.h>
 #include <stdint.h>
-#include <assert.h>
 
 /**
 * Receives JavaScript callback invocation data.
@@ -29,87 +32,13 @@
 * @return       Node-API value
 */
 static napi_value addon( napi_env env, napi_callback_info info ) {
-	napi_status status;
-
-	// Get callback arguments:
-	size_t argc = 2;
-	napi_value argv[ 2 ];
-	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 < 2 ) {
-		status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-	if ( argc > 2 ) {
-		status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	bool res;
-	status = napi_is_typedarray( env, argv[ 0 ], &res );
-	assert( status == napi_ok );
-	if ( res == false ) {
-		status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a Float64Array." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	napi_valuetype vtype1;
-	status = napi_typeof( env, argv[ 1 ], &vtype1 );
-	assert( status == napi_ok );
-	if ( vtype1 != napi_number ) {
-		status = napi_throw_type_error( env, NULL, "invalid argument. Second argument must be a number." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	napi_typedarray_type vtype0;
-	size_t len;
-	void *Out;
-	status = napi_get_typedarray_info( env, argv[ 0 ], &vtype0, &len, &Out, NULL, NULL );
-	assert( status == napi_ok );
-	if ( vtype0 != napi_float64_array ) {
-		status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a Float64Array." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-	if ( len != 2 ) {
-		status = napi_throw_range_error( env, NULL, "invalid argument. First argument must have 2 elements." );
-		assert( status == napi_ok );
-		return NULL;
-	}
-
-	double value;
-	status = napi_get_value_double( env, argv[ 1 ], &value );
-	assert( status == napi_ok );
-
-	double frac;
 	int32_t exp;
-	stdlib_base_frexp( value, &frac, &exp );
-
-	double *op = (double *)Out;
-	op[ 0 ] = frac;
-	op[ 1 ] = (double)exp;
-
+	STDLIB_NAPI_ARGV( env, info, argv, argc, 2 );
+	STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 );
+	STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, y, ylen, argv, 1 );
+	stdlib_base_frexp( x, &y[ 0 ], &exp );
+	y[ 1 ] = (double)exp;
 	return NULL;
 }
 
-/**
-* Initializes a Node-API module.
-*
-* @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;
-}
-
-NAPI_MODULE( NODE_GYP_MODULE_NAME, init )
+STDLIB_NAPI_MODULE_EXPORT_FCN( addon )

Original file line number	Diff line number	Diff line change
`@@ -31,36 +31,36 @@ var addon = require( './../src/addon.node' );`
`31`	`31`	`*`
`32`	`32`	`* @private`
`33`	`33`	`* @param {number} x - input value`
`34`		`-* @returns {Array<number>} output array`
	`34`	`+* @returns {Float64Array} output array`
`35`	`35`	`*`
`36`	`36`	`* @example`
`37`	`37`	`* var out = frexp( 4.0 );`
`38`		`-* // returns [ 0.5, 3 ]`
	`38`	`+* // returns <Float64Array>[ 0.5, 3 ]`
`39`	`39`	`*`
`40`	`40`	`* @example`
`41`	`41`	`* var out = frexp( 0.0 );`
`42`		`-* // returns [ 0.0, 0 ]`
	`42`	`+* // returns <Float64Array>[ 0.0, 0 ]`
`43`	`43`	`*`
`44`	`44`	`* @example`
`45`	`45`	`* var out = frexp( -0.0 );`
`46`		`-* // returns [ -0.0, 0 ]`
	`46`	`+* // returns <Float64Array>[ -0.0, 0 ]`
`47`	`47`	`*`
`48`	`48`	`* @example`
`49`	`49`	`* var out = frexp( NaN );`
`50`		`-* // returns [ NaN, 0 ]`
	`50`	`+* // returns <Float64Array>[ NaN, 0 ]`
`51`	`51`	`*`
`52`	`52`	`* @example`
`53`	`53`	`* var out = frexp( Infinity );`
`54`		`-* // returns [ Infinity , 0 ]`
	`54`	`+* // returns <Float64Array>[ Infinity , 0 ]`
`55`	`55`	`*`
`56`	`56`	`* @example`
`57`	`57`	`* var out = frexp( -Infinity );`
`58`		`-* // returns [ -Infinity , 0 ]`
	`58`	`+* // returns <Float64Array>[ -Infinity , 0 ]`
`59`	`59`	`*/`
`60`	`60`	`function frexp( x ) {`
`61`	`61`	`var out = new Float64Array( 2 );`
`62`		`- addon( out, x );`
`63`		`- return [ out[ 0 ], out[ 1 ] ];`
	`62`	`+ addon( x, out );`
	`63`	`+ return out;`
`64`	`64`	`}`
`65`	`65`
`66`	`66`