Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-05-08)
+## Unreleased (2025-05-12)
 
 <section class="bug-fixes">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`dcfb648`](https://github.com/stdlib-js/stdlib/commit/dcfb6488ac9624b23ec546f7c54a2da0156c6695) - **refactor:** use generalized utility for resolving loop data _(by Athan Reines)_
 -   [`3ce09af`](https://github.com/stdlib-js/stdlib/commit/3ce09af9819ae7dbaad178179264fc84c5db5690) - **fix:** ensure separate array instance for each memory layout _(by Athan Reines)_
 
 </details>

CONTRIBUTORS

@@ -174,6 +174,7 @@ Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
 UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
+Vara Rahul Rajana <123227543+rajanarahul93@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
 Vivek Maurya <vm8118134@gmail.com>

README.md

@@ -130,19 +130,23 @@ For all returned arrays, the first element corresponds to the innermost loop, an
 
 ## Examples
 
+<!-- eslint-disable max-len -->
+
 <!-- eslint no-undef: "error" -->
 
 ```javascript
 var array = require( '@stdlib/ndarray-array' );
-var loopOrder = require( '@stdlib/ndarray-base-binary-loop-interchange-order' );
+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 = loopOrder( x.shape, x.strides, y.strides, z.strides );
+var o = binaryLoopOrder( getShape( x ), getStrides( x ), getStrides( y ), getStrides( z ) );
 // returns {...}
 
 console.log( o );

benchmark/benchmark.js

@@ -21,28 +21,32 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
 var isArray = require( '@stdlib/assert-is-array' );
 var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
 var pkg = require( './../package.json' ).name;
-var loopOrder = require( './../lib' );
+var binaryLoopOrder = require( './../lib' );
 
 
 // MAIN //
 
 bench( pkg+'::row-major', function benchmark( b ) {
 	var strides;
+	var factors;
 	var shape;
 	var out;
 	var i;
 
 	shape = [ 10, 10, 10 ];
 	strides = shape2strides( shape, 'row-major' );
+	factors = [
+		-1,
+		1
+	];
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		strides[ i%shape.length ] *= ( randu() < 0.5 ) ? -1 : 1;
-		out = loopOrder( shape, strides, strides, strides );
+		strides[ i%shape.length ] *= factors[ i%factors.length ];
+		out = binaryLoopOrder( shape, strides, strides, strides );
 		if ( typeof out !== 'object' ) {
 			b.fail( 'should return an object' );
 		}
@@ -57,17 +61,22 @@ bench( pkg+'::row-major', function benchmark( b ) {
 
 bench( pkg+'::column-major', function benchmark( b ) {
 	var strides;
+	var factors;
 	var shape;
 	var out;
 	var i;
 
 	shape = [ 10, 10, 10 ];
 	strides = shape2strides( shape, 'column-major' );
+	factors = [
+		-1,
+		1
+	];
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		strides[ i%shape.length ] *= ( randu() < 0.5 ) ? -1 : 1;
-		out = loopOrder( shape, strides, strides, strides );
+		strides[ i%shape.length ] *= factors[ i%factors.length ];
+		out = binaryLoopOrder( shape, strides, strides, strides );
 		if ( typeof out !== 'object' ) {
 			b.fail( 'should return an object' );
 		}

dist/index.js

@@ -67,10 +67,10 @@ interface LoopOrderObject {
 *
 * -   The function assumes that the input and output ndarrays have the same shape. Hence, loop interchange order should only be determined **after** broadcasting.
 *
-* @param sh - array dimensions
-* @param sx - first input array stride lengths
-* @param sy - second input array stride lengths
-* @param sz - output array stride lengths
+* @param shape - array dimensions
+* @param stridesX - first input array stride lengths
+* @param stridesY - second input array stride lengths
+* @param stridesZ - output array stride lengths
 * @returns loop interchange data
 *
 * @example
@@ -80,7 +80,7 @@ interface LoopOrderObject {
 * var sy = [ 24, 8, 1 ]; // row-major
 * var sz = [ 1, -2, 6 ]; // column-major
 *
-* var o = loopOrder( sh, sx, sy, sz );
+* var o = binaryLoopOrder( sh, sx, sy, sz );
 * // returns {...}
 *
 * var ssh = o.sh;