|
||
---|---|---|
.. | ||
docs/types | ||
include/stdlib/strided/napi | ||
lib | ||
src | ||
binding.gyp | ||
include.gypi | ||
manifest.json | ||
package.json | ||
README.md |
mskunary
C API for registering a Node-API module exporting a strided array interface for applying a unary callback to an input strided array according to a mask strided array.
Usage
var headerDir = require( '@stdlib/strided/napi/mskunary' );
headerDir
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
// returns <string>
Examples
var headerDir = require( '@stdlib/strided/napi/mskunary' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/strided/napi/mskunary.h"
stdlib_strided_napi_mskunary( env, info, *obj )
Invokes a strided array interface which applies a unary callback to an input strided array according to a mask strided array and based on provided JavaScript arguments.
#include "stdlib/strided/base/function_object.h"
#include <node_api.h>
// ...
static const struct StridedFunctionObject 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_strided_napi_mskunary( env, info, &obj );
return NULL;
}
// ...
The function accepts the following arguments:
- env:
[in] napi_env
environment under which the function is invoked. - info:
[in] napi_callback_info
callback data. - obj:
[in] struct StridedFunctionObject*
strided array function object.
void stdlib_strided_napi_mskunary( napi_env env, napi_callback_info info, const struct StridedFunctionObject *obj );
STDLIB_STRIDED_NAPI_MODULE_MSKUNARY( obj )
Macro for registering a Node-API module exporting a strided array interface for applying a unary callback to an input strided array according to a mask strided array.
#include "stdlib/strided/base/function_object.h"
// ...
// Create a strided function object:
static const struct StridedFunctionObject obj = {...};
// ...
// Register a Node-API module:
STDLIB_STRIDED_NAPI_MODULE_MSKUNARY( obj );
The macro expects the following arguments:
- obj:
struct StridedFunctionObject
strided array 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
info
argument provides access to the following JavaScript arguments:N
: number of indexed elements.X
: input typed array.strideX
:X
stride length.Mask
: maskUint8Array
.strideMask
:Mask
stride length.Y
: destination typed array.strideY
:Y
stride length.