C APIs for registering a Node-API module exporting an interface for invoking a ternary numerical function.
npm install @stdlib/math-base-napi-ternaryWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> C APIs for registering a Node-API module exporting interfaces for invoking ternary numerical functions.
``bash`
npm install @stdlib/math-base-napi-ternary
`javascript`
var headerDir = require( '@stdlib/math-base-napi-ternary' );
#### headerDir
Absolute file path for the directory containing header files for C APIs.
`javascript`
var dir = headerDir;
// returns
`javascript
var headerDir = require( '@stdlib/math-base-napi-ternary' );
console.log( headerDir );
// =>
`
*
`c`
#include "stdlib/math/base/napi/ternary.h"
#### STDLIB_MATH_BASE_NAPI_MODULE_CCC_C( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary 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, const stdlib_complex64_t z ) {
float xre;
float xim;
float yre;
float yim;
float zre;
float zim;
float re;
float im;
stdlib_complex64_reim( x, &xre, &xim );
stdlib_complex64_reim( y, &yre, &yim );
stdlib_complex64_reim( z, &zre, &zim );
re = xre + yre + zre;
im = xim + yim + zim;
return stdlib_complex64( re, im );
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_CCC_C( add );
`
The macro expects the following arguments:
- fcn: stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t, stdlib_complex64_t ) ternary 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_ccc_c( env, info, fcn )
Invokes a ternary function accepting and returning single-precision complex floating-point numbers.
`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 stdlib_complex64_t y, const stdlib_complex64_t z ) {
float xre;
float xim;
float yre;
float yim;
float zre;
float zim;
float re;
float im;
stdlib_complex64_reim( x, &xre, &xim );
stdlib_complex64_reim( y, &yre, &yim );
stdlib_complex64_reim( z, &zre, &zim );
re = xre + yre + zre;
im = xim + yim + zim;
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_ccc_c( env, info, add );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t, stdlib_complex64_t )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_ccc_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( stdlib_complex64_t, stdlib_complex64_t, stdlib_complex64_t ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning double-precision floating-point numbers.
`c
static double add( const double x, const double y, const double z ) {
return x + y + z;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( add );
`
The macro expects the following arguments:
- fcn: double (*fcn)( double, double, double ) ternary 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_ddd_d( env, info, fcn )
Invokes a ternary function accepting and returning double-precision floating-point numbers.
`c
#include
// ...
static double add( const double x, const double y, const double z ) {
return x + y + z;
}
// ...
/**
* 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_ddd_d( env, info, add );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] double (*fcn)( double, double, double )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_ddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_DID_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting a double-precision floating-point number, a signed 32-bit integer, and a double-precision floating-point number and returning a double-precision floating-point number.
`c
#include
static double fcn( const double x, const int32_t y, const double z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DID_D( fcn );
`
The macro expects the following arguments:
- fcn: double (*fcn)( double, int32_t, double ) ternary 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_did_d( env, info, fcn )
Invokes a ternary function accepting a double-precision floating-point number, 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 fcn( const double x, const int32_t y, const double z ) {
// ...
}
// ...
/**
* 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_did_d( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] double (*fcn)( double, int32_t, double )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_did_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t, double ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_DII_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting a double-precision floating-point number and two signed 32-bit integers and returning a double-precision floating-point number.
`c
#include
static double fcn( const double x, const int32_t y, const int32_t z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DII_D( fcn );
`
The macro expects the following arguments:
- fcn: double (*fcn)( double, int32_t, int32_t ) ternary 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_dii_d( env, info, fcn )
Invokes a ternary function accepting a double-precision floating-point number and two signed 32-bit integers and returning a double-precision floating-point number.
`c
#include
#include
// ...
static double fcn( const double x, const int32_t y, const int32_t z ) {
// ...
}
// ...
/**
* 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_dii_d( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] double (*fcn)( double, int32_t, int32_t )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_dii_d( napi_env env, napi_callback_info info, double (*fcn)( double, int32_t, int32_t ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning single-precision floating-point numbers.
`c
static float addf( const float x, const float y, const float z ) {
return x + y + z;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( addf );
`
The macro expects the following arguments:
- fcn: float (*fcn)( float, float, float ) ternary 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_fff_f( env, info, fcn )
Invokes a ternary function accepting and returning single-precision floating-point numbers.
`c
#include
// ...
static float addf( const float x, const float y, const float z ) {
return x + y + z;
}
// ...
/**
* 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_fff_f( env, info, addf );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] float (*fcn)( float, float, float )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_fff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_FIF_F( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting a single-precision floating-point number, a signed 32-bit integer, and a single-precision floating-point number and returning a single-precision floating-point number.
`c
#include
static float fcn( const float x, const int32_t y, const float z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FIF_F( fcn );
`
The macro expects the following arguments:
- fcn: float (*fcn)( float, int32_t, float ) ternary 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_fif_f( env, info, fcn )
Invokes a ternary function accepting a single-precision floating-point number, a signed 32-bit integer, and a single-precision floating-point number and returning a single-precision floating-point number.
`c
#include
#include
// ...
static float fcn( const float x, const int32_t y, const float z ) {
// ...
}
// ...
/**
* 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_fif_f( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] float (*fcn)( float, int32_t, float )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_fif_f( napi_env env, napi_callback_info info, float (*fcn)( float, int32_t, float ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_FII_F( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting a single-precision floating-point number and two signed 32-bit integers and returning a single-precision floating-point number.
`c
#include
static float fcn( const float x, const int32_t y, const int32_t z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FII_F( fcn );
`
The macro expects the following arguments:
- fcn: float (*fcn)( float, int32_t, int32_t ) ternary 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_fii_f( env, info, fcn )
Invokes a ternary function accepting a single-precision floating-point number and two signed 32-bit integers and returning a single-precision floating-point number.
`c
#include
#include
// ...
static float fcn( const float x, const int32_t y, const int32_t z ) {
// ...
}
// ...
/**
* 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_fii_f( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] float (*fcn)( float, int32_t, int32_t )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_fii_f( napi_env env, napi_callback_info info, float (*fcn)( float, int32_t, int32_t ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_IID_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting two signed 32-bit integers and a double-precision floating-point number and returning a double-precision floating-point number.
`c
#include
static double fcn( const int32_t x, const int32_t y, const double z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_IID_D( fcn );
`
The macro expects the following arguments:
- fcn: double (*fcn)( int32_t, int32_t, double ) ternary 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_iid_d( env, info, fcn )
Invokes a ternary function accepting two signed 32-bit integers and a double-precision floating-point number and returning a double-precision floating-point number.
`c
#include
#include
// ...
static double fcn( const int32_t x, const int32_t y, const double z ) {
// ...
}
// ...
/**
* 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_iid_d( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] double (*fcn)( int32_t, int32_t, double )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_iid_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, double ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.
`c
#include
static double fcn( const int32_t x, const int32_t y, const int32_t z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn );
`
The macro expects the following arguments:
- fcn: double (*fcn)( int32_t, int32_t, int32_t ) ternary 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_iii_d( env, info, fcn )
Invokes a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.
`c
#include
#include
// ...
static double fcn( const int32_t x, const int32_t y, const int32_t z ) {
// ...
}
// ...
/**
* 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_iii_d( env, info, fcn );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] double (*fcn)( int32_t, int32_t, int32_t )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_iii_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, int32_t ) );
#### STDLIB_MATH_BASE_NAPI_MODULE_ZZZ_Z( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary 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, const stdlib_complex128_t z ) {
double xre;
double xim;
double yre;
double yim;
double zre;
double zim;
double re;
double im;
stdlib_complex128_reim( x, &xre, &xim );
stdlib_complex128_reim( y, &yre, &yim );
stdlib_complex128_reim( z, &zre, &zim );
re = xre + yre + zre;
im = xim + yim + zim;
return stdlib_complex128( re, im );
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_ZZZ_Z( add );
`
The macro expects the following arguments:
- fcn: stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t, stdlib_complex128_t ) ternary 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_zzz_z( env, info, fcn )
Invokes a ternary 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, const stdlib_complex128_t z ) {
double xre;
double xim;
double yre;
double yim;
double zre;
double zim;
double re;
double im;
stdlib_complex128_reim( x, &xre, &xim );
stdlib_complex128_reim( y, &yre, &yim );
stdlib_complex128_reim( z, &zre, &zim );
re = xre + yre + zre;
im = xim + yim + zim;
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_zzz_z( env, info, add );
}
// ...
`
The function accepts the following arguments:
- env: [in] napi_env environment under which the function is invoked.[in] napi_callback_info
- info: callback data.[in] stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t, stdlib_complex128_t )
- fcn: ternary function.
`c`
void stdlib_math_base_napi_zzz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t, stdlib_complex128_t ) );
- The C-API functions expect that the callback info argument provides access to the following JavaScript arguments:
- x: input value.y
- : input value.z
- : input value.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-napi-ternary.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-napi-ternary
[test-image]: https://github.com/stdlib-js/math-base-napi-ternary/actions/workflows/test.yml/badge.svg?branch=v0.3.2
[test-url]: https://github.com/stdlib-js/math-base-napi-ternary/actions/workflows/test.yml?query=branch:v0.3.2
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-napi-ternary/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-napi-ternary?branch=main
[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
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-napi-ternary/main/LICENSE