Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/ndarray-base-napi-addon-arguments

C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray N-API add-on interface.

https://github.com/stdlib-js/ndarray-base-napi-addon-arguments

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 (15.0%) to scientific vocabulary

Keywords

addon args arguments javascript multidimensional n-api napi ndarray node node-js nodejs stdlib tensor
Last synced: 6 months ago · JSON representation ·

Repository

C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray N-API add-on interface.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
addon args arguments javascript multidimensional n-api napi ndarray node node-js nodejs stdlib tensor
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

Add-on Arguments

NPM version Build Status Coverage Status <!-- dependencies -->

C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray Node-API add-on interface.

## Installation ```bash npm install @stdlib/ndarray-base-napi-addon-arguments ```
## Usage ```javascript var headerDir = require( '@stdlib/ndarray-base-napi-addon-arguments' ); ``` #### headerDir Absolute file path for the directory containing header files for C APIs. ```javascript var dir = headerDir; // returns ```
## Examples ```javascript var headerDir = require( '@stdlib/ndarray-base-napi-addon-arguments' ); console.log( headerDir ); // => ```
## C APIs
### Usage ```c #include "stdlib/ndarray/base/napi/addon_arguments.h" ``` #### stdlib_ndarray_napi_addon_arguments( env, argv, nargs, nin, \*arrays\[], \*err ) Validates, extracts, and transforms (to native C types) function arguments provided to an ndarray Node-API add-on interface. ```c #include #include #include // ... /** * 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 ) { napi_status status; // ... int64_t nargs = 6; int64_t nin = 2; // Get callback arguments: size_t argc = 6; napi_value argv[ 6 ]; status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); assert( status == napi_ok ); // ... // Process the provided arguments: struct ndarray *arrays[ 3 ]; napi_value err; status = stdlib_ndarray_napi_addon_arguments( env, argv, nargs, nin, arrays, &err ); assert( status == napi_ok ); // ... } // ... ``` The function accepts the following arguments: - **env**: `[in] napi_env` environment under which the function is invoked. - **argv**: `[in] napi_value*` ndarray function arguments. - **nargs**: `[in] int64_t` total number of expected arguments. - **nin**: `[in] int64_t` number of input ndarray arguments. - **arrays**: `[out] struct ndarrays**` destination array for storing pointers to both input and output ndarrays. - **err**: `[out] napi_value*` pointer for storing a JavaScript error. ```c napi_status stdlib_ndarray_napi_addon_arguments( const napi_env env, const napi_value *argv, const int64_t nargs, const int64_t nin, struct ndarray *arrays[], napi_value *err ); ``` The function returns a `napi_status` status code indicating success or failure (returns `napi_ok` if success).
### Notes - The function assumes the following argument order: ```text [ ib1, im1, ib2, im2, ..., ob1, om1, ob2, om2, ... ] ``` where - `ib#` is a data buffer for an input ndarray. - `im#` is meta data for an input ndarray. - `ob#` is a data buffer for an output ndarray. - `om#` is meta data for an output ndarray. - The function may return one of the following JavaScript errors: - `Error`: unable to allocate memory when processing input ndarray. - `Error`: unable to allocate memory when processing output ndarray.

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

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: over 1 year ago

All Time
  • Total Commits: 50
  • Total Committers: 1
  • Avg Commits per committer: 50.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 12
  • Committers: 1
  • Avg Commits per committer: 12.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 50
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 6 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 46 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 1
  • Total versions: 11
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-base-napi-addon-arguments

C API for validating, extracting, and transforming (to native C types) function arguments provided to an ndarray Node-API add-on interface.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 11
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 46 Last month
Rankings
Dependent packages count: 5.9%
Dependent repos count: 10.3%
Downloads: 11.9%
Average: 12.1%
Forks count: 15.4%
Stargazers count: 16.7%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago

Dependencies

package.json npm
  • @stdlib/array-float64 ^0.0.x development
  • @stdlib/assert-is-browser ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/ndarray-base-serialize-meta-data ^0.0.x development
  • @stdlib/utils-try-require ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/ndarray-ctor ^0.0.x
  • @stdlib/utils-library-manifest ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.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