Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/strided-napi-dmskmap
C API for registering an N-API module exporting a strided array interface for applying a unary callback accepting and returning double-precision floating-point numbers to each element in a double-precision floating-point strided input array according to a corresponding element in a strided mask array and assigning results to elements in a double-precision floating-point strided output array.
https://github.com/stdlib-js/strided-napi-dmskmap
addon array dbl double double-precision float64 javascript map mask masked missing n-api napi node node-js nodejs stdlib strided transform unary
Last synced: 4 days ago
JSON representation
C API for registering an N-API module exporting a strided array interface for applying a unary callback accepting and returning double-precision floating-point numbers to each element in a double-precision floating-point strided input array according to a corresponding element in a strided mask array and assigning results to elements in a double-precision floating-point strided output array.
- Host: GitHub
- URL: https://github.com/stdlib-js/strided-napi-dmskmap
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:18:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T01:32:43.000Z (27 days ago)
- Last Synced: 2024-09-03T17:39:14.173Z (25 days ago)
- Topics: addon, array, dbl, double, double-precision, float64, javascript, map, mask, masked, missing, n-api, napi, node, node-js, nodejs, stdlib, strided, transform, unary
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 218 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!
# dmskmap
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> C API for registering a Node-API module exporting a strided array interface for applying a unary callback to a double-precision floating-point strided input array according to a strided mask array and assigning results to a double-precision floating-point strided output array.
## Installation
```bash
npm install @stdlib/strided-napi-dmskmap
```
## Usage
```javascript
var headerDir = require( '@stdlib/strided-napi-dmskmap' );
```
#### headerDir
Absolute file path for the directory containing header files for C APIs.
```javascript
var dir = headerDir;
// returns
```
## Examples
```javascript
var headerDir = require( '@stdlib/strided-napi-dmskmap' );
console.log( headerDir );
// =>
```
* * *
## C APIs
### Usage
```c
#include "stdlib/strided/napi/dmskmap.h"
```
#### stdlib_strided_napi_dmskmap( env, info, fcn )
Invokes a strided array interface which applies a unary callback to a double-precision floating-point strided input array according to a strided mask array and assigns results to a double-precision floating-point strided output array.
```c
#include
// ...
static double identity( const double x ) {
return x;
}
// ...
/**
* 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_dmskmap( env, info, identity );
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.
- **fcn**: `[in] double (*fcn)( double )` unary callback.
```c
void stdlib_strided_napi_dmskmap( napi_env env, napi_callback_info info, double (*fcn)( double ) );
```
#### STDLIB_STRIDED_NAPI_MODULE_DMSKMAP( clbk )
Macro for registering a Node-API module exporting a strided array interface for applying a unary callback to a double-precision floating-point strided input array according to a strided mask array and assigning results to a double-precision floating-point strided output array.
```c
static double scale( const double x ) {
return x * 10.0;
}
// ...
// Register a Node-API module:
STDLIB_STRIDED_NAPI_MODULE_DMSKMAP( scale );
```
The macro expects the following arguments:
- **clbk**: `double (*fcn)( double )` unary callback.
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 [`Float64Array`][@stdlib/array/float64].
- **strideX**: `X` stride length.
- **Mask**: mask [`Uint8Array`][@stdlib/array/uint8].
- **strideMask**: `Mask` stride length.
- **Y**: destination [`Float64Array`][@stdlib/array/float64].
- **strideY**: `Y` stride length.
* * *
## 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/strided-napi-dmskmap.svg
[npm-url]: https://npmjs.org/package/@stdlib/strided-napi-dmskmap
[test-image]: https://github.com/stdlib-js/strided-napi-dmskmap/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/strided-napi-dmskmap/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-napi-dmskmap/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/strided-napi-dmskmap?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/strided-napi-dmskmap/main/LICENSE
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8