Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@stdlib/napi-argv-complex64
Advanced tools
Convert a Node-API value to a single-precision complex floating-point number.
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!
Convert a Node-API value to a single-precision complex floating-point number.
npm install @stdlib/napi-argv-complex64
var headerDir = require( '@stdlib/napi-argv-complex64' );
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
// returns <string>
var headerDir = require( '@stdlib/napi-argv-complex64' );
console.log( headerDir );
// => <string>
#include "stdlib/napi/argv_complex64.h"
Converts a Node-API value to a single-precision complex floating-point number.
#include "stdlib/napi/argv_complex64.h"
#include "stdlib/complex/float32/ctor.h"
#include <node_api.h>
static napi_value addon( napi_env env, napi_callback_info info ) {
napi_value value;
// ...
stdlib_complex64_t out;
napi_value err;
napi_status status = stdlib_napi_argv_complex64( env, value, &out, "Must be a complex number.", &err );
assert( status == napi_ok );
if ( err != NULL ) {
assert( napi_throw( env, err ) == napi_ok );
return NULL;
}
// ...
}
The function accepts the following arguments:
[in] napi_env
environment under which the function is invoked.[in] napi_value
Node-API value.[out] stdlib_complex64_t*
destination for storing output value.[in] char*
error message.[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_complex64( const napi_env env, const napi_value value, stdlib_complex64_t *out, const char *message, napi_value *err );
The function returns a napi_status
status code indicating success or failure (returns napi_ok
if success).
Macro for converting an add-on callback argument to a single-precision complex floating-point number.
#include "stdlib/napi/argv_complex64.h"
#include "stdlib/napi/argv.h"
#include "stdlib/complex/float32/ctor.h"
#include <node_api.h>
static stdlib_complex64_t fcn( const stdlib_complex64_t v ) {
return v;
}
// ...
static napi_value addon( napi_env env, napi_callback_info info ) {
// Retrieve add-on callback arguments:
STDLIB_NAPI_ARGV( env, info, argv, argc, 1 );
// Convert the first argument to a C type:
STDLIB_NAPI_ARGV_COMPLEX64( env, value, argv, 0 );
// ...
stdlib_complex64_t out = fcn( value );
}
The macro expects the following arguments:
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
FAQs
Convert a Node-API value to a single-precision complex floating-point number.
The npm package @stdlib/napi-argv-complex64 receives a total of 10 weekly downloads. As such, @stdlib/napi-argv-complex64 popularity was classified as not popular.
We found that @stdlib/napi-argv-complex64 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.