Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

NOTICE

@@ -91,6 +91,7 @@ The function returns an object having the following properties:
 
 -   **sh**: ordered dimensions.
 -   **sx**: array strides sorted in loop order.
+-   **idx**: dimension indices 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.
 

README.md

@@ -6,6 +6,7 @@
 
     - sh: ordered dimensions.
     - sx: array strides sorted in loop order.
+    - idx: dimension indices 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.
@@ -29,6 +30,9 @@
     out.sx: Array<integer>
         Array strides sorted in loop order.
 
+    out.idx: Array<integer>
+        Dimension indices sorted in loop order.
+
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] );

dist/index.js

@@ -35,6 +35,11 @@ interface LoopOrderObject {
 	* Array strides sorted in loop order.
 	*/
 	sx: Array<number>;
+
+	/**
+	* Dimension indices sorted in loop order.
+	*/
+	idx: Array<number>;
 }
 
 /**
@@ -46,6 +51,7 @@ interface LoopOrderObject {
 *
 *     -   **sh**: dimensions sorted in loop order.
 *     -   **sx**: ndarray strides sorted in loop order.
+*     -   **idx**: dimension indices sorted in loop order.
 *
 * -   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 is a technique used in loop nest optimization to improve locality of reference and take advantage of CPU cache.
 *
@@ -68,6 +74,9 @@ interface LoopOrderObject {
 *
 * var ssx = o.sx;
 * // returns [ 1, 4, 12 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 declare function nullaryLoopOrder( shape: ArrayLike<number>, stridesX: ArrayLike<number> ): LoopOrderObject;
 

dist/index.js.map

@@ -38,6 +38,9 @@
 *
 * var ssx = o.sx;
 * // returns [ 1, 4, 12 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 
 // MODULES //

docs/repl.txt

@@ -37,6 +37,7 @@ var sort2ins = require( './sort2ins.js' );
 *
 *     -   **sh**: dimensions sorted in loop order.
 *     -   **sx**: ndarray strides sorted in loop order.
+*     -   **idx**: dimension indices sorted in loop order.
 *
 * @param {NonNegativeIntegerArray} sh - array dimensions
 * @param {IntegerArray} sx - array stride lengths
@@ -55,6 +56,9 @@ var sort2ins = require( './sort2ins.js' );
 *
 * var ssx = o.sx;
 * // returns [ 1, 4, 12 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 function loopOrder( sh, sx ) {
 	var idx;
@@ -71,7 +75,8 @@ function loopOrder( sh, sx ) {
 
 	return {
 		'sh': sh,
-		'sx': sx
+		'sx': sx,
+		'idx': idx
 	};
 }
 

docs/types/index.d.ts

@@ -51,6 +51,9 @@ tape( 'the function returns loop interchange data (row-major)', function test( t
 	t.strictEqual( isArray( o.sx ), true, 'returns expected value' );
 	t.deepEqual( o.sx, [ 1, -2, 4 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 2, 1, 0 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -72,12 +75,16 @@ tape( 'the function returns loop interchange data (column-major)', function test
 	t.strictEqual( isArray( o.sx ), true, 'returns expected value' );
 	t.deepEqual( o.sx, [ 1, -4, 8 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 0, 1, 2 ], 'returns expected value' );
+
 	t.end();
 });
 
 tape( 'if provided empty arrays, the function returns empty arrays', function test( t ) {
 	var o = loopOrder( [], [] );
 	t.deepEqual( o.sh, [], 'returns expected value' );
 	t.deepEqual( o.sx, [], 'returns expected value' );
+	t.deepEqual( o.idx, [], 'returns expected value' );
 	t.end();
 });