Return the index offset specifying the underlying buffer index of the first iterated ndarray element.
npm install @stdlib/ndarray-offsetWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the index offset specifying the underlying buffer index of the first iterated [ndarray][@stdlib/ndarray/ctor] element.
``bash`
npm install @stdlib/ndarray-offset
`javascript`
var offset = require( '@stdlib/ndarray-offset' );
#### offset( x )
Returns the index offset specifying the underlying buffer index of the first iterated [ndarray][@stdlib/ndarray/ctor] element.
`javascript
var zeros = require( '@stdlib/ndarray-zeros' );
var x = zeros( [ 3, 2, 3 ] );
// returns
var n = offset( x );
// returns 0
`
`javascript
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 offset = require( '@stdlib/ndarray-offset' );
// Create an array:
var x = zeros( [ 10, 10, 10, 10 ] );
// returns
// 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 ) )
];
// Determine the index offset 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( 'x' ), offset( s ) );
}
`
*
- [@stdlib/ndarray-array][@stdlib/ndarray/array]: multidimensional arrays.
- [@stdlib/ndarray-ctor][@stdlib/ndarray/ctor]: multidimensional array constructor.
- [@stdlib/ndarray-shape][@stdlib/ndarray/shape]: return the shape of a provided ndarray.
- [@stdlib/ndarray-strides][@stdlib/ndarray/strides]: return the strides of a provided ndarray.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-offset.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-offset
[test-image]: https://github.com/stdlib-js/ndarray-offset/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/ndarray-offset/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-offset/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-offset?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-offset/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-offset/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-offset/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-offset/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-offset/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-offset/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-offset/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-offset/main/LICENSE
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray-array
[@stdlib/ndarray/shape]: https://www.npmjs.com/package/@stdlib/ndarray-shape
[@stdlib/ndarray/strides]: https://www.npmjs.com/package/@stdlib/ndarray-strides