@stdlib/slice-base-seq2multislice

Convert a multidimensional subsequence string to a MultiSlice object.

https://github.com/stdlib-js/slice-base-seq2multislice

Keywords

base colon ellipsis javascript multiple ndarray node node-js nodejs python range sequence slice stdlib subseq subsequence

Last synced: 4 months ago · JSON representation ·

Repository

Convert a multidimensional subsequence string to a MultiSlice object.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 455 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

base colon ellipsis javascript multiple ndarray node node-js nodejs python range sequence slice stdlib subseq subsequence

Created over 2 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We 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.

The 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.

When 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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

seq2multislice

Convert a multidimensional subsequence string to a MultiSlice object.

## Installation ```bash npm install @stdlib/slice-base-seq2multislice ``` Alternatively, - 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]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - 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]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To 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.

## Usage ```javascript var seq2multislice = require( '@stdlib/slice-base-seq2multislice' ); ``` #### seq2multislice( str, shape, strict ) Converts a multidimensional subsequence string to a [`MultiSlice`][@stdlib/slice/multi] object, where `shape` specifies the maximum allowed slice shape. ```javascript var s = seq2multislice( ':5', [ 10 ], false ); // returns var s0 = s.data[ 0 ]; // returns var v = s0.start; // returns 0 v = s0.stop; // returns 5 v = s0.step; // returns 1 ``` A 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 ```text 2 : 2: :10 2:10 ::-1 10:2:-1 :2: 2:10: 2::2 :10:2 :, :, : 1, 2, 3 0:10, 1:20:2, ::-1 ... :, ..., 2 ``` are all valid multidimensional subsequence strings. The function returns an error object if provided an invalid subsequence string. ```javascript var s = seq2multislice( '1:2:3:4', [ 10 ], false ); // returns { 'code': 'ERR_SLICE_INVALID_SUBSEQUENCE' } ``` When `strict` is `true`, the function returns an error object if a subsequence string resolves to a slice exceeding index bounds. ```javascript var s = seq2multislice( '10:20', [ 10 ], true ); // returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' } ``` A returned error object may have one of the following error codes: - **ERR_SLICE_INVALID_SUBSEQUENCE**: a subsequence string is invalid. - **ERR_SLICE_INVALID_INCREMENT**: a subsequence string must have a non-zero increment. - **ERR_SLICE_OUT_OF_BOUNDS**: a subsequence string resolves to a slice exceeding index bounds. - **ERR_SLICE_TOO_MANY_DIMENSIONS**: a subsequence string has more dimensions than the provided shape. - **ERR_SLICE_INSUFFICIENT_DIMENSIONS**: a subsequence string has too few dimensions. - **ERR_SLICE_INVALID_ELLIPSIS**: a subsequence string must only contain at most one ellipsis.

## Notes - Providing a single nonnegative integer `i` as a single-dimension index indexes the same elements as the subsequence `i:i+1`. - 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. - 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[':,:'])`). - 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']`). - 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.

## Examples ```javascript var seq2multislice = require( '@stdlib/slice-base-seq2multislice' ); var s = seq2multislice( ':,:,:', [ 10, 10, 10 ], false ); var d = s.data; // returns [ , , ] s = seq2multislice( '3,2:10,:', [ 10, 10, 10 ], false ); d = s.data; // returns [ 3, , ] s = seq2multislice( '2,2:,-5', [ 10, 10, 10 ], false ); d = s.data; // returns [ 2, , -5 ] s = seq2multislice( '::-2,-1,...,:', [ 10, 10, 10, 10, 10, 10 ], false ); d = s.data; // returns [ , -1, , , , ] s = seq2multislice( 'foo,bar', [ 10, 10 ], false ); // returns { 'code': 'ERR_SLICE_INVALID_SUBSEQUENCE' } ```

* * * ## Notice This 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. For 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]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 19

Last Year

Push event: 19

Committers

Last synced: 6 months ago

All Time

Total Commits: 24
Total Committers: 1
Avg Commits per committer: 24.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 9
Committers: 1
Avg Commits per committer: 9.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	24

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 2 last-month

Total dependent packages: 2
Total dependent repositories: 1
Total versions: 4
Total maintainers: 4

npmjs.org: @stdlib/slice-base-seq2multislice

Convert a multidimensional subsequence string to a MultiSlice object.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 4
Dependent Packages: 2
Dependent Repositories: 1
Downloads: 2 Last month

Rankings

Dependent packages count: 8.9%

Dependent repos count: 10.3%

Average: 13.7%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 17.1%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 months ago

@stdlib/slice-base-seq2multislice

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

seq2multislice

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/slice-base-seq2multislice

Rankings

Maintainers (4)

Funding