0.2.1 • Published 3 months ago
@stdlib/ndarray-base-stride v0.2.1
stride
Return the stride along a specified dimension for a provided ndarray.
Installation
npm install @stdlib/ndarray-base-stride
Usage
var stride = require( '@stdlib/ndarray-base-stride' );
stride( x, dim )
Returns the stride along a specified dimension for a provided ndarray.
var zeros = require( '@stdlib/ndarray-zeros' );
var x = zeros( [ 3, 2, 3 ] );
// returns <ndarray>
var st = stride( x, 0 );
// returns 6
The function accepts the following arguments:
- x: input ndarray.
- dim: dimension index. 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
.
Notes
- A "stride" is the linear distance (i.e., number of elements) between adjacent elements along a specified dimension.
Examples
var zeros = require( '@stdlib/ndarray-zeros' );
var slice = require( '@stdlib/ndarray-slice' );
var E = require( '@stdlib/slice-multi' );
var S = require( '@stdlib/slice-ctor' );
var stride = require( '@stdlib/ndarray-base-stride' );
// Create an array:
var x = zeros( [ 10, 10, 10, 10 ] );
// returns <ndarray>
// Define some slices:
var slices = [
// :,:,:,:
E( null, null, null, null ),
// 5:10,4,2:4,::-1
E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),
// :,:,2,:
E( null, null, 2, null ),
// 1,2,3,:
E( 1, 2, 3, null ),
// 1,3,::2,4::2
E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
];
// Resolve the stride of the first dimension for each slice...
var s;
var i;
for ( i = 0; i < slices.length; i++ ) {
s = slice( x, slices[ i ] );
console.log( '(%s) => %d', s.shape.join( ',' ), stride( s, 0 ) );
}
Notice
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.