stdlib-js / strided-napi-cmap

C API for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision complex floating-point strided input array and assigning results to a single-precision complex floating-point strided output array.

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!

cmap

C API for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision complex floating-point strided input array and assigning results to a single-precision complex floating-point strided output array.

Installation

npm install @stdlib/strided-napi-cmap

Usage

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

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

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

---

C APIs

Usage

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

stdlib_strided_napi_cmap( env, info, fcn )

Invokes a strided array interface which applies a unary callback to a single-precision complex floating-point strided input array and assigns results to a single-precision complex floating-point strided output array.

#include <node_api.h>
#include <complex.h>

// ...

static float complex cidentityf( const float complex z ) {
    return z;
}

// ...

/**
* 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_cmap( env, info, cidentityf );
    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] float complex (*fcn)( float complex ) unary callback.

void stdlib_strided_napi_cmap( napi_env env, napi_callback_info info, float complex (*fcn)( float complex ) );

STDLIB_STRIDED_NAPI_MODULE_CMAP( clbk )

Macro for registering a Node-API module exporting a strided array interface for applying a unary callback to a single-precision complex floating-point strided input array and assigning results to a single-precision complex floating-point strided output array.

#include <complex.h>

static float complex scale( const float complex z ) {
    float complex re = crealf( z );
    float complex im = cimagf( z );
    return ( re*10.0f ) + ( im*10.0f )*I;
}

// ...

// Register a Node-API module:
STDLIB_STRIDED_NAPI_MODULE_CMAP( scale )

The macro expects the following arguments:

• clbk: float complex (*fcn)( float complex ) 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 Float32Array view of a Complex64Array.
  • strideX: stride length for the input Complex64Array.
  • Y: destination Float32Array view of a Complex64Array.
  • strideY: stride length for the destination Complex64Array.

---

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.