@stdlib/strided-napi-binary

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Binary

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

Installation

npm install @stdlib/strided-napi-binary

Usage

var headerDir = require( '@stdlib/strided-napi-binary' );

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-binary' );

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

---

C APIs

Usage

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

stdlib_strided_napi_binary( env, info, *obj )

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

STDLIB_STRIDED_NAPI_MODULE_BINARY( obj )

Macro for registering a Node-API module exporting a strided array interface for applying a binary callback to input strided arrays.

#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_BINARY( 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.
  • dtypeX: X data type (enumeration constant).
  • X: input typed array.
  • strideX: X stride length.
  • dtypeY: Y data type (enumeration constant).
  • Y: input typed array.
  • strideY: Y stride length.
  • dtypeZ: Z data type (enumeration constant).
  • Z: destination typed array.
  • 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.