math-base-napi-binary

C APIs for registering an N-API module exporting an interface for invoking a binary numerical function.

https://github.com/stdlib-js/math-base-napi-binary

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

addon binary javascript map math mathematics n-api napi node node-js nodejs stdlib transform
Last synced: 4 months ago · JSON representation ·

Repository

C APIs for registering an N-API module exporting an interface for invoking a binary numerical function.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
addon binary javascript map math mathematics n-api napi node node-js nodejs stdlib transform
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

binary

NPM version Build Status Coverage Status <!-- dependencies -->

C APIs for registering a Node-API module exporting interfaces for invoking binary numerical functions.

## Installation ```bash npm install @stdlib/math-base-napi-binary ```
## Usage ```javascript var headerDir = require( '@stdlib/math-base-napi-binary' ); ``` #### headerDir Absolute file path for the directory containing header files for C APIs. ```javascript var dir = headerDir; // returns ```
## Examples ```javascript var headerDir = require( '@stdlib/math-base-napi-binary' ); console.log( headerDir ); // => ```

## C APIs
### Usage ```c #include "stdlib/math/base/napi/binary.h" ``` #### STDLIB_MATH_BASE_NAPI_MODULE_BB_B( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning unsigned 8-bit integers. ```c #include static uint8_t add( const uint8_t x, const uint8_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_BB_B( add ); ``` The macro expects the following arguments: - **fcn**: `uint8_t (*fcn)( uint8_t, uint8_t )` binary 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_bb_b( env, info, fcn ) Invokes a binary function accepting and returning unsigned 8-bit integers. ```c #include #include // ... static uint8_t add( const uint8_t x, const uint8_t y ) { return x + y; } // ... /** * 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_bb_b( 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] uint8_t (*fcn)( uint8_t, uint8_t )` binary function. ```c void stdlib_math_base_napi_bb_b( napi_env env, napi_callback_info info, uint8_t (*fcn)( uint8_t, uint8_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_CC_C( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning single-precision complex floating-point numbers. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" static stdlib_complex64_t add( const stdlib_complex64_t x, const stdlib_complex64_t y ) { float xre; float xim; float yre; float yim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); stdlib_complex64_reim( y, &yre, &yim ); re = xre + yre; im = xim + yim; return stdlib_complex64( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_CC_C( add ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t )` binary 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_cc_c( env, info, fcn ) Invokes a binary function accepting and returning single-precision complex floating-point numbers. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include // ... static stdlib_complex64_t add( const stdlib_complex64_t x, const stdlib_complex64_t y ) { float xre; float xim; float yre; float yim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); stdlib_complex64_reim( y, &yre, &yim ); re = xre + yre; im = xim + yim; return stdlib_complex64( re, im ); } // ... /** * 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_cc_c( 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] stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t )` binary function. ```c void stdlib_math_base_napi_cc_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_CF_C( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a single-precision complex floating-point number and a single-precision floating-point number and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" static stdlib_complex64_t add( const stdlib_complex64_t x, const float y ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_CF_C( add ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex64_t (*fcn)( stdlib_complex64_t, float )` binary 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_cf_c( env, info, fcn ) Invokes a binary function accepting a single-precision complex floating-point number and a single-precision floating-point number and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" #include // ... static stdlib_complex64_t mul( const stdlib_complex64_t x, const float y ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... /** * 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_cf_c( env, info, mul ); } // ... ``` 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] stdlib_complex64_t (*fcn)( stdlib_complex64_t, float )` binary function. ```c void stdlib_math_base_napi_cf_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( stdlib_complex64_t, float ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_CI_C( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a single-precision complex floating-point number and a signed 32-bit integer and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" #include static stdlib_complex64_t add( const stdlib_complex64_t x, const int32_t y ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_CI_C( add ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex64_t (*fcn)( stdlib_complex64_t, int32_t )` binary 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_ci_c( env, info, fcn ) Invokes a binary function accepting a single-precision complex floating-point number and a signed 32-bit integer and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float32/reim.h" #include #include // ... static stdlib_complex64_t mul( const stdlib_complex64_t x, const int32_t y ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... /** * 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_ci_c( env, info, mul ); } // ... ``` 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] stdlib_complex64_t (*fcn)( stdlib_complex64_t, int32_t )` binary function. ```c void stdlib_math_base_napi_ci_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( stdlib_complex64_t, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_DD_D( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning double-precision floating-point numbers. ```c static double add( const double x, const double y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_DD_D( add ); ``` The macro expects the following arguments: - **fcn**: `double (*fcn)( double, double )` binary 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_dd_d( env, info, fcn ) Invokes a binary function accepting and returning double-precision floating-point numbers. ```c #include // ... static double add( const double x, const double y ) { return x + y; } // ... /** * 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_dd_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, double )` binary function. ```c void stdlib_math_base_napi_dd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_DI_D( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a double-precision floating-point number and a signed 32-bit integer and returning a double-precision floating-point number. ```c #include static double mul( const double x, const int32_t y ) { return x * y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_DI_D( mul ); ``` The macro expects the following arguments: - **fcn**: `double (*fcn)( double, int32_t )` binary 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_di_d( env, info, fcn ) Invokes a binary function accepting a double-precision floating-point number and a signed 32-bit integer and returning a double-precision floating-point number. ```c #include #include // ... static double mul( const double x, const int32_t y ) { return x * y; } // ... /** * 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_di_d( env, info, mul ); } // ... ``` 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 )` binary function. ```c void stdlib_math_base_napi_di_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_DZ_Z( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a double-precision complex floating-point number and a double-precision floating-point number and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" static stdlib_complex128_t mul( const double y, const stdlib_complex128_t x ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_DZ_Z( mul ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex128_t (*fcn)( double, stdlib_complex128_t )` binary 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_dz_z( env, info, fcn ) Invokes a binary function accepting a double-precision floating-point number and a double-precision complex floating-point number and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include // ... static stdlib_complex128_t mul( const double y, const stdlib_complex128_t x ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... /** * 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_dz_z( env, info, mul ); } // ... ``` 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] stdlib_complex128_t (*fcn)( double, stdlib_complex128_t )` binary function. ```c void stdlib_math_base_napi_dz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( double, stdlib_complex128_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_FC_C( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a single-precision complex floating-point number and a single-precision floating-point number and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" static stdlib_complex64_t mul( const float y, const stdlib_complex64_t x ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_FC_C( mul ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex64_t (*fcn)( float, stdlib_complex64_t )` binary 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_fc_c( env, info, fcn ) Invokes a binary function accepting a single-precision floating-point number and a single-precision complex floating-point number and returning a single-precision complex floating-point number. ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" #include // ... static stdlib_complex64_t mul( const float y, const stdlib_complex64_t x ) { float xre; float xim; float re; float im; stdlib_complex64_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex64( re, im ); } // ... /** * 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_fc_c( env, info, mul ); } // ... ``` 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] stdlib_complex64_t (*fcn)( float, stdlib_complex64_t )` binary function. ```c void stdlib_math_base_napi_fc_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( float, stdlib_complex64_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_FF_F( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning single-precision floating-point numbers. ```c static float addf( const float x, const float y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_FF_F( addf ); ``` The macro expects the following arguments: - **fcn**: `float (*fcn)( float, float )` binary 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_ff_f( env, info, fcn ) Invokes a binary function accepting and returning single-precision floating-point numbers. ```c #include // ... static float addf( const float x, const float y ) { return x + y; } // ... /** * 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_ff_f( env, info, addf ); } // ... ``` 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] float (*fcn)( float, float )` binary function. ```c void stdlib_math_base_napi_ff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_FI_F( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a single-precision floating-point number and a signed 32-bit integer and returning a single-precision floating-point number. ```c #include static float mulf( const float x, const int32_t y ) { return x * y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_FI_F( mulf ); ``` The macro expects the following arguments: - **fcn**: `float (*fcn)( float, int32_t )` binary 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_fi_f( env, info, fcn ) Invokes a binary function accepting a single-precision floating-point number and a signed 32-bit integer and returning a single-precision floating-point number. ```c #include #include // ... static float mulf( const float x, const int32_t y ) { return x * y; } // ... /** * 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_fi_f( env, info, mulf ); } // ... ``` 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] float (*fcn)( float, int32_t )` binary function. ```c void stdlib_math_base_napi_fi_f( napi_env env, napi_callback_info info, float (*fcn)( float, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_ID_D( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a signed 32-bit integer and a double-precision floating-point number and returning a double-precision floating-point number. ```c #include static double mul( const int32_t x, const double y ) { return x * y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_ID_D( mul ); ``` The macro expects the following arguments: - **fcn**: `double (*fcn)( int32_t, double )` binary 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_id_d( env, info, fcn ) Invokes a binary function accepting a signed 32-bit integer and a double-precision floating-point number and returning a double-precision floating-point number. ```c #include #include // ... static double mul( const int32_t x, const double y ) { return x * y; } // ... /** * 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_id_d( env, info, mul ); } // ... ``` 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)( int32_t, double )` binary function. ```c void stdlib_math_base_napi_id_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, double ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_II_D( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting signed 32-bit integers and returning a double-precision floating-point number. ```c #include static double add( const int32_t x, const int32_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_II_D( add ); ``` The macro expects the following arguments: - **fcn**: `double (*fcn)( int32_t, int32_t )` binary 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_ii_d( env, info, fcn ) Invokes a binary function accepting signed 32-bit integers and returning a double-precision floating-point number. ```c #include #include // ... static double mul( const int32_t x, const int32_t y ) { return x * y; } // ... /** * 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_ii_d( env, info, mul ); } // ... ``` 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)( int32_t, int32_t )` binary function. ```c void stdlib_math_base_napi_ii_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting signed 32-bit integers and returning a single-precision floating-point number. ```c #include static float fcn( const int32_t x, const int32_t y ) { // ... } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn ); ``` The macro expects the following arguments: - **fcn**: `float (*fcn)( int32_t, int32_t )` binary 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_ii_f( env, info, fcn ) Invokes a binary function accepting signed 32-bit integers and returning a single-precision floating-point number. ```c #include #include // ... static float fcn( const int32_t x, const int32_t y ) { // ... } // ... /** * 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_ii_f( env, info, fcn ); } // ... ``` 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] float (*fcn)( int32_t, int32_t )` binary function. ```c void stdlib_math_base_napi_ii_f( napi_env env, napi_callback_info info, float (*fcn)( int32_t, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_II_I( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning signed 32-bit integers. ```c #include static int32_t add( const int32_t x, const int32_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_II_I( add ); ``` The macro expects the following arguments: - **fcn**: `int32_t (*fcn)( int32_t, int32_t )` binary 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_ii_i( env, info, fcn ) Invokes a binary function accepting and returning signed 32-bit integers. ```c #include #include // ... static int32_t mul( const int32_t x, const int32_t y ) { return x * y; } // ... /** * 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_ii_i( env, info, mul ); } // ... ``` 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] int32_t (*fcn)( int32_t, int32_t )` binary function. ```c void stdlib_math_base_napi_ii_i( napi_env env, napi_callback_info info, int32_t (*fcn)( int32_t, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_KK_K( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning signed 16-bit integers. ```c #include static int16_t add( const int16_t x, const int16_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_KK_K( add ); ``` The macro expects the following arguments: - **fcn**: `int16_t (*fcn)( int16_t, int16_t )` binary 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_kk_k( env, info, fcn ) Invokes a binary function accepting and returning signed 16-bit integers. ```c #include #include // ... static int16_t add( const int16_t x, const int16_t y ) { return x + y; } // ... /** * 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_kk_k( 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] int16_t (*fcn)( int16_t, int16_t )` binary function. ```c void stdlib_math_base_napi_kk_k( napi_env env, napi_callback_info info, int16_t (*fcn)( int16_t, int16_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_LL_D( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting signed 64-bit integers and returning a double-precision floating-point number. ```c #include static double fcn( const int64_t x, const int64_t y ) { // ... } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_LL_D( fcn ); ``` The macro expects the following arguments: - **fcn**: `double (*fcn)( int64_t, int64_t )` binary 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_ll_d( env, info, fcn ) Invokes a binary function accepting signed 64-bit integers and returning a double-precision floating-point number. ```c #include #include // ... static double fcn( const int64_t x, const int64_t y ) { // ... } // ... /** * 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_ll_d( env, info, fcn ); } // ... ``` 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)( int64_t, int64_t )` binary function. ```c void stdlib_math_base_napi_ll_d( napi_env env, napi_callback_info info, double (*fcn)( int64_t, int64_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_SS_S( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning signed 8-bit integers. ```c #include static int8_t add( const int8_t x, const int8_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_SS_S( add ); ``` The macro expects the following arguments: - **fcn**: `int8_t (*fcn)( int8_t, int8_t )` binary 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_ss_s( env, info, fcn ) Invokes a binary function accepting and returning signed 8-bit integers. ```c #include #include // ... static int8_t add( const int8_t x, const int8_t y ) { return x + y; } // ... /** * 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_ss_s( 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] int8_t (*fcn)( int8_t, int8_t )` binary function. ```c void stdlib_math_base_napi_ss_s( napi_env env, napi_callback_info info, int8_t (*fcn)( int8_t, int8_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_TT_T( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning unsigned 16-bit integers. ```c #include static uint16_t add( const uint16_t x, const uint16_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_TT_T( add ); ``` The macro expects the following arguments: - **fcn**: `uint16_t (*fcn)( uint16_t, uint16_t )` binary 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_tt_t( env, info, fcn ) Invokes a binary function accepting and returning unsigned 16-bit integers. ```c #include #include // ... static uint16_t add( const uint16_t x, const uint16_t y ) { return x + y; } // ... /** * 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_tt_t( 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] uint16_t (*fcn)( uint16_t, uint16_t )` binary function. ```c void stdlib_math_base_napi_tt_t( napi_env env, napi_callback_info info, uint16_t (*fcn)( uint16_t, uint16_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_UU_U( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning unsigned 32-bit integers. ```c #include static uint32_t add( const uint32_t x, const uint32_t y ) { return x + y; } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_UU_U( add ); ``` The macro expects the following arguments: - **fcn**: `uint32_t (*fcn)( uint32_t, uint32_t )` binary 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_uu_u( env, info, fcn ) Invokes a binary function accepting and returning unsigned 32-bit integers. ```c #include #include // ... static uint32_t add( const uint32_t x, const uint32_t y ) { return x + y; } // ... /** * 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_uu_u( 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] uint32_t (*fcn)( uint32_t, uint32_t )` binary function. ```c void stdlib_math_base_napi_uu_u( napi_env env, napi_callback_info info, uint32_t (*fcn)( uint32_t, uint32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_ZD_Z( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a double-precision complex floating-point number and a double-precision floating-point number and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" static stdlib_complex128_t mul( const stdlib_complex128_t x, const double y ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_ZD_Z( mul ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex128_t (*fcn)( stdlib_complex128_t, double )` binary 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_zd_z( env, info, fcn ) Invokes a binary function accepting a double-precision complex floating-point number and a double-precision floating-point number and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include // ... static stdlib_complex128_t mul( const stdlib_complex128_t x, const double y ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... /** * 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_zd_z( env, info, mul ); } // ... ``` 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] stdlib_complex128_t (*fcn)( stdlib_complex128_t, double )` binary function. ```c void stdlib_math_base_napi_zd_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, double ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_ZI_Z( fcn ) Macro for registering a Node-API module exporting an interface invoking a binary function accepting a double-precision complex floating-point number and a signed 32-bit and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include static stdlib_complex128_t mul( const stdlib_complex128_t x, const int32_t y ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_ZI_Z( mul ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex128_t (*fcn)( stdlib_complex128_t, int32_t )` binary 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_zi_z( env, info, fcn ) Invokes a binary function accepting a double-precision complex floating-point number and a signed 32-bit integer and returning a double-precision complex floating-point number. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include #include // ... static stdlib_complex128_t mul( const stdlib_complex128_t x, const int32_t y ) { double xre; double xim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); re = xre * y; im = xim * y; return stdlib_complex128( re, im ); } // ... /** * 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_zi_z( env, info, mul ); } // ... ``` 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] stdlib_complex128_t (*fcn)( stdlib_complex128_t, int32_t )` binary function. ```c void stdlib_math_base_napi_zi_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, int32_t ) ); ``` #### STDLIB_MATH_BASE_NAPI_MODULE_ZZ_Z( fcn ) Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning double-precision complex floating-point numbers. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" static stdlib_complex128_t add( const stdlib_complex128_t x, const stdlib_complex128_t y ) { double xre; double xim; double yre; double yim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); stdlib_complex128_reim( y, &yre, &yim ); re = xre + yre; im = xim + yim; return stdlib_complex128( re, im ); } // ... // Register a Node-API module: STDLIB_MATH_BASE_NAPI_MODULE_ZZ_Z( add ); ``` The macro expects the following arguments: - **fcn**: `stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t )` binary 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_zz_z( env, info, fcn ) Invokes a binary function accepting and returning double-precision complex floating-point numbers. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include // ... static stdlib_complex128_t add( const stdlib_complex128_t x, const stdlib_complex128_t y ) { double xre; double xim; double yre; double yim; double re; double im; stdlib_complex128_reim( x, &xre, &xim ); stdlib_complex128_reim( y, &yre, &yim ); re = xre + yre; im = xim + yim; return stdlib_complex128( re, im ); } // ... /** * 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_zz_z( 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] stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t )` binary function. ```c void stdlib_math_base_napi_zz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t ) ); ```
### Notes - The C-API functions expect that the callback `info` argument provides access to the following JavaScript arguments: - `x`: input value. - `y`: input value.

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 12
Last Year
  • Push event: 12

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 54
  • Total Committers: 1
  • Avg Commits per committer: 54.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 17
  • Committers: 1
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 54
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • @stdlib/assert-is-browser ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/utils-try-require ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/complex-float32 ^0.0.x
  • @stdlib/complex-float64 ^0.0.x
  • @stdlib/complex-reim ^0.0.x
  • @stdlib/complex-reimf ^0.0.x
  • @stdlib/utils-library-manifest ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite