@stdlib/strided-napi-smap
v0.2.2
Published
C API for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision floating-point strided input array and assigning results to a single-precision floating-point strided output array.
Downloads
165
Readme
smap
C API for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision floating-point strided input array and assigning results to a single-precision floating-point strided output array.
Installation
npm install @stdlib/strided-napi-smap
Usage
var headerDir = require( '@stdlib/strided-napi-smap' );
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-smap' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/strided/napi/smap.h"
stdlib_strided_napi_smap( env, info, fcn )
Invokes a strided array interface which applies a unary callback to a single-precision floating-point strided input array and assigns results to a single-precision floating-point strided output array.
#include <node_api.h>
// ...
static float identityf( const float x ) {
return x;
}
// ...
/**
* 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_smap( env, info, identityf );
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] float (*fcn)( float )
unary callback.
void stdlib_strided_napi_smap( napi_env env, napi_callback_info info, float (*fcn)( float ) );
STDLIB_STRIDED_NAPI_MODULE_SMAP( clbk )
Macro for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision floating-point strided input array and assigning results to a single-precision floating-point strided output array.
static float scale( const float x ) {
return x * 10.0f;
}
// ...
// Register a Node-API module:
STDLIB_STRIDED_NAPI_MODULE_SMAP( scale )
The macro expects the following arguments:
- clbk:
float (*fcn)( float )
unary 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
Float32Array
. - strideX:
X
stride length. - Y: destination
Float32Array
. - strideY:
Y
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.