Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/math-base-napi-quinary
C APIs for registering a Node-API module exporting an interface for invoking a quinary numerical function.
https://github.com/stdlib-js/math-base-napi-quinary
addon javascript map math mathematics n-api napi node node-api node-js nodejs quinary stdlib transform
Last synced: 12 days ago
JSON representation
C APIs for registering a Node-API module exporting an interface for invoking a quinary numerical function.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-napi-quinary
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-11-21T08:29:28.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-01T01:43:55.000Z (about 1 month ago)
- Last Synced: 2024-10-05T20:44:22.718Z (about 1 month ago)
- Topics: addon, javascript, map, math, mathematics, n-api, napi, node, node-api, node-js, nodejs, quinary, stdlib, transform
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 122 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!
# quinary
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> C APIs for registering a Node-API module exporting interfaces for invoking quinary numerical functions.
## Installation
```bash
npm install @stdlib/math-base-napi-quinary
```
## Usage
```javascript
var headerDir = require( '@stdlib/math-base-napi-quinary' );
```
#### headerDir
Absolute file path for the directory containing header files for C APIs.
```javascript
var dir = headerDir;
// returns
```
## Examples
```javascript
var headerDir = require( '@stdlib/math-base-napi-quinary' );
console.log( headerDir );
// =>
```
* * *
## C APIs
### Usage
```c
#include "stdlib/math/base/napi/quinary.h"
```
#### stdlib_math_base_napi_ddddd_d( env, info, fcn )
Invokes a quinary function accepting and returning double-precision floating-point numbers.
```c
#include
// ...
static double add( const double x, const double y, const double z, const double w, const double u ) {
return x + y + z + w + u;
}
// ...
/**
* 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 ) {
return stdlib_math_base_napi_ddddd_d( env, info, add );
}
// ...
```
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] double (*fcn)( double, double, double, double, double )` quinary function.
```c
void stdlib_math_base_napi_ddddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double, double, double ) );
```
#### stdlib_math_base_napi_fffff_f( env, info, fcn )
Invokes a quinary function accepting and returning single-precision floating-point numbers.
```c
#include
// ...
static float addf( const float x, const float y, const float z, const float w, const float u ) {
return x + y + z + w + u;
}
// ...
/**
* 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 ) {
return stdlib_math_base_napi_fffff_f( env, info, addf );
}
// ...
```
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, float, float, float, float )` quinary function.
```c
void stdlib_math_base_napi_fffff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float, float, float ) );
```
#### STDLIB_MATH_BASE_NAPI_MODULE_DDDDD_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a quinary function accepting and returning double-precision floating-point numbers.
```c
static double add( const double x, const double y, const double z, const double w, const double u ) {
return x + y + z + w + u;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DDDDD_D( add );
```
The macro expects the following arguments:
- **fcn**: `double (*fcn)( double, double, double, double, double )` quinary function.
When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.
#### STDLIB_MATH_BASE_NAPI_MODULE_FFFFF_F( fcn )
Macro for registering a Node-API module exporting an interface for invoking a quinary function accepting and returning single-precision floating-point numbers.
```c
static float addf( const float x, const float y, const float z, const float w, const float u ) {
return x + y + z + w + u;
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FFFFF_F( addf );
```
The macro expects the following arguments:
- **fcn**: `float (*fcn)( float, float, float, float, float )` quinary function.
When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.
### Notes
- The C-API functions expect that the callback `info` argument provides access to the following JavaScript arguments:
- `x`: input value.
- `y`: input value.
- `z`: input value.
- `w`: input value.
- `u`: input value.
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-napi-quinary.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-napi-quinary
[test-image]: https://github.com/stdlib-js/math-base-napi-quinary/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-napi-quinary/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-napi-quinary/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-napi-quinary?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/math-base-napi-quinary/main/LICENSE