Skip to content

README.md

Latest commit

 

History

History
447 lines (292 loc) · 11.5 KB

README.md

File metadata and controls

447 lines (292 loc) · 11.5 KB

quaternary

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

Usage

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

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

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

C APIs

Usage

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

STDLIB_MATH_BASE_NAPI_MODULE_DDDD_D( fcn )

Macro for registering a Node-API module exporting an interface for invoking a quaternary function accepting and returning double-precision floating-point numbers.

static double add( const double x, const double y, const double z, const double w ) {
    return x + y + z + w;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DDDD_D( add );

The macro expects the following arguments:

  • fcn: double (*fcn)( double, double, double, double ) 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_dddd_d( env, info, fcn )

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

#include <node_api.h>

// ...

static double add( const double x, const double y, const double z, const double 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_dddd_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, double, double ) quaternary function.
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.

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.

#include <node_api.h>

// ...

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

static float addf( const float x, const float y, const float z, const float w ) {
    return x + y + z + w;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FFFF_F( addf );

The macro expects the following arguments:

  • fcn: float (*fcn)( float, float, float, float ) 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_ffff_f( env, info, fcn )

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

#include <node_api.h>

// ...

static float addf( const float x, const float y, const float z, const float 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_ffff_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, float, float ) quaternary function.
void stdlib_math_base_napi_ffff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float, float ) );

STDLIB_MATH_BASE_NAPI_MODULE_ZZZZ_Z( fcn )

Macro for registering a Node-API module exporting an interface for invoking a quaternary function accepting and returning double-precision complex floating-point numbers.

#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"

static stdlib_complex128_t add( const stdlib_complex128_t w, const stdlib_complex128_t x, const stdlib_complex128_t y, const stdlib_complex128_t z ) {
    double wre;
    double wim;
    double xre;
    double xim;
    double yre;
    double yim;
    double zre;
    double zim;
    double re;
    double im;

    stdlib_complex128_reim( w, &xre, &wim );
    stdlib_complex128_reim( x, &yre, &xim );
    stdlib_complex128_reim( y, &zre, &yim );
    stdlib_complex128_reim( z, &zre, &zim );

    re = wre + xre + yre + zre;
    im = wim + xim + yim + zim;

    return stdlib_complex128( re, im );
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_ZZZZ_Z( add );

The macro expects the following arguments:

  • fcn: stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t, stdlib_complex128_t, stdlib_complex128_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_zzzz_z( env, info, fcn )

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

#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"
#include <node_api.h>

// ...

static stdlib_complex128_t add( const stdlib_complex128_t w, const stdlib_complex128_t x, const stdlib_complex128_t y, const stdlib_complex128_t z ) {
    double wre;
    double wim;
    double xre;
    double xim;
    double yre;
    double yim;
    double zre;
    double zim;
    double re;
    double im;

    stdlib_complex128_reim( w, &wre, &wim );
    stdlib_complex128_reim( x, &xre, &xim );
    stdlib_complex128_reim( y, &yre, &yim );
    stdlib_complex128_reim( z, &zre, &zim );

    re = wre + xre + yre + zre;
    im = wim + 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_zzzz_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, stdlib_complex128_t, stdlib_complex128_t ) quaternary function.
void stdlib_math_base_napi_zzzz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t, 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.
    • z: input value.
    • w: input value.