Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -104,6 +104,7 @@
 
 ### Bug Fixes
 
+-   [`96ed2fa`](https://github.com/stdlib-js/stdlib/commit/96ed2faff14d10a798f3d84d267a26e7a78b0759) - return loop permutation indices from `ndarray/base/*loop-interchange-order` packages [(#15812)](https://github.com/stdlib-js/stdlib/pull/15812)
 -   [`c21221c`](https://github.com/stdlib-js/stdlib/commit/c21221c1a4ec8709eaca86aa5acc984e4aafda6d) - add missing option validation [(#14966)](https://github.com/stdlib-js/stdlib/pull/14966)
 -   [`668ccdd`](https://github.com/stdlib-js/stdlib/commit/668ccdd7e8a924d21f431ca83782bb8f6af724f2) - add missing arguments to `format` calls [(#14517)](https://github.com/stdlib-js/stdlib/pull/14517)
 -   [`6ba7e59`](https://github.com/stdlib-js/stdlib/commit/6ba7e5910d85debbb0dd39ea8cfdaf8c458ffe4d) - address off-by-one bug [(#14352)](https://github.com/stdlib-js/stdlib/pull/14352)
@@ -141,6 +142,7 @@ A total of 4 issues were closed in this release:
 
 <details>
 
+-   [`96ed2fa`](https://github.com/stdlib-js/stdlib/commit/96ed2faff14d10a798f3d84d267a26e7a78b0759) - **fix:** return loop permutation indices from `ndarray/base/*loop-interchange-order` packages [(#15812)](https://github.com/stdlib-js/stdlib/pull/15812) _(by Kaustubh Patange)_
 -   [`85f3d87`](https://github.com/stdlib-js/stdlib/commit/85f3d878b126107b24ba09fd08bea53307422087) - **feat:** add float16 dtype support to `ndarray/base/empty-like` [(#15739)](https://github.com/stdlib-js/stdlib/pull/15739) _(by Samarth Kolarkar)_
 -   [`ce01d62`](https://github.com/stdlib-js/stdlib/commit/ce01d62f42a0f04f16f413f93dea56794a601211) - **feat:** add float16 dtype support to `ndarray/base/from-array` [(#15742)](https://github.com/stdlib-js/stdlib/pull/15742) _(by Samarth Kolarkar)_
 -   [`745b7b2`](https://github.com/stdlib-js/stdlib/commit/745b7b23ad7c544eeaa33344aae3e79ba3404062) - **feat:** add float16 dtype support to `ndarray/base/from-scalar` [(#15743)](https://github.com/stdlib-js/stdlib/pull/15743) _(by Samarth Kolarkar)_

base/binary-loop-interchange-order/README.md

@@ -66,6 +66,7 @@ The function returns an object having the following properties:
 -   **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.
+-   **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.
 

base/binary-loop-interchange-order/docs/repl.txt

@@ -8,6 +8,7 @@
     - 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.
+    - 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.
@@ -46,6 +47,9 @@
     out.sz: Array<integer>
         Output 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 ] ] );

base/binary-loop-interchange-order/docs/types/index.d.ts

@@ -45,6 +45,11 @@ interface LoopOrderObject {
 	* Output array strides sorted in loop order.
 	*/
 	sz: Array<number>;
+
+	/**
+	* Dimension indices sorted in loop order.
+	*/
+	idx: Array<number>;
 }
 
 /**
@@ -58,6 +63,7 @@ interface LoopOrderObject {
 *     -   **sx**: first input ndarray strides sorted in loop order.
 *     -   **sy**: second input ndarray strides sorted in loop order.
 *     -   **sz**: output 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.
 *
@@ -94,6 +100,9 @@ interface LoopOrderObject {
 *
 * var ssz = o.sz;
 * // returns [ 6, -2, 1 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 declare function binaryLoopOrder( shape: ArrayLike<number>, stridesX: ArrayLike<number>, stridesY: ArrayLike<number>, stridesZ: ArrayLike<number> ): LoopOrderObject;
 

base/binary-loop-interchange-order/lib/index.js

@@ -46,6 +46,9 @@
 *
 * var ssz = o.sz;
 * // returns [ 6, -2, 1 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 
 // MODULES //

base/binary-loop-interchange-order/lib/main.js

@@ -36,6 +36,7 @@ var loopOrder = require( './../../../base/loop-interchange-order' );
 *     -   **sx**: first input ndarray strides sorted in loop order.
 *     -   **sy**: second input ndarray strides sorted in loop order.
 *     -   **sz**: output ndarray strides sorted in loop order.
+*     -   **idx**: dimension indices sorted in loop order.
 *
 * @param {NonNegativeIntegerArray} sh - array dimensions
 * @param {IntegerArray} sx - first input array stride lengths
@@ -64,14 +65,18 @@ var loopOrder = require( './../../../base/loop-interchange-order' );
 *
 * var ssz = o.sz;
 * // returns [ 6, -2, 1 ]
+*
+* var idx = o.idx;
+* // returns [ 2, 1, 0 ]
 */
 function binaryLoopOrder( sh, sx, sy, sz ) {
 	var tmp = loopOrder( sh, [ sx, sy, sz ] );
 	return {
 		'sh': tmp[ 0 ],
 		'sx': tmp[ 1 ],
 		'sy': tmp[ 2 ],
-		'sz': tmp[ 3 ]
+		'sz': tmp[ 3 ],
+		'idx': tmp[ 4 ]
 	};
 }
 

base/binary-loop-interchange-order/test/test.js

@@ -63,6 +63,9 @@ tape( 'the function returns loop interchange data (row-major)', function test( t
 	t.strictEqual( isArray( o.sz ), true, 'returns expected value' );
 	t.deepEqual( o.sz, [ -2, 4, -8 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 2, 1, 0 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -96,6 +99,9 @@ tape( 'the function returns loop interchange data (column-major)', function test
 	t.strictEqual( isArray( o.sz ), true, 'returns expected value' );
 	t.deepEqual( o.sz, [ -2, 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();
 });
 
@@ -129,6 +135,9 @@ tape( 'the function returns loop interchange data (mixed order)', function test(
 	t.strictEqual( isArray( o.sz ), true, 'returns expected value' );
 	t.deepEqual( o.sz, [ -2, 4, -8 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 2, 1, 0 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -162,6 +171,9 @@ tape( 'the function returns loop interchange data (mostly disorganized)', functi
 	t.strictEqual( isArray( o.sz ), true, 'returns expected value' );
 	t.deepEqual( o.sz, [ 4, -2, -8 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 2, 1, 0 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -195,6 +207,9 @@ tape( 'the function returns loop interchange data (all disorganized)', function
 	t.strictEqual( isArray( o.sz ), true, 'returns expected value' );
 	t.deepEqual( o.sz, [ 4, -8, -2 ], 'returns expected value' );
 
+	t.strictEqual( isArray( o.idx ), true, 'returns expected value' );
+	t.deepEqual( o.idx, [ 2, 0, 1 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -204,5 +219,6 @@ tape( 'if provided empty arrays, the function returns empty arrays', function te
 	t.deepEqual( o.sx, [], 'returns expected value' );
 	t.deepEqual( o.sy, [], 'returns expected value' );
 	t.deepEqual( o.sz, [], 'returns expected value' );
+	t.deepEqual( o.idx, [], 'returns expected value' );
 	t.end();
 });

base/loop-interchange-order/README.md

@@ -63,13 +63,14 @@ var o = loopOrder( shape, [ stridesX, stridesY, stridesZ ] );
 The function returns an array having the following elements:
 
 ```text
-[ <shape>, ...<strides> ]
+[ <shape>, ...<strides>, <idx> ]
 ```
 
 where
 
 -   **shape**: dimensions sorted in loop order.
 -   **...strides**: strides for each respective ndarray 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.
 

base/loop-interchange-order/docs/repl.txt

@@ -4,12 +4,13 @@
 
     The function returns an array having the following elements:
 
-        [ <shape>, ...<strides> ]
+        [ <shape>, ...<strides>, <idx> ]
 
     where
 
     - shape: dimensions sorted in loop order.
     - strides: strides for each respective ndarray 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.

base/loop-interchange-order/docs/types/index.d.ts

@@ -30,13 +30,14 @@ import { ArrayLike } from '@stdlib/types/array';
 * -   The returned array has the following elements:
 *
 *     ```text
-*     [ <shape>, ...<strides> ]
+*     [ <shape>, ...<strides>, <idx> ]
 *     ```
 *
 *     where
 *
 *     -   **shape**: dimensions sorted in loop order.
 *     -   **...strides**: strides for each respective ndarray 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.
 *
@@ -71,6 +72,9 @@ import { ArrayLike } from '@stdlib/types/array';
 *
 * var ssz = o[ 3 ];
 * // returns [ 6, -2, 1 ]
+*
+* var idx = o[ 4 ];
+* // returns [ 2, 1, 0 ]
 */
 declare function loopOrder( shape: ArrayLike<number>, strides: ArrayLike<ArrayLike<number>> ): Array<Array<number>>;