@stdlib/napi-argv-complex128array

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!

argv_complex128array

Convert a Node-API value to a double-precision complex floating-point array.

Installation

npm install @stdlib/napi-argv-complex128array

Usage

var headerDir = require( '@stdlib/napi-argv-complex128array' );

headerDir

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

var dir = headerDir;
// returns <string>

Examples

var headerDir = require( '@stdlib/napi-argv-complex128array' );

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

---

C APIs

Usage

#include "stdlib/napi/argv_complex128array.h"

stdlib_napi_argv_complex128array( env, value, **data, *length, *message, *err )

Converts a Node-API value to a double-precision complex floating-point array.

#include "stdlib/napi/argv_complex128array.h"
#include <node_api.h>
#include <stdint.h>

static napi_value addon( napi_env env, napi_callback_info info ) {
    napi_value value;

    // ...

    double *X;
    int64_t len;
    napi_value err;
    napi_status status = stdlib_napi_argv_complex128array( env, value, &X, &len, "Must be a typed array.", &err );
    assert( status == napi_ok );
    if ( err != NULL ) {
        assert( napi_throw( env, err ) == napi_ok );
        return NULL;
    }

    // ...
}

The function accepts the following arguments:

• env: [in] napi_env environment under which the function is invoked.
• value: [in] napi_value Node-API value.
• data: [out] double** pointer for returning a reference to the output array.
• length: [out] int64_t* pointer for returning the number of array elements.
• message: [in] char* error message.
• err: [out] napi_value* pointer for storing a JavaScript error. If not provided a number, the function sets err with a JavaScript error; otherwise, err is set to NULL.

napi_status stdlib_napi_argv_complex128array( const napi_env env, const napi_value value, double **data, int64_t *length, const char *message, napi_value *err );

The function returns a napi_status status code indicating success or failure (returns napi_ok if success).

STDLIB_NAPI_ARGV_COMPLEX128ARRAY( env, X, len, argv, index )

Macro for converting an add-on callback argument to a double-precision complex floating-point array.

#include "stdlib/napi/argv_complex128array.h"
#include "stdlib/napi/argv.h"
#include <node_api.h>
#include <stdint.h>

static void fcn( const double *X, const int64_t xlen, double *Y, const int64_t ylen ) {
    int64_t len;
    int64_t i;

    if ( xlen > ylen ) {
        len = ylen;
    } else {
        len = xlen;
    }
    for ( i = 0; i < len*2; i++ ) {
        Y[ i ] = X[ i ];
    }
}

// ...

static napi_value addon( napi_env env, napi_callback_info info ) {
    // Retrieve add-on callback arguments:
    STDLIB_NAPI_ARGV( env, info, argv, argc, 2 );

    // Convert the first argument to a C type:
    STDLIB_NAPI_ARGV_COMPLEX128ARRAY( env, X, xlen, argv, 0 );

    // Convert the second argument to a C type:
    STDLIB_NAPI_ARGV_COMPLEX128ARRAY( env, Y, ylen, argv, 1 );

    // ...

    fcn( X, xlen, Y, ylen );
}

The macro expects the following arguments:

• env: environment under which the callback is invoked.
• X: output variable name for the array.
• len: output variable name for the array length.
• argv: name of the variable containing add-on callback arguments.
• index: argument index.

Notes

• A double-precision complex floating-point array is a double-precision floating-point array having interleaved real and imaginary components, such that each element of the double-precision complex floating-point array consists of two adjacent (in memory) double-precision floating-point numbers.

---

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.