{"id":15578389,"url":"https://github.com/stdlib-js/ndarray-slice-dimension-from","last_synced_at":"2025-04-24T01:20:54.013Z","repository":{"id":204824506,"uuid":"707914978","full_name":"stdlib-js/ndarray-slice-dimension-from","owner":"stdlib-js","description":"Return a read-only shifted view of an input ndarray along a specific dimension.","archived":false,"fork":false,"pushed_at":"2025-03-17T02:31:56.000Z","size":1842,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-13T00:03:23.505Z","etag":null,"topics":["copy","data","javascript","matrix","ndarray","node","node-js","nodejs","shift","slice","stdlib","structure","truncate","types","vector","view"],"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-10-21T01:08:19.000Z","updated_at":"2025-03-17T01:14:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"1c75d4f8-c5ac-48bb-8680-204787b26d1d","html_url":"https://github.com/stdlib-js/ndarray-slice-dimension-from","commit_stats":null,"previous_names":["stdlib-js/ndarray-slice-dimension-from"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-slice-dimension-from","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-slice-dimension-from/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-slice-dimension-from/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-slice-dimension-from/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-slice-dimension-from/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250541623,"owners_count":21447554,"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":["copy","data","javascript","matrix","ndarray","node","node-js","nodejs","shift","slice","stdlib","structure","truncate","types","vector","view"],"created_at":"2024-10-02T19:10:07.744Z","updated_at":"2025-04-24T01:20:53.993Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","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# sliceDimensionFrom\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 Return a read-only shifted view of an input [`ndarray`][@stdlib/ndarray/ctor] along a specified dimension.\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/ndarray-slice-dimension-from\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 sliceDimensionFrom = require( '@stdlib/ndarray-slice-dimension-from' );\n```\n\n#### sliceDimensionFrom( x, dim, start\\[, options] )\n\nReturns a **read-only** shifted view of an input [`ndarray`][@stdlib/ndarray/ctor] along a specified dimension.\n\n```javascript\nvar ndarray = require( '@stdlib/ndarray-ctor' );\nvar ndarray2array = require( '@stdlib/ndarray-to-array' );\n\nvar buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];\nvar shape = [ 3, 2 ];\nvar strides = [ 2, 1 ];\nvar offset = 0;\n\nvar x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );\n// returns \u003cndarray\u003e\n\nvar sh = x.shape;\n// returns [ 3, 2 ]\n\nvar arr = ndarray2array( x );\n// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]\n\nvar y = sliceDimensionFrom( x, 0, 1 );\n// returns \u003cndarray\u003e\n\nsh = y.shape;\n// returns [ 2, 2 ]\n\narr = ndarray2array( y );\n// returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]\n```\n\nThe function accepts the following arguments:\n\n-   **x**: input [`ndarray`][@stdlib/ndarray/ctor].\n-   **dim**: index of dimension along which to slice. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.\n-   **start**: starting index (inclusive). If provided an integer less than zero, the corresponding element along the specified dimension is resolved relative to the last element along that dimension. For negative integers, the last element corresponds to the value `-1`.\n-   **options**: function options.\n\nThe function supports the following `options`:\n\n-   **strict**: boolean indicating whether to enforce strict bounds checking.\n\nBy default, the function throws an error when provided a starting index which exceeds array bounds. To return an empty array when a starting index exceeds array bounds, set the `strict` option to `false`.\n\n```javascript\nvar ndarray = require( '@stdlib/ndarray-ctor' );\nvar ndarray2array = require( '@stdlib/ndarray-to-array' );\n\nvar buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];\nvar shape = [ 3, 2 ];\nvar strides = [ 2, 1 ];\nvar offset = 0;\n\nvar x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );\n// returns \u003cndarray\u003e\n\nvar sh = x.shape;\n// returns [ 3, 2 ]\n\nvar arr = ndarray2array( x );\n// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]\n\nvar y = sliceDimensionFrom( x, 1, 20, {\n    'strict': false\n});\n// returns \u003cndarray\u003e\n\nsh = y.shape;\n// returns [ 3, 0 ]\n\narr = ndarray2array( y );\n// returns []\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\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar array = require( '@stdlib/ndarray-array' );\nvar ndarray2array = require( '@stdlib/ndarray-to-array' );\nvar zeroTo = require( '@stdlib/array-base-zero-to' );\nvar sliceDimensionFrom = require( '@stdlib/ndarray-slice-dimension-from' );\n\n// Create a linear ndarray buffer:\nvar buf = zeroTo( 27 );\n\n// Create an ndarray:\nvar x = array( buf, {\n    'shape': [ 3, 3, 3 ]\n});\n\n// Get the last two rows of each matrix:\nvar y1 = sliceDimensionFrom( x, 1, 1 );\n// returns \u003cndarray\u003e\n\nvar a1 = ndarray2array( y1 );\n// returns [ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]\n\n// Get the last columns of each matrix:\nvar y2 = sliceDimensionFrom( x, 2, 1 );\n// returns \u003cndarray\u003e\n\nvar a2 = ndarray2array( y2 );\n// returns [ [ [ 1, 2 ], [ 4, 5 ], [ 7, 8 ] ], [ [ 10, 11 ], [ 13, 14 ], [ 16, 17 ] ], [ [ 19, 20 ], [ 22, 23 ], [ 25, 26 ] ] ]\n\n// Get the last two matrices:\nvar y3 = sliceDimensionFrom( x, 0, 1 );\n// returns \u003cndarray\u003e\n\nvar a3 = ndarray2array( y3 );\n// returns [ [ [ 9, 10, 11 ], [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 18, 19, 20 ], [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]\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/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-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-slice`][@stdlib/ndarray/slice]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ereturn a read-only view of an input ndarray.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-slice-dimension`][@stdlib/ndarray/slice-dimension]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ereturn a read-only view of an input ndarray when sliced along a specified dimension.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-slice-dimension-to`][@stdlib/ndarray/slice-dimension-to]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ereturn a read-only truncated view of an input ndarray along a specific dimension.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-slice-from`][@stdlib/ndarray/slice-from]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ereturn a read-only shifted view of an input ndarray.\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-slice-dimension-from.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-slice-dimension-from\n\n[test-image]: https://github.com/stdlib-js/ndarray-slice-dimension-from/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-slice-dimension-from/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-slice-dimension-from/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-slice-dimension-from?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-slice-dimension-from.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-slice-dimension-from/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-slice-dimension-from/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-slice-dimension-from/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-slice-dimension-from/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-slice-dimension-from/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-slice-dimension-from/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-slice-dimension-from/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-slice-dimension-from/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-slice-dimension-from/main/LICENSE\n\n[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array\n\n[@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray-slice\n\n[@stdlib/ndarray/slice-dimension]: https://github.com/stdlib-js/ndarray-slice-dimension\n\n[@stdlib/ndarray/slice-dimension-to]: https://github.com/stdlib-js/ndarray-slice-dimension-to\n\n[@stdlib/ndarray/slice-from]: https://github.com/stdlib-js/ndarray-slice-from\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-slice-dimension-from","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-slice-dimension-from","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-slice-dimension-from/lists"}