binary

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

Usage

var headerDir = require( '@stdlib/math/base/napi/binary' );

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/binary' );

console.log( headerDir );
// => <string>

C APIs

Usage

#include "stdlib/math/base/napi/binary.h"

stdlib_math_base_napi_dd_d( env, info, fcn )

Invokes a binary function accepting and returning double-precision floating-point numbers.

#include <node_api.h>

// ...

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.

void stdlib_math_base_napi_dd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double ) );

stdlib_math_base_napi_ff_f( env, info, fcn )

Invokes a binary function accepting and returning single-precision floating-point numbers.

#include <node_api.h>

// ...

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.

void stdlib_math_base_napi_ff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float ) );
```de "stdlib/math/base/napi/binary.h"

stdlib_math_base_napi_zz_z( env, info, fcn )

Invokes a binary function accepting and returning double-precision complex floating-point numbers.

#include "stdlib/complex/float64.h"
#include "stdlib/complex/reim.h"
#include <node_api.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_reim( x, &xre, &xim );
    stdlib_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.

void stdlib_math_base_napi_zz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t ) );

stdlib_math_base_napi_cc_c( env, info, fcn )

Invokes a binary function accepting and returning single-precision complex floating-point numbers.

#include "stdlib/complex/float64.h"
#include "stdlib/complex/reim.h"
#include <node_api.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_reimf( x, &xre, &xim );
    stdlib_reimf( 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.

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_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.

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_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.

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_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.

#include "stdlib/complex/float64.h"
#include "stdlib/complex/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_reim( x, &xre, &xim );
    stdlib_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_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.

#include "stdlib/complex/float32.h"
#include "stdlib/complex/reimf.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_reimf( x, &xre, &xim );
    stdlib_reimf( 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.

Notes

The C-API functions expect that the callback info argument provides access to the following JavaScript arguments:
- x: input value.
- y: input value.