Unary
C API for registering a Node-API module exporting an ndarray interface for applying a unary callback to an input ndarray.
Usage
var headerDir = require( '@stdlib/ndarray/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/ndarray/base/napi/unary' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/ndarray/base/napi/unary.h"
stdlib_ndarray_napi_unary( env, info, *obj )
Invokes an ndarray interface which applies a unary callback to an input ndarray based on provided JavaScript arguments.
#include "stdlib/ndarray/base/function_object.h"
#include <node_api.h>
// ...
static const struct ndarrayFunctionObject obj = {...};
// ...
/**
* 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 ) {
stdlib_ndarray_napi_unary( env, info, &obj );
return NULL;
}
// ...
The function accepts the following arguments:
- env:
[in] napi_envenvironment under which the function is invoked. - info:
[in] napi_callback_infocallback data. - obj:
[in] struct ndarrayFunctionObject*ndarray function object.
void stdlib_ndarray_napi_unary( napi_env env, napi_callback_info info, const struct ndarrayFunctionObject *obj );
STDLIB_NDARRAY_NAPI_MODULE_UNARY( obj )
Macro for registering a Node-API module exporting an ndarray interface for applying a unary callback to an input ndarray.
#include "stdlib/ndarray/base/function_object.h"
// ...
// Create an ndarray function object:
static const struct ndarrayFunctionObject obj = {...};
// ...
// Register a Node-API module:
STDLIB_NDARRAY_NAPI_MODULE_UNARY( obj );
The macro expects the following arguments:
- obj:
struct ndarrayFunctionObjectndarray function object.
When used, this macro should be used instead of NAPI_MODULE. The macro includes NAPI_MODULE, thus ensuring Node-API module registration.
Notes
The function expects that the callback
infoargument provides access to the following JavaScript arguments:X: input ndarray data buffer (i.e., typed array).metaX:Xserialized meta data.Y: destination ndarray data buffer (i.e., typed array).metaY:Yserialized meta data.