{"id":31240341,"url":"https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch","last_synced_at":"2026-05-17T03:46:52.084Z","repository":{"id":314659975,"uuid":"1053974339","full_name":"stdlib-js/ndarray-base-nullary-strided1d-dispatch","owner":"stdlib-js","description":"Constructor for applying a strided function to an ndarray.","archived":false,"fork":false,"pushed_at":"2026-04-11T03:41:43.000Z","size":1883,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-11T05:31:48.813Z","etag":null,"topics":["apply","array","call","javascript","ndarray","node","node-js","nodejs","nullary","stdlib","strided","tools","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,"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":"2025-09-10T07:33:16.000Z","updated_at":"2026-04-11T03:20:44.000Z","dependencies_parsed_at":"2025-12-05T06:03:12.567Z","dependency_job_id":null,"html_url":"https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch","commit_stats":null,"previous_names":["stdlib-js/ndarray-base-nullary-strided1d-dispatch"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/ndarray-base-nullary-strided1d-dispatch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-nullary-strided1d-dispatch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-nullary-strided1d-dispatch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-nullary-strided1d-dispatch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-nullary-strided1d-dispatch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-nullary-strided1d-dispatch/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33127002,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"online","status_checked_at":"2026-05-17T02:00:05.366Z","response_time":107,"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":["apply","array","call","javascript","ndarray","node","node-js","nodejs","nullary","stdlib","strided","tools","vector"],"created_at":"2025-09-22T22:30:52.661Z","updated_at":"2026-05-17T03:46:52.071Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 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# NullaryStrided1dDispatch\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 Constructor for applying a strided function to an ndarray.\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-base-nullary-strided1d-dispatch\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 NullaryStrided1dDispatch = require( '@stdlib/ndarray-base-nullary-strided1d-dispatch' );\n```\n\n#### NullaryStrided1dDispatch( table, idtypes, odtypes\\[, options] )\n\nReturns an interface for applying a strided function to an ndarray.\n\n```javascript\nvar base = require( '@stdlib/blas-ext-base-ndarray-gsorthp' );\n\nvar table = {\n    'default': base\n};\n\nvar dtypes = [ 'float64', 'float32', 'generic' ];\n\nvar nullary = new NullaryStrided1dDispatch( table, [ dtypes ], dtypes );\n```\n\nThe constructor has the following parameters:\n\n-   **table**: strided function dispatch table. Must have the following properties:\n\n    -   **default**: default strided function which should be invoked when provided ndarrays have data types which do not have a corresponding specialized implementation.\n\n    A dispatch table may have the following additional properties:\n\n    -   **types**: one-dimensional list of ndarray data types describing specialized output ndarray argument signatures. Only the output ndarray argument data types should be specified. Additional ndarray argument data types should be omitted and are not considered during dispatch. The length of `types` must equal the number of strided functions specified by `fcns`.\n    -   **fcns**: list of strided functions which are specific to specialized output ndarray argument signatures.\n\n-   **idtypes**: list containing lists of supported input data types for each input ndarray argument.\n\n-   **odtypes**: list of supported output data types.\n\n-   **options**: function options (_optional_).\n\nThe constructor supports the following options:\n\n-   **strictTraversalOrder**: boolean specifying whether the order of element traversal must match the memory layout order of an output ndarray. Default: `false`.\n\n#### NullaryStrided1dDispatch.prototype.assign( out\\[, ...args]\\[, options] )\n\nApplies a strided function and assigns results to a provided output ndarray.\n\n```javascript\nvar base = require( '@stdlib/blas-ext-base-ndarray-gsorthp' );\nvar dtypes = require( '@stdlib/ndarray-dtypes' );\nvar ndarray2array = require( '@stdlib/ndarray-to-array' );\nvar scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );\nvar ndarray = require( '@stdlib/ndarray-base-ctor' );\nvar NullaryStrided1dDispatch = require( '@stdlib/ndarray-base-nullary-strided1d-dispatch' );\n\nvar idt = dtypes( 'real_and_generic' );\nvar odt = dtypes( 'all' );\n\nvar table = {\n    'default': base\n};\nvar nullary = new NullaryStrided1dDispatch( table, [ idt ], odt );\n\nvar xbuf = [ -1.0, 2.0, -3.0 ];\nvar x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );\n\nvar order = scalar2ndarray( 1.0, {\n    'dtype': 'generic'\n});\n\nvar out = nullary.assign( x, order, {\n    'dims': [ 0 ]\n});\n// returns \u003cndarray\u003e\n\nvar arr = ndarray2array( x );\n// returns [ -3.0, -1.0, 2.0 ]\n\nvar bool = ( out === x );\n// returns true\n```\n\nThe method has the following parameters:\n\n-   **out**: output ndarray.\n-   **args**: additional input ndarray arguments (_optional_).\n-   **options**: function options (_optional_).\n\nThe method accepts the following options:\n\n-   **dims**: list of dimensions over which to perform an operation.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   A strided function should have the following signature:\n\n    ```text\n    f( arrays )\n    ```\n\n    where\n\n    -   **arrays**: array containing an output ndarray, followed by any additional ndarray arguments.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint-disable array-element-newline --\u003e\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar dsorthp = require( '@stdlib/blas-ext-base-ndarray-dsorthp' );\nvar ssorthp = require( '@stdlib/blas-ext-base-ndarray-ssorthp' );\nvar base = require( '@stdlib/blas-ext-base-ndarray-gsorthp' );\nvar discreteUniform = require( '@stdlib/random-array-discrete-uniform' );\nvar dtypes = require( '@stdlib/ndarray-dtypes' );\nvar ndarray2array = require( '@stdlib/ndarray-to-array' );\nvar scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );\nvar ndarray = require( '@stdlib/ndarray-ctor' );\nvar NullaryStrided1dDispatch = require( '@stdlib/ndarray-base-nullary-strided1d-dispatch' );\n\n// Define the supported input and output data types:\nvar idt = dtypes( 'real_and_generic' );\nvar odt = dtypes( 'all' );\n\n// Define a dispatch table:\nvar table = {\n    'types': [\n        'float64', // input/output\n        'float32'  // input/output\n    ],\n    'fcns': [\n        dsorthp,\n        ssorthp\n    ],\n    'default': base\n};\n\n// Create an interface for performing operation:\nvar sorthp = new NullaryStrided1dDispatch( table, [ idt ], odt );\n\n// Generate an array of random numbers:\nvar xbuf = discreteUniform( 25, -10, 10, {\n    'dtype': 'float64'\n});\n\n// Wrap in an ndarray:\nvar x = new ndarray( 'float64', xbuf, [ 5, 5 ], [ 5, 1 ], 0, 'row-major' );\nconsole.log( ndarray2array( x ) );\n\n// Specify the sort order:\nvar order = scalar2ndarray( 1.0, {\n    'dtype': 'generic'\n});\n\n// Perform operation:\nsorthp.assign( x, order, {\n    'dims': [ 0, 1 ]\n});\n\n// Print the results:\nconsole.log( ndarray2array( x ) );\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\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## Copyright\n\nCopyright \u0026copy; 2016-2026. 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-base-nullary-strided1d-dispatch.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-nullary-strided1d-dispatch\n\n[test-image]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-nullary-strided1d-dispatch/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-nullary-strided1d-dispatch?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-nullary-strided1d-dispatch.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-nullary-strided1d-dispatch/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\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-base-nullary-strided1d-dispatch/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-base-nullary-strided1d-dispatch/blob/main/branches.md\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-nullary-strided1d-dispatch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-base-nullary-strided1d-dispatch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-nullary-strided1d-dispatch/lists"}