https://github.com/stdlib-js/ndarray-base-napi-addon-arguments
C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray N-API add-on interface.
https://github.com/stdlib-js/ndarray-base-napi-addon-arguments
addon args arguments javascript multidimensional n-api napi ndarray node node-js nodejs stdlib tensor
Last synced: about 1 year ago
JSON representation
C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray N-API add-on interface.
- Host: GitHub
- URL: https://github.com/stdlib-js/ndarray-base-napi-addon-arguments
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T18:58:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T00:32:46.000Z (about 1 year ago)
- Last Synced: 2025-03-26T04:36:38.485Z (about 1 year ago)
- Topics: addon, args, arguments, javascript, multidimensional, n-api, napi, ndarray, node, node-js, nodejs, stdlib, tensor
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 186 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# Add-on Arguments
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray Node-API add-on interface.
## Installation
```bash
npm install @stdlib/ndarray-base-napi-addon-arguments
```
## Usage
```javascript
var headerDir = require( '@stdlib/ndarray-base-napi-addon-arguments' );
```
#### headerDir
Absolute file path for the directory containing header files for C APIs.
```javascript
var dir = headerDir;
// returns
```
## Examples
```javascript
var headerDir = require( '@stdlib/ndarray-base-napi-addon-arguments' );
console.log( headerDir );
// =>
```
* * *
## C APIs
### Usage
```c
#include "stdlib/ndarray/base/napi/addon_arguments.h"
```
#### stdlib_ndarray_napi_addon_arguments( env, argv, nargs, nin, \*arrays\[], \*err )
Validates, extracts, and transforms (to native C types) function arguments provided to an ndarray Node-API add-on interface.
```c
#include
#include
#include
// ...
/**
* 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 ) {
napi_status status;
// ...
int64_t nargs = 6;
int64_t nin = 2;
// Get callback arguments:
size_t argc = 6;
napi_value argv[ 6 ];
status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr );
assert( status == napi_ok );
// ...
// Process the provided arguments:
struct ndarray *arrays[ 3 ];
napi_value err;
status = stdlib_ndarray_napi_addon_arguments( env, argv, nargs, nin, arrays, &err );
assert( status == napi_ok );
// ...
}
// ...
```
The function accepts the following arguments:
- **env**: `[in] napi_env` environment under which the function is invoked.
- **argv**: `[in] napi_value*` ndarray function arguments.
- **nargs**: `[in] int64_t` total number of expected arguments.
- **nin**: `[in] int64_t` number of input ndarray arguments.
- **arrays**: `[out] struct ndarrays**` destination array for storing pointers to both input and output ndarrays.
- **err**: `[out] napi_value*` pointer for storing a JavaScript error.
```c
napi_status stdlib_ndarray_napi_addon_arguments( const napi_env env, const napi_value *argv, const int64_t nargs, const int64_t nin, struct ndarray *arrays[], napi_value *err );
```
The function returns a `napi_status` status code indicating success or failure (returns `napi_ok` if success).
### Notes
- The function assumes the following argument order:
```text
[ ib1, im1, ib2, im2, ..., ob1, om1, ob2, om2, ... ]
```
where
- `ib#` is a data buffer for an input ndarray.
- `im#` is meta data for an input ndarray.
- `ob#` is a data buffer for an output ndarray.
- `om#` is meta data for an output ndarray.
- The function may return one of the following JavaScript errors:
- `Error`: unable to allocate memory when processing input ndarray.
- `Error`: unable to allocate memory when processing output ndarray.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-napi-addon-arguments.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-napi-addon-arguments
[test-image]: https://github.com/stdlib-js/ndarray-base-napi-addon-arguments/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/ndarray-base-napi-addon-arguments/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-napi-addon-arguments/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-napi-addon-arguments?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-napi-addon-arguments/main/LICENSE