Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/ndarray-slice-dimension-from

Return a read-only shifted view of an input ndarray along a specific dimension.

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

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 shift slice stdlib structure truncate types vector view
Last synced: 6 months ago · JSON representation ·

Repository

Return a read-only shifted view of an input ndarray along a specific dimension.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
copy data javascript matrix ndarray node node-js nodejs shift slice stdlib structure truncate types vector view
Created over 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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!

sliceDimensionFrom

NPM version Build Status Coverage Status <!-- dependencies -->

Return a read-only shifted view of an input ndarray along a specified dimension.

## Installation ```bash npm install @stdlib/ndarray-slice-dimension-from ``` 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 sliceDimensionFrom = require( '@stdlib/ndarray-slice-dimension-from' ); ``` #### sliceDimensionFrom( x, dim, start\[, options] ) Returns a **read-only** shifted view of an input [`ndarray`][@stdlib/ndarray/ctor] along a specified dimension. ```javascript 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 y = sliceDimensionFrom( x, 0, 1 ); // returns sh = y.shape; // returns [ 2, 2 ] arr = ndarray2array( y ); // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] ``` The function accepts the following arguments: - **x**: input [`ndarray`][@stdlib/ndarray/ctor]. - **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`. - **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`. - **options**: function options. 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 starting index which exceeds array bounds. To return an empty array when a starting index exceeds array bounds, set the `strict` option to `false`. ```javascript 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 y = sliceDimensionFrom( x, 1, 20, { 'strict': false }); // returns sh = y.shape; // returns [ 3, 0 ] arr = ndarray2array( y ); // returns [] ```
## Examples ```javascript var array = require( '@stdlib/ndarray-array' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var zeroTo = require( '@stdlib/array-base-zero-to' ); var sliceDimensionFrom = require( '@stdlib/ndarray-slice-dimension-from' ); // Create a linear ndarray buffer: var buf = zeroTo( 27 ); // Create an ndarray: var x = array( buf, { 'shape': [ 3, 3, 3 ] }); // Get the last two rows of each matrix: var y1 = sliceDimensionFrom( x, 1, 1 ); // returns var a1 = ndarray2array( y1 ); // returns [ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ] // Get the last columns of each matrix: var y2 = sliceDimensionFrom( x, 2, 1 ); // returns var a2 = ndarray2array( y2 ); // returns [ [ [ 1, 2 ], [ 4, 5 ], [ 7, 8 ] ], [ [ 10, 11 ], [ 13, 14 ], [ 16, 17 ] ], [ [ 19, 20 ], [ 22, 23 ], [ 25, 26 ] ] ] // Get the last two matrices: var y3 = sliceDimensionFrom( x, 0, 1 ); // returns var a3 = ndarray2array( y3 ); // returns [ [ [ 9, 10, 11 ], [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 18, 19, 20 ], [ 21, 22, 23 ], [ 24, 25, 26 ] ] ] ```
* * * ## See Also - [`@stdlib/ndarray-array`][@stdlib/ndarray/array]: multidimensional arrays. - [`@stdlib/ndarray-ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. - [`@stdlib/ndarray-slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray. - [`@stdlib/ndarray-slice-dimension`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input ndarray when sliced along a specified dimension. - [`@stdlib/ndarray-slice-dimension-to`][@stdlib/ndarray/slice-dimension-to]: return a read-only truncated view of an input ndarray along a specific dimension. - [`@stdlib/ndarray-slice-from`][@stdlib/ndarray/slice-from]: return a read-only shifted view of an input ndarray.
* * * ## 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

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: 23
Last Year
  • Push event: 23

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 23
  • Total Committers: 1
  • Avg Commits per committer: 23.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 10
  • Committers: 1
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 23
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 7 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 4 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-slice-dimension-from

Return a read-only shifted view of an input ndarray along a specific dimension.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 4 Last month
Rankings
Forks count: 15.8%
Stargazers count: 21.5%
Average: 31.8%
Dependent repos count: 37.0%
Dependent packages count: 53.0%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 7 months ago