Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/napi-argv-strided-complex64array

Convert a Node-API value representing a strided array to a single-precision complex floating-point array.
https://github.com/stdlib-js/napi-argv-strided-complex64array

addon array cmplx complex complex64 float javascript macros napi native ndarray node node-js nodejs stdlib strided utilities utils

Last synced: about 1 month ago
JSON representation

Convert a Node-API value representing a strided array to a single-precision complex floating-point array.

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!



# argv_strided_complex64array



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Convert a Node-API value representing a strided array to a single-precision complex floating-point array.



## Installation



```bash

npm install @stdlib/napi-argv-strided-complex64array

```



## Usage



```javascript

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

```



#### headerDir



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



```javascript

var dir = headerDir;

// returns 

```



## Examples



```javascript

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



console.log( headerDir );

// => 

```



* * *



## C APIs



### Usage



```c

#include "stdlib/napi/argv_strided_complex64array.h"

```



#### stdlib_napi_argv_strided_complex64array( env, N, stride, value, \*\*data, \*message1, \*message2, \*err )



Converts a Node-API value representing a strided array to a single-precision complex floating-point array.



```c

#include "stdlib/napi/argv_strided_complex64array.h"

#include 

#include 



static napi_value addon( napi_env env, napi_callback_info info ) {

    napi_value value;



    // ...



    int64_t N = 100;

    int64_t stride = 1;



    // ...



    float *X;

    napi_value err;

    napi_status status = stdlib_napi_argv_strided_complex64array( env, N, stride, value, &X, "Must be a typed array.", "Must have sufficient elements.", &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.

-   **N**: `[in] int64_t` number of indexed elements.

-   **stride**: `[in] int64_t` stride length.

-   **value**: `[in] napi_value` Node-API value.

-   **data**: `[out] float**` pointer for returning a reference to the output array.

-   **message1**: `[in] char*` error message if a value is not a `Float32Array`.

-   **message2**: `[in] char*` error message if a value has insufficient elements.

-   **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`.



```c

napi_status stdlib_napi_argv_strided_complex64array( const napi_env env, const int64_t N, const int64_t stride, const napi_value value, float **data, const char *message1, const char *message2, napi_value *err );

```



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



#### STDLIB_NAPI_ARGV_STRIDED_COMPLEX64ARRAY( env, X, N, stride, argv, index )



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



```c

#include "stdlib/napi/argv_strided_complex64array.h"

#include "stdlib/napi_argv_int64.h"

#include "stdlib/napi/argv.h"

#include 

#include 



static void fcn( const int64_t N, const float *X, const int64_t strideX, float *Y, const int64_t strideY ) {

    int64_t i;

    for ( i = 0; i < N*2; i += 2 ) {

        Y[ i*strideY ] = X[ i*strideX ];

        Y[ (i*strideY)+1 ] = X[ (i*strideX)+1 ];

    }

}



// ...



static napi_value addon( napi_env env, napi_callback_info info ) {

    // Retrieve add-on callback arguments:

    STDLIB_NAPI_ARGV( env, info, argv, argc, 5 );



    // Convert the number of indexed elements to a C type:

    STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 );



    // Convert the stride arguments to C types:

    STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 );

    STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 4 );



    // Convert the arrays a C types:

    STDLIB_NAPI_ARGV_STRIDED_COMPLEX64ARRAY( env, X, N, strideX, argv, 1 );

    STDLIB_NAPI_ARGV_STRIDED_COMPLEX64ARRAY( env, Y, N, strideY, argv, 3 );



    // ...



    fcn( N, X, strideX, Y, strideY );

}

```



The macro expects the following arguments:



-   **env**: environment under which the callback is invoked.

-   **X**: output variable name for the array.

-   **N**: number of indexed elements.

-   **stride**: stride length.

-   **argv**: name of the variable containing add-on callback arguments.

-   **index**: argument index.



## Notes



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



* * *



## 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]



---



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/napi-argv-strided-complex64array.svg

[npm-url]: https://npmjs.org/package/@stdlib/napi-argv-strided-complex64array



[test-image]: https://github.com/stdlib-js/napi-argv-strided-complex64array/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/napi-argv-strided-complex64array/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/napi-argv-strided-complex64array/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/napi-argv-strided-complex64array?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