{"id":26822452,"url":"https://github.com/stdlib-js/ndarray-dispatch-by","last_synced_at":"2025-04-26T10:44:25.763Z","repository":{"id":66335040,"uuid":"596395171","full_name":"stdlib-js/ndarray-dispatch-by","owner":"stdlib-js","description":"Create an ndarray function interface which accepts a callback function and performs multiple dispatch.","archived":false,"fork":false,"pushed_at":"2025-03-10T02:31:34.000Z","size":1081,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T17:57:18.886Z","etag":null,"topics":["accessor","array","dispatch","javascript","matrix","multidimensional","multimethod","multimethods","multiple-dispatch","ndarray","node","node-js","nodejs","stdlib","tensor","vector"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","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},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2023-02-02T04:42:17.000Z","updated_at":"2025-03-10T01:41:41.000Z","dependencies_parsed_at":"2023-09-24T08:45:33.301Z","dependency_job_id":"1ccdecb1-336e-40bb-b540-871010dddb9e","html_url":"https://github.com/stdlib-js/ndarray-dispatch-by","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-dispatch-by","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-dispatch-by/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-dispatch-by/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-dispatch-by/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-dispatch-by/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250785951,"owners_count":21487144,"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","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":["accessor","array","dispatch","javascript","matrix","multidimensional","multimethod","multimethods","multiple-dispatch","ndarray","node","node-js","nodejs","stdlib","tensor","vector"],"created_at":"2025-03-30T08:18:42.981Z","updated_at":"2025-04-25T08:42:59.969Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2022 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# dispatchBy\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 Create an [ndarray][@stdlib/ndarray/ctor] function interface which performs multiple dispatch.\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/ndarray-dispatch-by\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar dispatchBy = require( '@stdlib/ndarray-dispatch-by' );\n```\n\n#### dispatchBy( fcns, types, data, nargs, nin, nout )\n\nReturns an [ndarray][@stdlib/ndarray/ctor] function interface which performs multiple dispatch.\n\n\u003c!-- eslint-disable array-element-newline --\u003e\n\n```javascript\nconsole.log( 'TODO' );\n```\n\nThe function accepts the following arguments:\n\n-   **fcns**: list of [ndarray][@stdlib/ndarray/ctor] functions.\n-   **types**: one-dimensional list of [ndarray][@stdlib/ndarray/ctor] argument [data types][@stdlib/ndarray/dtypes]. The length of `types` must be the number of [ndarray][@stdlib/ndarray/ctor] functions multiplied by `nin+nout`. If `fcns` is a function, rather than a list, the number of [ndarray][@stdlib/ndarray/ctor] functions is computed as `types.length / (nin+nout)`.\n-   **data**: [ndarray][@stdlib/ndarray/ctor] function data (e.g., callbacks). If a list, the length of `data` must equal the number of [ndarray][@stdlib/ndarray/ctor] functions. If `null`, a returned [ndarray][@stdlib/ndarray/ctor] function interface does **not** provide a `data` argument to an invoked [ndarray][@stdlib/ndarray/ctor] function.\n-   **nargs**: total number of [ndarray][@stdlib/ndarray/ctor] function interface arguments.\n-   **nin**: number of input [ndarrays][@stdlib/ndarray/ctor].\n-   **nout**: number of output [ndarrays][@stdlib/ndarray/ctor].\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   A returned [ndarray][@stdlib/ndarray/ctor] function interface has the following signature:\n\n    ```text\n    f( x, y, ... )\n    ```\n\n    where\n\n    -   **x**: [ndarray][@stdlib/ndarray/ctor].\n    -   **y**: [ndarray][@stdlib/ndarray/ctor].\n    -   **...**: additional [ndarrays][@stdlib/ndarray/ctor].\n\n-   The number of [ndarray][@stdlib/ndarray/ctor] function interface parameters is derived from `nargs`, the number of input [ndarrays][@stdlib/ndarray/ctor] is derived from `nin`, and the number of output [ndarrays][@stdlib/ndarray/ctor] is derived from `nout`.\n\n-   An [ndarray][@stdlib/ndarray/ctor] function (i.e., a value provided for the `fcns` argument) should have the following signature:\n\n    ```text\n    f( arrays[, data] )\n    ```\n\n    where\n\n    -   **arrays**: array containing input and output [ndarrays][@stdlib/ndarray/ctor].\n    -   **data**: [ndarray][@stdlib/ndarray/ctor] function data (e.g., a callback).\n\n-   For convenience, a single [ndarray][@stdlib/ndarray/ctor] function may be provided which will be invoked whenever the [ndarray][@stdlib/ndarray/ctor] argument data types match a sequence of types in `types`. Providing a single [ndarray][@stdlib/ndarray/ctor] function is particularly convenient for the case where, regardless of array data types, traversing arrays remains the same, but the [ndarray][@stdlib/ndarray/ctor] function `data` differs (e.g., callbacks which differ based on the array data types). For example, the following\n\n    \u003c!-- eslint-disable array-element-newline --\u003e\n\n    ```javascript\n    var unary = require( '@stdlib/ndarray-base-unary-by' );\n\n    function foo( x ) {\n        return x * 10.0;\n    }\n\n    function bar( x ) {\n        return x * 5.0;\n    }\n\n    var fcns = [\n        unary,\n        unary\n    ];\n    var types = [\n        'float64', 'float64',\n        'float32', 'float32'\n    ];\n    var data = [\n        foo,\n        bar\n    ];\n\n    var fcn = dispatchBy( fcns, types, data, 2, 1, 1 );\n    ```\n\n    is equivalent to\n\n    \u003c!-- eslint-disable array-element-newline --\u003e\n\n    ```javascript\n    var unary = require( '@stdlib/ndarray-base-unary-by' );\n\n    function foo( x ) {\n        return x * 10.0;\n    }\n\n    function bar( x ) {\n        return x * 5.0;\n    }\n\n    var types = [\n        'float64', 'float64',\n        'float32', 'float32'\n    ];\n    var data = [\n        foo,\n        bar\n    ];\n\n    var fcn = dispatchBy( unary, types, data, 2, 1, 1 );\n    ```\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nconsole.log( 'TODO' );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\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* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-array`][@stdlib/ndarray/array]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003emultidimensional arrays.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-ctor`][@stdlib/ndarray/ctor]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003emultidimensional array constructor.\u003c/span\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/ndarray-dispatch-by.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-dispatch-by\n\n[test-image]: https://github.com/stdlib-js/ndarray-dispatch-by/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-dispatch-by/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-dispatch-by/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-dispatch-by?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-dispatch-by.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-dispatch-by/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[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/ndarray-dispatch-by/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-dispatch-by/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-dispatch-by/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-dispatch-by/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-dispatch-by/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-dispatch-by/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-dispatch-by/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-dispatch-by/main/LICENSE\n\n[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array\n\n[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor\n\n[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n\u003c!-- \u003c/related-links\u003e --\u003e\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%2Fndarray-dispatch-by","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-dispatch-by","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-dispatch-by/lists"}