From 3e62adfc8c73cba1e61b7e6ff24bb21c9e41b0f9 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Fri, 28 Feb 2025 22:50:14 -0800 Subject: [PATCH 1/2] feat: add DIII_D macro in quaternary --- 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 --- --- .../stdlib/math/base/napi/quaternary.h | 1 + .../stdlib/math/base/napi/quaternary/diii_d.h | 84 +++++++++++++ .../math/base/napi/quaternary/manifest.json | 1 + .../math/base/napi/quaternary/src/diii_d.c | 112 ++++++++++++++++++ 4 files changed, 198 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary/diii_d.h create mode 100644 lib/node_modules/@stdlib/math/base/napi/quaternary/src/diii_d.c diff --git a/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary.h b/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary.h index 7e1bf338e0ce..921a9c35f2fb 100644 --- a/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary.h +++ b/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary.h @@ -21,6 +21,7 @@ // NOTE: keep in alphabetical order... #include "stdlib/math/base/napi/quaternary/dddd_d.h" +#include "stdlib/math/base/napi/quaternary/diii_d.h" #include "stdlib/math/base/napi/quaternary/ffff_f.h" #endif // !STDLIB_MATH_BASE_NAPI_QUATERNARY_H diff --git a/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary/diii_d.h b/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary/diii_d.h new file mode 100644 index 000000000000..0d7490956c1f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/napi/quaternary/include/stdlib/math/base/napi/quaternary/diii_d.h @@ -0,0 +1,84 @@ +/** +* @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. +*/ + +#ifndef STDLIB_MATH_BASE_NAPI_QUATERNARY_DIII_D_H +#define STDLIB_MATH_BASE_NAPI_QUATERNARY_DIII_D_H + +#include +#include +#include + +/** +* Macro for registering a Node-API module exporting an interface invoking a quaternary function accepting a double-precision floating-point number and three signed 32-bit integers and returning a double-precision floating-point number. +* +* @param fcn quaternary function +* +* @example +* #include +* +* static double add( const double x, const int32_t y, const int32_t z, const int32_t w ) { +* return x + y + z + w; +* } +* +* // ... +* +* // Register a Node-API module: +* STDLIB_MATH_BASE_NAPI_MODULE_DIII_D( add ); +*/ +#define STDLIB_MATH_BASE_NAPI_MODULE_DIII_D( fcn ) \ + static napi_value stdlib_math_base_napi_diii_d_wrapper( \ + napi_env env, \ + napi_callback_info info \ + ) { \ + return stdlib_math_base_napi_diii_d( env, info, fcn ); \ + }; \ + static napi_value stdlib_math_base_napi_diii_d_init( \ + napi_env env, \ + napi_value exports \ + ) { \ + napi_value fcn; \ + napi_status status = napi_create_function( \ + env, \ + "exports", \ + NAPI_AUTO_LENGTH, \ + stdlib_math_base_napi_diii_d_wrapper, \ + NULL, \ + &fcn \ + ); \ + assert( status == napi_ok ); \ + return fcn; \ + }; \ + NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_diii_d_init ) + +/* +* If C++, prevent name mangling so that the compiler emits a quaternary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Invokes a quaternary function accepting a double-precision floating-point number and three signed 32-bit integers and returning a double-precision floating-point number. +*/ +napi_value stdlib_math_base_napi_diii_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t, int32_t, int32_t ) ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_NAPI_QUATERNARY_DIII_D_H diff --git a/lib/node_modules/@stdlib/math/base/napi/quaternary/manifest.json b/lib/node_modules/@stdlib/math/base/napi/quaternary/manifest.json index 7f4f221241b8..f343df6aa8dc 100644 --- a/lib/node_modules/@stdlib/math/base/napi/quaternary/manifest.json +++ b/lib/node_modules/@stdlib/math/base/napi/quaternary/manifest.json @@ -26,6 +26,7 @@ { "src": [ "./src/dddd_d.c", + "./src/diii_d.c", "./src/ffff_f.c" ], "include": [ diff --git a/lib/node_modules/@stdlib/math/base/napi/quaternary/src/diii_d.c b/lib/node_modules/@stdlib/math/base/napi/quaternary/src/diii_d.c new file mode 100644 index 000000000000..0765d6dd814d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/napi/quaternary/src/diii_d.c @@ -0,0 +1,112 @@ +/** +* @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/math/base/napi/quaternary/diii_d.h" +#include +#include +#include + +/** +* Invokes a quaternary function accepting a double-precision floating-point number and three signed 32-bit integers and returning a double-precision floating-point number. +* +* ## Notes +* +* - This function expects that the callback `info` argument provides access to the following JavaScript arguments: +* +* - `x`: input value. +* - `y`: input value. +* - `z`: input value. +* - `w`: input value. +* +* @param env environment under which the function is invoked +* @param info callback data +* @param fcn quaternary function +* @return function return value as a Node-API double-precision floating-point number +*/ +napi_value stdlib_math_base_napi_diii_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t, int32_t, int32_t ) ) { + napi_status status; + + size_t argc = 4; + napi_value argv[ 4 ]; + status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL ); + assert( status == napi_ok ); + + if ( argc < 4 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Must provide four numbers." ); + 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; + } + + 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_valuetype vtype2; + status = napi_typeof( env, argv[ 2 ], &vtype2 ); + assert( status == napi_ok ); + if ( vtype2 != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. Third argument must be a number." ); + assert( status == napi_ok ); + return NULL; + } + + napi_valuetype vtype3; + status = napi_typeof( env, argv[ 3 ], &vtype3 ); + assert( status == napi_ok ); + if ( vtype3 != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. Fourth 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 ); + + int32_t y; + status = napi_get_value_int32( env, argv[ 1 ], &y ); + assert( status == napi_ok ); + + int32_t z; + status = napi_get_value_int32( env, argv[ 2 ], &z ); + assert( status == napi_ok ); + + int32_t w; + status = napi_get_value_int32( env, argv[ 3 ], &w ); + assert( status == napi_ok ); + + napi_value v; + status = napi_create_double( env, fcn( x, y, z, w ), &v ); + assert( status == napi_ok ); + + return v; +} From 63647263726dd3e37ccd1ca2854a2d4391ce1c31 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Fri, 28 Feb 2025 22:50:51 -0800 Subject: [PATCH 2/2] docs: update README with documentation for DIII_D macro --- 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: passed - 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: na - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../math/base/napi/quaternary/README.md | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/napi/quaternary/README.md b/lib/node_modules/@stdlib/math/base/napi/quaternary/README.md index 04327bcc7a50..a2acc38e124f 100644 --- a/lib/node_modules/@stdlib/math/base/napi/quaternary/README.md +++ b/lib/node_modules/@stdlib/math/base/napi/quaternary/README.md @@ -166,6 +166,66 @@ The function accepts the following arguments: void stdlib_math_base_napi_dddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double, double ) ); ``` +#### STDLIB_MATH_BASE_NAPI_MODULE_DIII_D( fcn ) + +Macro for registering a Node-API module exporting an interface invoking a quaternary function accepting a double-precision floating-point number and three signed 32-bit integers and returning a double-precision floating-point number. + +```c +static double add( const double x, const int32_t y, const int32_t z, const int32_t w ) { + return x + y + z + w; +} + +// ... + +// Register a Node-API module: +STDLIB_MATH_BASE_NAPI_MODULE_DIII_D( add ); +``` + +The macro expects the following arguments: + +- **fcn**: `double (*fcn)( double, int32_t, int32_t, int32_t )` quaternary function. + +When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration. + +#### stdlib_math_base_napi_diii_d( env, info, fcn ) + +Invokes a quaternary function accepting a double-precision floating-point number and three signed 32-bit integers and returning a double-precision floating-point number. + +```c +#include + +// ... + +static double add( const double x, const int32_t y, const int32_t z, const int32_t w ) { + return x + y + z + w; +} + +// ... + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +napi_value addon( napi_env env, napi_callback_info info ) { + return stdlib_math_base_napi_diii_d( env, info, add ); +} + +// ... +``` + +The function accepts the following arguments: + +- **env**: `[in] napi_env` environment under which the function is invoked. +- **info**: `[in] napi_callback_info` callback data. +- **fcn**: `[in] double (*fcn)( double, int32_t, int32_t, int32_t )` quaternary function. + +```c +void stdlib_math_base_napi_diii_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t, int32_t, int32_t ) ); +``` + #### STDLIB_MATH_BASE_NAPI_MODULE_FFFF_F( fcn ) Macro for registering a Node-API module exporting an interface for invoking a quaternary function accepting and returning single-precision floating-point numbers.