@stdlib/ndarray-slice

Return a read-only view of an input ndarray.

https://github.com/stdlib-js/ndarray-slice

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.4%) to scientific vocabulary

Keywords

copy data javascript matrix ndarray node node-js nodejs slice stdlib structure types vector view

Last synced: 6 months ago · JSON representation ·

Repository

Return a read-only view of an input ndarray.

Basic Info

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

Statistics

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

Topics

copy data javascript matrix ndarray node node-js nodejs slice stdlib structure types vector view

Created over 2 years ago · Last pushed 11 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!

slice

Return a read-only view of an input ndarray.

## Installation ```bash npm install @stdlib/ndarray-slice ``` 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 slice = require( '@stdlib/ndarray-slice' ); ``` #### slice( x, ...s\[, options] ) Returns a **read-only** view of an input [`ndarray`][@stdlib/ndarray/ctor]. ```javascript var Slice = require( '@stdlib/slice-ctor' ); var MultiSlice = require( '@stdlib/slice-multi' ); var ndarray = require( '@stdlib/ndarray-ctor' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; var shape = [ 3, 2 ]; var strides = [ 2, 1 ]; var offset = 0; var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); // returns var sh = x.shape; // returns [ 3, 2 ] var arr = ndarray2array( x ); // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] var s0 = new Slice( null, null, -2 ); var s1 = new Slice( null, null, -1 ); var s = new MultiSlice( s0, s1 ); // returns var y = slice( x, s ); // returns sh = y.shape; // returns [ 2, 2 ] arr = ndarray2array( y ); // returns [ [ 6.0, 5.0 ], [ 2.0, 1.0 ] ] ``` The function accepts the following arguments: - **x**: input [`ndarray`][@stdlib/ndarray/ctor]. - **s**: a [`MultiSlice`][@stdlib/slice/multi] instance, an array of slice arguments, or slice arguments as separate arguments. - **options**: function options. The function supports three (mutually exclusive) means for providing slice arguments: 1. providing a single [`MultiSlice`][@stdlib/slice/multi] instance. 2. providing a single array of slice arguments. 3. providing slice arguments as separate arguments. The following example demonstrates each invocation style returning equivalent results. ```javascript var Slice = require( '@stdlib/slice-ctor' ); var MultiSlice = require( '@stdlib/slice-multi' ); var ndarray = require( '@stdlib/ndarray-ctor' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; var shape = [ 3, 2 ]; var strides = [ 2, 1 ]; var offset = 0; var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); // returns var sh = x.shape; // returns [ 3, 2 ] var arr = ndarray2array( x ); // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] // 1. Using a MultiSlice: var s0 = new Slice( 1, null, 1 ); var s1 = new Slice( null, null, 1 ); var s = new MultiSlice( s0, s1 ); // returns var y = slice( x, s ); // returns sh = y.shape; // returns [ 2, 2 ] arr = ndarray2array( y ); // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] // 2. Using an array of slice arguments: y = slice( x, [ s0, s1 ] ); // returns sh = y.shape; // returns [ 2, 2 ] arr = ndarray2array( y ); // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] // 3. Providing separate arguments: y = slice( x, s0, s1 ); // returns sh = y.shape; // returns [ 2, 2 ] arr = ndarray2array( y ); // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] ``` The function supports the following `options`: - **strict**: boolean indicating whether to enforce strict bounds checking. By default, the function throws an error when provided a slice which exceeds array bounds. To return an empty array when a slice exceeds array bounds, set the `strict` option to `false`. ```javascript var Slice = require( '@stdlib/slice-ctor' ); var MultiSlice = require( '@stdlib/slice-multi' ); var ndarray = require( '@stdlib/ndarray-ctor' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; var shape = [ 3, 2 ]; var strides = [ 2, 1 ]; var offset = 0; var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); // returns var sh = x.shape; // returns [ 3, 2 ] var arr = ndarray2array( x ); // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] var s0 = new Slice( 1, null, 1 ); var s1 = new Slice( 10, 20, 1 ); var s = new MultiSlice( s0, s1 ); // returns var y = slice( x, s, { 'strict': false }); // returns sh = y.shape; // returns [ 2, 0 ] arr = ndarray2array( y ); // returns [] ```

## Notes - A **slice argument** must be either a [`Slice`][@stdlib/slice/ctor], an integer, `null`, or `undefined`. - The number of slice dimensions must match the number of array dimensions. Hence, if `x` is a zero-dimensional [`ndarray`][@stdlib/ndarray/ctor], then, if `s` is a [`MultiSlice`][@stdlib/slice/multi], `s` should be empty, and, if `s` is an array, `s` should not contain any slice arguments. Similarly, if `x` is a one-dimensional [`ndarray`][@stdlib/ndarray/ctor], then, if `s` is a [`MultiSlice`][@stdlib/slice/multi], `s` should have one slice dimension, and, if `s` is an array, `s` should contain a single slice argument. And so on and so forth.

## Examples ```javascript var S = require( '@stdlib/slice-ctor' ); var E = require( '@stdlib/slice-multi' ); var array = require( '@stdlib/ndarray-array' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var zeroTo = require( '@stdlib/array-base-zero-to' ); var slice = require( '@stdlib/ndarray-slice' ); // Alias `null` to allow for more compact indexing expressions: var _ = null; // Create a linear ndarray buffer: var buf = zeroTo( 27 ); // Create an ndarray: var x = array( buf, { 'shape': [ 3, 3, 3 ] }); // Get each matrix... var s1 = E( 0, _, _ ); var y1 = slice( x, s1 ); // returns var a1 = ndarray2array( y1 ); // returns [ [ 0, 1, 2 ], [ 3, 4, 5 ], [ 6, 7, 8 ] ] var s2 = E( 1, _, _ ); var y2 = slice( x, s2 ); // returns var a2 = ndarray2array( y2 ); // returns [ [ 9, 10, 11 ], [ 12, 13, 14 ], [ 15, 16, 17 ] ] var s3 = E( 2, _, _ ); var y3 = slice( x, s3 ); // returns var a3 = ndarray2array( y3 ); // returns [ [ 18, 19, 20 ], [ 21, 22, 23 ], [ 24, 25, 26 ] ] // Reverse all elements: var s = S( _, _, -1 ); var s4 = E( s, s, s ); var y4 = slice( x, s4 ); // returns var a4 = ndarray2array( y4 ); // returns [...] // Get the second rows from each matrix: var s5 = E( _, 1, _ ); var y5 = slice( x, s5 ); // returns var a5 = ndarray2array( y5 ); // returns [ [ 3, 4, 5 ], [ 12, 13, 14 ], [ 21, 22, 23 ] ] // Get the second columns from each matrix: var s6 = E( _, _, 1 ); var y6 = slice( x, s6 ); // returns var a6 = ndarray2array( y6 ); // returns [ [ 1, 4, 7 ], [ 10, 13, 16 ], [ 19, 22, 25 ] ] // Use an alternative invocation style: var y7 = slice( x, _, _, 1 ); // returns var a7 = ndarray2array( y7 ); // returns [ [ 1, 4, 7 ], [ 10, 13, 16 ], [ 19, 22, 25 ] ] // Use an alternative invocation style: var y8 = slice( x, [ _, _, 1 ] ); // returns var a8 = ndarray2array( y8 ); // returns [ [ 1, 4, 7 ], [ 10, 13, 16 ], [ 19, 22, 25 ] ] ```

* * * ## 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: 7 months ago

All Time

Total Commits: 31
Total Committers: 1
Avg Commits per committer: 31.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	31

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 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 72 last-month

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

npmjs.org: @stdlib/ndarray-slice

Return a read-only view of an input ndarray.

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

Versions: 4
Dependent Packages: 21
Dependent Repositories: 2
Downloads: 72 Last month

Rankings

Dependent packages count: 1.1%

Average: 4.9%

Downloads: 5.8%

Dependent repos count: 7.6%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

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

Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
actions/upload-artifact a8a3f3ad30e3422c9c7b888a15615d19a852ae32 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish fe72237be0920f7a0cafd6a966c9b929c9466e9b composite
act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 composite

.github/workflows/test.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

.github/workflows/test_bundles.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
denoland/setup-deno 61fe2df320078202e33d7d5ad347e7dcfa0e8f31 composite

.github/workflows/test_coverage.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
codecov/codecov-action eaaf4bedf32dbdc6b720b63067d99c4d77d6047d composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite

package.json npm

@stdlib/array-base-zero-to ^0.1.0 development
@stdlib/array-typed ^0.1.0 development
@stdlib/bench-harness ^0.1.2 development
@stdlib/ndarray-array ^0.1.0 development
@stdlib/ndarray-base-assert-is-read-only ^0.1.1 development
@stdlib/ndarray-base-ctor ^0.1.0 development
@stdlib/ndarray-base-empty ^0.1.1 development
@stdlib/ndarray-base-from-scalar ^0.1.0 development
@stdlib/ndarray-base-numel ^0.1.1 development
@stdlib/ndarray-ctor ^0.1.0 development
@stdlib/ndarray-empty ^0.1.0 development
@stdlib/ndarray-to-array ^0.1.0 development
@stdlib/ndarray-zeros ^0.1.0 development
@stdlib/slice-ctor ^0.1.0 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-has-own-property ^0.1.1
@stdlib/assert-is-array-like-object ^0.1.0
@stdlib/assert-is-boolean ^0.1.1
@stdlib/assert-is-multi-slice ^0.1.0
@stdlib/assert-is-ndarray-like ^0.1.0
@stdlib/assert-is-plain-object ^0.1.1
@stdlib/ndarray-base-slice ^0.1.0
@stdlib/ndarray-shape ^0.1.0
@stdlib/slice-base-args2multislice ^0.1.0
@stdlib/slice-multi ^0.1.0
@stdlib/string-format ^0.1.1
@stdlib/types ^0.2.0

@stdlib/ndarray-slice

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

slice

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/ndarray-slice

Rankings

Maintainers (4)

Funding

Dependencies