@stdlib/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

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary

Keywords

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

Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: C
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 194 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

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

Created almost 3 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

argvstridedcomplex64array

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] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 2

Last Year

Push event: 2

Committers

Last synced: 6 months ago

All Time

Total Commits: 32
Total Committers: 1
Avg Commits per committer: 32.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 10
Committers: 1
Avg Commits per committer: 10.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	32

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 251 last-month

Total dependent packages: 2
Total dependent repositories: 0
Total versions: 5
Total maintainers: 4

npmjs.org: @stdlib/napi-argv-strided-complex64array

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

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 5
Dependent Packages: 2
Dependent Repositories: 0
Downloads: 251 Last month

Rankings

Forks count: 15.9%

Stargazers count: 17.2%

Average: 31.0%

Dependent repos count: 37.3%

Dependent packages count: 53.5%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

Dependencies

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

package.json npm

@stdlib/array-filled ^0.0.6 development
@stdlib/array-typed ^0.0.6 development
@stdlib/assert-is-browser ^0.0.8 development
@stdlib/assert-is-complex64array ^0.0.7 development
@stdlib/strided-base-reinterpret-complex64 ^0.0.2 development
@stdlib/utils-try-require ^0.0.7 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-napi-status-ok ^0.0.1
@stdlib/napi-argv github:stdlib-js/napi-argv#main
@stdlib/napi-argv-float32array github:stdlib-js/napi-argv-float32array#main
@stdlib/utils-library-manifest ^0.0.8

@stdlib/napi-argv-strided-complex64array

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

argvstridedcomplex64array

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/napi-argv-strided-complex64array

Rankings

Maintainers (4)

Funding

Dependencies