refactor: use generalized utility for resolving loop data

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/README.md

@@ -97,19 +97,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 );

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/benchmark/benchmark.js

@@ -21,28 +21,32 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-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' );
 		}

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/docs/types/index.d.ts

@@ -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;

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/examples/index.js

@@ -19,6 +19,8 @@
 'use strict';
 
 var array = require( '@stdlib/ndarray/array' );
+var getShape = require( '@stdlib/ndarray/shape' );
+var getStrides = require( '@stdlib/ndarray/strides' );
 var loopOrder = require( './../lib' );
 
 // Create ndarrays:
@@ -27,7 +29,7 @@ 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 = loopOrder( getShape( x ), getStrides( x ), getStrides( y ), getStrides( z ) ); // eslint-disable-line max-len
 // returns {...}
 
 console.log( o );

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/lib/index.js

@@ -32,7 +32,7 @@
 * 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;

lib/node_modules/@stdlib/ndarray/base/binary-loop-interchange-order/lib/main.js

@@ -20,17 +20,7 @@
 
 // MODULES //
 
-var zeroTo = require( '@stdlib/array/base/zero-to' );
-var copy = require( '@stdlib/array/base/copy-indexed' );
-var take = require( '@stdlib/array/base/take-indexed' );
-var strides2order = require( '@stdlib/ndarray/base/strides2order' );
-var sort2ins = require( './sort2ins.js' );
-
-
-// VARIABLES //
-
-// Number of arrays:
-var N = 3;
+var loopOrder = require( '@stdlib/ndarray/base/loop-interchange-order' );
 
 
 // MAIN //
@@ -60,7 +50,7 @@ var N = 3;
 * 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;
@@ -75,75 +65,17 @@ var N = 3;
 * var ssz = o.sz;
 * // returns [ 6, -2, 1 ]
 */
-function loopOrder( sh, sx, sy, sz ) {
-	var idx;
-	var tmp;
-	var max;
-	var len;
-	var arr;
-	var ox;
-	var oy;
-	var oz;
-	var i;
-	var j;
-
-	// Initialize a loop interchange index array for generating a loop order permutation:
-	idx = zeroTo( sh.length );
-
-	// Determine the order (layout) of each array:
-	ox = strides2order( sx );
-	oy = strides2order( sy );
-	oz = strides2order( sz );
-
-	// Determine which array should be used to generate the loop order:
-	tmp = [ [], [], [], [] ];
-	tmp[ ox ].push( sx );
-	tmp[ oy ].push( sy );
-	tmp[ oz ].push( sz );
-	max = tmp[ 0 ].length;
-	if ( max === N ) {
-		// If all arrays are "disorganized", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:
-		arr = sx;
-	} else if ( max === N-1 ) {
-		// If all but one array is "disorganized", find the "organized" array...
-		for ( i = 1; i < 4; i++ ) {
-			if ( tmp[ i ].length ) {
-				arr = tmp[ i ][ 0 ];
-				break;
-			}
-		}
-	} else {
-		// Find the layout which is most common...
-		j = 0;
-		for ( i = 1; i < 4; i++ ) {
-			len = tmp[ i ].length;
-			if ( len >= max ) {
-				max = len;
-				j = i;
-			}
-		}
-		// Use the strides of the first array having the most common layout:
-		arr = tmp[ j ][ 0 ];
-	}
-	// Sort array strides in increasing order (of magnitude):
-	arr = copy( arr );
-	sort2ins( arr, idx );
-
-	// Permute the shape and array strides based on the sorted strides:
-	sh = take( sh, idx );
-	sx = take( sx, idx );
-	sy = take( sy, idx );
-	sz = take( sz, idx );
-
+function binaryLoopOrder( sh, sx, sy, sz ) {
+	var tmp = loopOrder( sh, [ sx, sy, sz ] );
 	return {
-		'sh': sh,
-		'sx': sx,
-		'sy': sy,
-		'sz': sz
+		'sh': tmp[ 0 ],
+		'sx': tmp[ 1 ],
+		'sy': tmp[ 2 ],
+		'sz': tmp[ 3 ]
 	};
 }
 
 
 // EXPORTS //
 
-module.exports = loopOrder;
+module.exports = binaryLoopOrder;