{"id":24818690,"url":"https://github.com/stdlib-js/strided-napi-binary","last_synced_at":"2025-10-29T00:01:49.061Z","repository":{"id":57162764,"uuid":"421343488","full_name":"stdlib-js/strided-napi-binary","owner":"stdlib-js","description":"C API for registering a Node-API module exporting a strided array interface for applying a binary callback to two input strided arrays.","archived":false,"fork":false,"pushed_at":"2025-08-01T05:35:06.000Z","size":91,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-10T10:27:40.930Z","etag":null,"topics":["addon","array","binary","javascript","n-api","napi","node","node-api","node-js","nodejs","stdlib","strided"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-10-26T08:30:39.000Z","updated_at":"2025-08-01T05:35:10.000Z","dependencies_parsed_at":"2023-02-17T01:16:35.213Z","dependency_job_id":"651b694f-0752-45e2-93cb-19892a7d8504","html_url":"https://github.com/stdlib-js/strided-napi-binary","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"ac748bf322b5c1c9290944df00bad86c10d12b04"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/strided-napi-binary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-napi-binary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-napi-binary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-napi-binary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-napi-binary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/strided-napi-binary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstrided-napi-binary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016921,"owners_count":26085908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addon","array","binary","javascript","n-api","napi","node","node-api","node-js","nodejs","stdlib","strided"],"created_at":"2025-01-30T17:37:21.907Z","updated_at":"2025-10-13T20:30:37.078Z","avatar_url":"https://github.com/stdlib-js.png","language":"C","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2021 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Binary\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e C API for registering a Node-API module exporting a strided array interface for applying a binary callback to input strided arrays.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/strided-napi-binary\n```\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar headerDir = require( '@stdlib/strided-napi-binary' );\n```\n\n#### headerDir\n\nAbsolute file path for the directory containing header files for C APIs.\n\n```javascript\nvar dir = headerDir;\n// returns \u003cstring\u003e\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n```javascript\nvar headerDir = require( '@stdlib/strided-napi-binary' );\n\nconsole.log( headerDir );\n// =\u003e \u003cstring\u003e\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- C interface documentation. --\u003e\n\n* * *\n\n\u003csection class=\"c\"\u003e\n\n## C APIs\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- C usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```c\n#include \"stdlib/strided/napi/binary.h\"\n```\n\n#### stdlib_strided_napi_binary( env, info, \\*obj )\n\nInvokes a strided array interface which applies a binary callback to input strided arrays based on provided JavaScript arguments.\n\n```c\n#include \"stdlib/strided/base/function_object.h\"\n#include \u003cnode_api.h\u003e\n\n// ...\n\nstatic const struct StridedFunctionObject obj = {...};\n\n// ...\n\n/**\n* Receives JavaScript callback invocation data.\n*\n* @param env    environment under which the function is invoked\n* @param info   callback data\n* @return       Node-API value\n*/\nnapi_value addon( napi_env env, napi_callback_info info ) {\n    stdlib_strided_napi_binary( env, info, \u0026obj );\n    return NULL;\n}\n\n// ...\n```\n\nThe function accepts the following arguments:\n\n-   **env**: `[in] napi_env` environment under which the function is invoked.\n-   **info**: `[in] napi_callback_info` callback data.\n-   **obj**: `[in] struct StridedFunctionObject*` strided array [function object][@stdlib/strided/base/function-object].\n\n```c\nvoid stdlib_strided_napi_binary( napi_env env, napi_callback_info info, const struct StridedFunctionObject *obj );\n```\n\n#### STDLIB_STRIDED_NAPI_MODULE_BINARY( obj )\n\nMacro for registering a Node-API module exporting a strided array interface for applying a binary callback to input strided arrays.\n\n```c\n#include \"stdlib/strided/base/function_object.h\"\n\n// ...\n\n// Create a strided function object:\nstatic const struct StridedFunctionObject obj = {...};\n\n// ...\n\n// Register a Node-API module:\nSTDLIB_STRIDED_NAPI_MODULE_BINARY( obj );\n```\n\nThe macro expects the following arguments:\n\n-   **obj**: `struct StridedFunctionObject` strided array [function object][@stdlib/strided/base/function-object].\n\nWhen used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n### Notes\n\n-   The function expects that the callback `info` argument provides access to the following JavaScript arguments:\n\n    -   **N**: number of indexed elements.\n    -   **dtypeX**: `X` [data type][@stdlib/strided/dtypes] (enumeration constant).\n    -   **X**: input [typed array][mdn-typed-array].\n    -   **strideX**: `X` stride length.\n    -   **dtypeY**: `Y`  [data type][@stdlib/strided/dtypes] (enumeration constant).\n    -   **Y**: input [typed array][mdn-typed-array].\n    -   **strideY**: `Y` stride length.\n    -   **dtypeZ**: `Z`  [data type][@stdlib/strided/dtypes] (enumeration constant).\n    -   **Z**: destination [typed array][mdn-typed-array].\n    -   **strideZ**: `Z` stride length.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- C API usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.c --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/strided-napi-binary.svg\n[npm-url]: https://npmjs.org/package/@stdlib/strided-napi-binary\n\n[test-image]: https://github.com/stdlib-js/strided-napi-binary/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/strided-napi-binary/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-napi-binary/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/strided-napi-binary?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/strided-napi-binary.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/strided-napi-binary/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided-napi-binary/main/LICENSE\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n[@stdlib/strided/base/function-object]: https://github.com/stdlib-js/strided-base-function-object\n\n[@stdlib/strided/dtypes]: https://github.com/stdlib-js/strided-dtypes\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstrided-napi-binary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstrided-napi-binary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstrided-napi-binary/lists"}