@stdlib/strided-napi-dmskmap2
v0.2.2
Published
C API for registering a Node-API module exporting a strided array interface for applying a binary callback to double-precision floating-point strided input arrays according to a strided mask array and assigning results to a double-precision floating-point
Downloads
18
Readme
dmskmap2
C API for registering a Node-API module exporting a strided array interface for applying a binary callback to double-precision floating-point strided input arrays according to a strided mask array and assigning results to a double-precision floating-point strided output array.
Installation
npm install @stdlib/strided-napi-dmskmap2
Usage
var headerDir = require( '@stdlib/strided-napi-dmskmap2' );
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-dmskmap2' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/strided/napi/dmskmap2.h"
stdlib_strided_napi_dmskmap2( env, info, fcn )
Invokes a strided array interface which applies a binary callback to double-precision floating-point strided input arrays according to a strided mask array and assigns results to a double-precision floating-point strided output array.
#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 ) {
stdlib_strided_napi_dmskmap2( env, info, add );
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. - fcn:
[in] double (*fcn)( double, double )
binary callback.
void stdlib_strided_napi_dmskmap2( napi_env env, napi_callback_info info, double (*fcn)( double, double ) );
STDLIB_STRIDED_NAPI_MODULE_DMSKMAP2( clbk )
Macro for registering a Node-API module exporting a strided array interface for applying a binary callback to double-precision floating-point strided input arrays according to a strided mask array and assigning results to a double-precision floating-point strided output array.
static double add( const double x, const double y ) {
return x + y;
}
// ...
// Register a Node-API module:
STDLIB_STRIDED_NAPI_MODULE_DMSKMAP2( add );
The macro expects the following arguments:
- clbk:
double (*fcn)( double, double )
binary callback.
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
Float64Array
. - strideX:
X
stride length. - Y: input
Float64Array
. - strideY:
Y
stride length. - Mask: mask
Uint8Array
. - strideMask:
Mask
stride length. - Z: destination
Float64Array
. - strideZ:
Z
stride length.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.