{"id":20562179,"url":"https://github.com/stdlib-js/slice-base-seq2multislice","last_synced_at":"2026-03-02T22:02:16.811Z","repository":{"id":196238300,"uuid":"694658520","full_name":"stdlib-js/slice-base-seq2multislice","owner":"stdlib-js","description":"Convert a multidimensional subsequence string to a MultiSlice object.","archived":false,"fork":false,"pushed_at":"2025-01-03T03:14:23.000Z","size":458,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-13T02:34:22.114Z","etag":null,"topics":["base","colon","ellipsis","javascript","multiple","ndarray","node","node-js","nodejs","python","range","sequence","slice","stdlib","subseq","subsequence"],"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-09-21T12:43:28.000Z","updated_at":"2025-01-03T03:08:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"8bee2c2a-1d38-4b95-90f1-d6e85b1c169f","html_url":"https://github.com/stdlib-js/slice-base-seq2multislice","commit_stats":{"total_commits":19,"total_committers":1,"mean_commits":19.0,"dds":0.0,"last_synced_commit":"3b8593a31ca7a45a1ee9a674f4208673a8c521fa"},"previous_names":["stdlib-js/slice-base-seq2multislice"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-base-seq2multislice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-base-seq2multislice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-base-seq2multislice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-base-seq2multislice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/slice-base-seq2multislice/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248657853,"owners_count":21140843,"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":["base","colon","ellipsis","javascript","multiple","ndarray","node","node-js","nodejs","python","range","sequence","slice","stdlib","subseq","subsequence"],"created_at":"2024-11-16T04:09:31.653Z","updated_at":"2026-03-02T22:02:16.802Z","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) 2023 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# seq2multislice\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 Convert a multidimensional subsequence string to a [`MultiSlice`][@stdlib/slice/multi] object.\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/slice-base-seq2multislice\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 seq2multislice = require( '@stdlib/slice-base-seq2multislice' );\n```\n\n\u003ca name=\"main\"\u003e\u003c/a\u003e\n\n#### seq2multislice( str, shape, strict )\n\nConverts a multidimensional subsequence string to a [`MultiSlice`][@stdlib/slice/multi] object, where `shape` specifies the maximum allowed slice shape.\n\n```javascript\nvar s = seq2multislice( ':5', [ 10 ], false );\n// returns \u003cMultiSlice\u003e\n\nvar s0 = s.data[ 0 ];\n// returns \u003cSlice\u003e\n\nvar v = s0.start;\n// returns 0\n\nv = s0.stop;\n// returns 5\n\nv = s0.step;\n// returns 1\n```\n\nA multidimensional subsequence string is a comma-separated list of single-dimension indexing expressions (i.e., integers and/or [subsequence strings][@stdlib/slice/base/seq2slice]). For example, the following\n\n```text\n2\n:\n2:\n:10\n2:10\n::-1\n10:2:-1\n:2:\n2:10:\n2::2\n:10:2\n:, :, :\n1, 2, 3\n0:10, 1:20:2, ::-1\n...\n:, ..., 2\n```\n\nare all valid multidimensional subsequence strings. The function returns an error object if provided an invalid subsequence string.\n\n```javascript\nvar s = seq2multislice( '1:2:3:4', [ 10 ], false );\n// returns { 'code': 'ERR_SLICE_INVALID_SUBSEQUENCE' }\n```\n\nWhen `strict` is `true`, the function returns an error object if a subsequence string resolves to a slice exceeding index bounds.\n\n```javascript\nvar s = seq2multislice( '10:20', [ 10 ], true );\n// returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' }\n```\n\nA returned error object may have one of the following error codes:\n\n-   **ERR_SLICE_INVALID_SUBSEQUENCE**: a subsequence string is invalid.\n-   **ERR_SLICE_INVALID_INCREMENT**: a subsequence string must have a non-zero increment.\n-   **ERR_SLICE_OUT_OF_BOUNDS**: a subsequence string resolves to a slice exceeding index bounds.\n-   **ERR_SLICE_TOO_MANY_DIMENSIONS**: a subsequence string has more dimensions than the provided shape.\n-   **ERR_SLICE_INSUFFICIENT_DIMENSIONS**: a subsequence string has too few dimensions.\n-   **ERR_SLICE_INVALID_ELLIPSIS**: a subsequence string must only contain at most one ellipsis.\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## Notes\n\n-   Providing a single nonnegative integer `i` as a single-dimension index indexes the same elements as the subsequence `i:i+1`.\n-   Providing a single negative integer `i` as a single-dimension index indexes the same elements as the subsequence `n+i:n+i+i`, where `n` is the dimension size.\n-   While integers index the same elements as equivalent subsequences, providing an integer as a single-dimension index indicates to reduce the number of dimensions by one (e.g., if the provided shape corresponds to an array having rank `2`, then `rank(A)-1 == rank(A['0,:'])`). In contrast, providing a subsequence indicates to retain a respective dimension (e.g., if the provided shape corresponds to an array having rank `2`, then `rank(A) == rank(A[':,:'])`).\n-   A multidimensional subsequence string can only contain **one** ellipsis ('...') operator. An ellipsis indicates to apply `:` to each dimension necessary to index all dimensions (e.g., if `A` has rank `4`, `A['1:, ..., 2:5'] == A['1:, :, :, 2:5']`).\n-   Except in the case of providing a single ellipsis, the number of single-dimension indexing expressions must equal the number of dimensions in the input shape.\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\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar seq2multislice = require( '@stdlib/slice-base-seq2multislice' );\n\nvar s = seq2multislice( ':,:,:', [ 10, 10, 10 ], false );\nvar d = s.data;\n// returns [ \u003cSlice\u003e, \u003cSlice\u003e, \u003cSlice\u003e ]\n\ns = seq2multislice( '3,2:10,:', [ 10, 10, 10 ], false );\nd = s.data;\n// returns [ 3, \u003cSlice\u003e, \u003cSlice\u003e ]\n\ns = seq2multislice( '2,2:,-5', [ 10, 10, 10 ], false );\nd = s.data;\n// returns [ 2, \u003cSlice\u003e, -5 ]\n\ns = seq2multislice( '::-2,-1,...,:', [ 10, 10, 10, 10, 10, 10 ], false );\nd = s.data;\n// returns [ \u003cSlice\u003e, -1, \u003cSlice\u003e, \u003cSlice\u003e, \u003cSlice\u003e, \u003cSlice\u003e ]\n\ns = seq2multislice( 'foo,bar', [ 10, 10 ], false );\n// returns { 'code': 'ERR_SLICE_INVALID_SUBSEQUENCE' }\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\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* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/slice-base/seq2slice`][@stdlib/slice/base/seq2slice]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003econvert a subsequence string to a Slice object.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/slice-base/sargs2multislice`][@stdlib/slice/base/sargs2multislice]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate a MultiSlice object from a comma-separated list of string-serialized MultiSlice constructor arguments.\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-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/slice-base-seq2multislice.svg\n[npm-url]: https://npmjs.org/package/@stdlib/slice-base-seq2multislice\n\n[test-image]: https://github.com/stdlib-js/slice-base-seq2multislice/actions/workflows/test.yml/badge.svg?branch=v0.2.3\n[test-url]: https://github.com/stdlib-js/slice-base-seq2multislice/actions/workflows/test.yml?query=branch:v0.2.3\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/slice-base-seq2multislice/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/slice-base-seq2multislice?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/slice-base-seq2multislice.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/slice-base-seq2multislice/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/slice-base-seq2multislice/tree/deno\n[deno-readme]: https://github.com/stdlib-js/slice-base-seq2multislice/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/slice-base-seq2multislice/tree/umd\n[umd-readme]: https://github.com/stdlib-js/slice-base-seq2multislice/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/slice-base-seq2multislice/tree/esm\n[esm-readme]: https://github.com/stdlib-js/slice-base-seq2multislice/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/slice-base-seq2multislice/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/slice-base-seq2multislice/main/LICENSE\n\n[@stdlib/slice/multi]: https://github.com/stdlib-js/slice-multi\n\n[@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/slice-base-seq2slice\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/slice/base/sargs2multislice]: https://github.com/stdlib-js/slice-base-sargs2multislice\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fslice-base-seq2multislice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fslice-base-seq2multislice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fslice-base-seq2multislice/lists"}