@stdlib/ndarray-base-napi

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!

ndarray Native Add-ons

C APIs for creating Node-API ndarray native add-ons.

This package exposes an absolute file path for the directory containing header files for various C APIs. The various C APIs facilitate the creation of Node-API ndarray native add-ons.

Installation

npm install @stdlib/ndarray-base-napi

Usage

var headerDir = require( '@stdlib/ndarray-base-napi' );

headerDir

Absolute file path for the directory containing header files for C APIs.

var dir = headerDir;
// returns <string>

Examples

var headerDir = require( '@stdlib/ndarray-base-napi' );

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

---

C APIs

This package exposes various C APIs to facilitate the creation of Node-API ndarray native add-ons. The included C APIs are the APIs implemented in the following packages:

• @stdlib/ndarray-base/napi/unary: Node-API interfaces and macros for registering one or more @stdlib/ndarray/base/unary interfaces with support for multiple dispatch.
• @stdlib/ndarray-base/unary: ndarray loops for operating on a single input ndarray and one or more output ndarrays.
• @stdlib/ndarray-dtypes: supported ndarray data types.

For API documentation, consult the individual packages.

Usage

#include "stdlib/ndarray/base/napi.h"

Examples

#include "stdlib/ndarray/base/napi.h"

// TODO

---

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.