Convert a linear index in an underlying data buffer to a linear index in an array view.
npm install @stdlib/ndarray-base-bind2vindAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var bind2vind = require( '@stdlib/ndarray-base-bind2vind' );Converts a linear index in an underlying data buffer to a linear index in an array view.
var shape = [ 3, 3 ];
var order = 'row-major';
var strides = [ -3, 1 ];
var offset = 6;
var idx = bind2vind( shape, strides, offset, order, 7, 'throw' );
// returns 1The function supports the following modes:
throw: specifies that the function should throw an error when a linear index exceeds array dimensions.wrap: specifies that the function should wrap around a linear index exceeding array dimensions using modulo arithmetic.clamp: specifies that the function should set a linear index exceeding array dimensions to either0(minimum linear index) or the maximum linear index.
var shape = [ 2, 2 ];
var order = 'row-major';
var strides = [ -2, 1 ];
var offset = 2;
var idx = bind2vind( shape, strides, offset, order, -2, 'wrap' );
// returns 0
idx = bind2vind( shape, strides, offset, order, 10, 'clamp' );
// returns 1The order parameter specifies whether an array is row-major (C-style) or column-major (Fortran-style).
var shape = [ 2, 2 ];
var order = 'column-major';
var strides = [ 1, -2 ];
var offset = 2;
var idx = bind2vind( shape, strides, offset, order, 2, 'throw' );
// returns 0var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
var numel = require( '@stdlib/ndarray-base-numel' );
var randu = require( '@stdlib/random-base-randu' );
var bind2vind = require( '@stdlib/ndarray-base-bind2vind' );
// Specify array meta data:
var shape = [ 3, 3, 3 ];
var order = 'row-major';
// Compute array meta data:
var len = numel( shape );
var strides = shape2strides( shape, order );
// Randomly flip the sign of strides...
var i;
for ( i = 0; i < shape.length; i++ ) {
if ( randu() < 0.5 ) {
strides[ i ] *= -1;
}
}
// Compute the underlying data buffer index offset:
var offset = strides2offset( shape, strides );
// Print array info:
console.log( 'Dims: %s', shape.join( 'x' ) );
console.log( 'Strides: %s', strides.join( ',' ) );
console.log( 'Offset: %d', offset );
// For each underlying data buffer index, determine the corresponding index into an array view...
var ind;
for ( i = 0; i < len; i++ ) {
ind = bind2vind( shape, strides, offset, order, i, 'throw' );
console.log( 'buffer[%d] => view[%d]', i, ind );
}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-2023. The Stdlib Authors.
