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!
NPM version Build Status Coverage Status
Return an array containing a truncated view of an input ndarray and a view of the first element(s) along a specified dimension.
npm install @stdlib/ndarray-base-shift
Alternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README).
The branches.md 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.
var shift = require( '@stdlib/ndarray-base-shift' );
Returns an array containing a truncated view of an input ndarray and a view of the first element(s) along a specified dimension.
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 <ndarray> var arr = ndarray2array( x ); // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] var y = shift( x, 0, false ); // returns [ <ndarray>, <ndarray> ] arr = ndarray2array( y[ 0 ] ); // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] arr = ndarray2array( y[ 1 ] ); // returns [ [ 1.0, 2.0 ] ]
The function accepts the following arguments:
- x: input ndarray.
- dim: dimension along which to perform the operation. 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. - writable: boolean indicating whether a returned ndarray should be writable.
- The
writableparameter only applies to ndarray constructors supporting read-only instances.
var array = require( '@stdlib/ndarray-array' ); var ndarray2array = require( '@stdlib/ndarray-to-array' ); var zeroTo = require( '@stdlib/array-base-zero-to' ); var shift = require( '@stdlib/ndarray-base-shift' ); // Create a linear ndarray buffer: var buf = zeroTo( 27 ); // Create an ndarray which is a stack of three 3x3 matrices: var x = array( buf, { 'shape': [ 3, 3, 3 ] }); // Remove the first row from each matrix: var y = shift( x, 1, false ); // returns [ <ndarray>, <ndarray> ] console.log( ndarray2array( y[ 0 ] ) ); console.log( ndarray2array( y[ 1 ] ) );
This package is part of 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, see the main project repository.
See LICENSE.
Copyright © 2016-2025. The Stdlib Authors.