time-to-botec/js/node_modules/@stdlib/strided/napi/unary
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs/types feat: add the node modules 2022-12-03 12:44:49 +00:00
include/stdlib/strided/napi feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
src feat: add the node modules 2022-12-03 12:44:49 +00:00
binding.gyp feat: add the node modules 2022-12-03 12:44:49 +00:00
include.gypi feat: add the node modules 2022-12-03 12:44:49 +00:00
manifest.json feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Unary

C API for registering a Node-API module exporting a strided array interface for applying a unary callback to an input strided array.

Usage

var headerDir = require( '@stdlib/strided/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/strided/napi/unary' );

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

C APIs

Usage

#include "stdlib/strided/napi/unary.h"

stdlib_strided_napi_unary( env, info, *obj )

Invokes a strided array interface which applies a unary callback to an input strided array 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_unary( 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_unary( napi_env env, napi_callback_info info, const struct StridedFunctionObject *obj );

STDLIB_STRIDED_NAPI_MODULE_UNARY( obj )

Macro for registering a Node-API module exporting a strided array interface for applying a unary callback to an input 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_UNARY( obj );

The macro expects the following arguments:

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.
    • Y: destination typed array.
    • strideY: Y stride length.