Reorder ndarray dimensions and associated strides for loop interchange.
npm install @stdlib/ndarray-base-binary-loop-interchange-orderWe 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]
> Reorder ndarray dimensions and associated strides for loop interchange.
``bash`
npm install @stdlib/ndarray-base-binary-loop-interchange-order
`javascript`
var binaryLoopOrder = require( '@stdlib/ndarray-base-binary-loop-interchange-order' );
#### binaryLoopOrder( shape, stridesX, stridesY, stridesZ )
Reorders [ndarray][@stdlib/ndarray/ctor] dimensions and associated strides for [loop interchange][loop-interchange].
`javascript
// Define an array shape:
var shape = [ 2, 2 ];
// Define the strides for the input arrays:
var stridesX = [ 2, 1 ]; // row-major
var stridesY = [ 4, 2 ]; // row-major
// Define the strides for the output array:
var stridesZ = [ 1, 2 ]; // column-major
// Resolve the loop interchange order:
var o = binaryLoopOrder( shape, stridesX, stridesY, stridesZ );
// returns {...}
`
The function returns an object having the following properties:
- sh: ordered dimensions.
- sx: first input array strides sorted in loop order.
- sy: second input array strides sorted in loop order.
- sz: output array strides sorted in loop order.
For all returned arrays, the first element corresponds to the innermost loop, and the last element corresponds to the outermost loop.
- When iterating over the elements of a multi-dimensional array, accessing elements which are closer in memory can improve performance. To this end, [loop interchange][loop-interchange] is a technique used in [loop nest optimization][loop-nest-optimization] to improve locality of reference and take advantage of CPU cache.
The purpose of this function is to order [ndarray][@stdlib/ndarray/ctor] dimensions according to the magnitude of array strides. By using the ordered dimensions and associated strides, one can construct nested loops (one for each dimension) such that the innermost loop iterates over the dimension in which array elements are closest in memory and the outermost loop iterates over the dimension in which array elements are farthest apart in memory. As a consequence, element iteration is optimized to minimize cache misses and ensure locality of reference.
- Cache performance may be degraded if the layout order (i.e., row-major or column-major) differs for the input and output [ndarrays][@stdlib/ndarray/ctor]. This function is intended to optimize cache performance for the most common layout order. Accordingly, if the output [ndarray][@stdlib/ndarray/ctor] has a different layout order (e.g., if the input [ndarrays][@stdlib/ndarray/ctor] are row-major and the output [ndarray][@stdlib/ndarray/ctor] is column-major), cache misses are likely for the output [ndarray][@stdlib/ndarray/ctor]. In general, to ensure best performance, input and output [ndarrays][@stdlib/ndarray/ctor] should have the same layout order.
- The function assumes that the input and output [ndarrays][@stdlib/ndarray/ctor] have the same shape. Hence, loop interchange order should only be determined after broadcasting.
`javascript
var array = require( '@stdlib/ndarray-array' );
var getShape = require( '@stdlib/ndarray-shape' );
var getStrides = require( '@stdlib/ndarray-strides' );
var binaryLoopOrder = require( '@stdlib/ndarray-base-binary-loop-interchange-order' );
// Create ndarrays:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
var y = array( [ [ 5, 6 ], [ 7, 8 ] ] );
var z = array( [ [ 0, 0 ], [ 0, 0 ] ] );
// Resolve loop interchange data:
var o = binaryLoopOrder( getShape( x ), getStrides( x ), getStrides( y ), getStrides( z ) );
// returns {...}
console.log( o );
`
*
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-base-binary-loop-interchange-order.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-binary-loop-interchange-order
[test-image]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/actions/workflows/test.yml/badge.svg?branch=v0.2.4
[test-url]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/actions/workflows/test.yml?query=branch:v0.2.4
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-binary-loop-interchange-order/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-binary-loop-interchange-order?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-base-binary-loop-interchange-order/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-base-binary-loop-interchange-order/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-loop-interchange-order/main/LICENSE
[loop-interchange]: https://en.wikipedia.org/wiki/Loop_interchange
[loop-nest-optimization]: https://en.wikipedia.org/wiki/Loop_nest_optimization
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor