|  | ||
|---|---|---|
| .. | ||
| docs/types | ||
| include/stdlib/math/base/napi | ||
| lib | ||
| src | ||
| binding.gyp | ||
| include.gypi | ||
| manifest.json | ||
| package.json | ||
| README.md | ||
unary
C APIs for registering a Node-API module exporting interfaces for invoking unary numerical functions.
Usage
var headerDir = require( '@stdlib/math/base/napi/unary' );
headerDir
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
// returns <string>
Examples
var headerDir = require( '@stdlib/math/base/napi/unary' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/math/base/napi/unary.h"
stdlib_math_base_napi_d_d( env, info, fcn )
Invokes a unary function accepting and returning double-precision floating-point numbers.
#include <node_api.h>
// ...
static double identity( const double x ) {
    return x;
}
// ...
/**
* 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_d_d( env, info, identity );
}
// ...
The function accepts the following arguments:
- env: [in] napi_envenvironment under which the function is invoked.
- info: [in] napi_callback_infocallback data.
- fcn: [in] double (*fcn)( double )unary function.
void stdlib_math_base_napi_d_d( napi_env env, napi_callback_info info, double (*fcn)( double ) );
stdlib_math_base_napi_f_f( env, info, fcn )
Invokes a unary function accepting and returning single-precision floating-point numbers.
#include <node_api.h>
// ...
static float identityf( const float x ) {
    return x;
}
// ...
/**
* 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_f_f( env, info, identityf );
}
// ...
The function accepts the following arguments:
- env: [in] napi_envenvironment under which the function is invoked.
- info: [in] napi_callback_infocallback data.
- fcn: [in] float (*fcn)( float )unary function.
void stdlib_math_base_napi_f_f( napi_env env, napi_callback_info info, float (*fcn)( float ) );
stdlib_math_base_napi_i_i( env, info, fcn )
Invokes a unary function accepting and returning 32-bit signed integers.
#include <node_api.h>
#include <stdint.h>
// ...
static int32_t identity( const int32_t x ) {
    return x;
}
// ...
/**
* 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_i_i( env, info, identity );
}
// ...
The function accepts the following arguments:
- env: [in] napi_envenvironment under which the function is invoked.
- info: [in] napi_callback_infocallback data.
- fcn: [in] int32_t (*fcn)( int32_t )unary function.
void stdlib_math_base_napi_i_i( napi_env env, napi_callback_info info, int32_t (*fcn)( int32_t ) );
STDLIB_MATH_BASE_NAPI_MODULE_D_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning double-precision floating-point numbers.
static double scale( const double x ) {
    return x * 10.0;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_D_D( scale );
The macro expects the following arguments:
- fcn: double (*fcn)( double )unary 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_MODULE_F_F( fcn )
Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning single-precision floating-point numbers.
static float scale( const float x ) {
    return x * 10.0f;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_F_F( scale );
The macro expects the following arguments:
- fcn: float (*fcn)( float )unary 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_MODULE_I_I( fcn )
Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 32-bit signed integers.
#include <stdint.h>
static int32_t scale( const int32_t x ) {
    return x * 10;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_I_I( scale );
The macro expects the following arguments:
- fcn: int32_t (*fcn)( int32_t )unary function.
When used, this macro should be used instead of NAPI_MODULE. The macro includes NAPI_MODULE, thus ensuring Node-API module registration.
Notes
- 
The C-API functions expect that the callback infoargument provides access to the following JavaScript arguments:- x: input value.