Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-05-07)
+## Unreleased (2025-05-12)
 
 <section class="features">
 
@@ -22,6 +22,8 @@
 
 <details>
 
+-   [`603ba97`](https://github.com/stdlib-js/stdlib/commit/603ba974c88f33cb73ba53c69435183ca535ded9) - **docs:** fix parameter names _(by Athan Reines)_
+-   [`d8fe0d8`](https://github.com/stdlib-js/stdlib/commit/d8fe0d87591079990591bd5727abdabaa81cd265) - **bench:** update value generation and update examples _(by Athan Reines)_
 -   [`3dd8cb3`](https://github.com/stdlib-js/stdlib/commit/3dd8cb379ea22c4a92d610d146cdd662d3187e27) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`0d360b3`](https://github.com/stdlib-js/stdlib/commit/0d360b33eba8019d2d638f265986d861ed22642a) - **feat:** return index array as part of the results object _(by Athan Reines)_
 

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

@@ -133,14 +133,16 @@ For all returned arrays, the first element corresponds to the innermost loop, an
 
 ```javascript
 var array = require( '@stdlib/ndarray-array' );
-var loopOrder = require( '@stdlib/ndarray-base-unary-loop-interchange-order' );
+var getShape = require( '@stdlib/ndarray-shape' );
+var getStrides = require( '@stdlib/ndarray-strides' );
+var unaryLoopOrder = require( '@stdlib/ndarray-base-unary-loop-interchange-order' );
 
 // Create ndarrays:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 var y = array( [ [ 0, 0 ], [ 0, 0 ] ] );
 
 // Resolve loop interchange data:
-var o = loopOrder( x.shape, x.strides, y.strides );
+var o = unaryLoopOrder( getShape( x ), getStrides( x ), getStrides( y ) );
 // returns {...}
 
 console.log( o );

benchmark/benchmark.js

@@ -21,7 +21,6 @@
 // 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;
@@ -32,16 +31,21 @@ var loopOrder = require( './../lib' );
 
 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;
+		strides[ i%shape.length ] *= factors[ i%factors.length ];
 		out = loopOrder( shape, strides, strides );
 		if ( typeof out !== 'object' ) {
 			b.fail( 'should return an object' );
@@ -57,16 +61,21 @@ 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;
+		strides[ i%shape.length ] *= factors[ i%factors.length ];
 		out = loopOrder( shape, strides, strides );
 		if ( typeof out !== 'object' ) {
 			b.fail( 'should return an object' );

docs/types/index.d.ts

@@ -67,9 +67,9 @@ 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 - input array stride lengths
-* @param sy - output array stride lengths
+* @param shape - array dimensions
+* @param stridesX - input array stride lengths
+* @param stridesY - output array stride lengths
 * @returns loop interchange data
 *
 * @example

examples/index.js

@@ -19,14 +19,16 @@
 'use strict';
 
 var array = require( '@stdlib/ndarray-array' );
-var loopOrder = require( './../lib' );
+var getShape = require( '@stdlib/ndarray-shape' );
+var getStrides = require( '@stdlib/ndarray-strides' );
+var unaryLoopOrder = require( './../lib' );
 
 // Create ndarrays:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 var y = array( [ [ 0, 0 ], [ 0, 0 ] ] );
 
 // Resolve loop interchange data:
-var o = loopOrder( x.shape, x.strides, y.strides );
+var o = unaryLoopOrder( getShape( x ), getStrides( x ), getStrides( y ) );
 // returns {...}
 
 console.log( o );

package.json

@@ -46,7 +46,8 @@
     "@stdlib/assert-is-array": "^0.2.2",
     "@stdlib/ndarray-array": "^0.2.1",
     "@stdlib/ndarray-base-shape2strides": "^0.2.2",
-    "@stdlib/random-base-randu": "^0.2.1",
+    "@stdlib/ndarray-shape": "^0.2.2",
+    "@stdlib/ndarray-strides": "^0.2.2",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-min": "git+https://github.com/Planeshifter/tap-min.git",

test/test.js

@@ -22,14 +22,14 @@
 
 var tape = require( 'tape' );
 var isArray = require( '@stdlib/assert-is-array' );
-var loopOrder = require( './../lib' );
+var unaryLoopOrder = require( './../lib' );
 
 
 // TESTS //
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof loopOrder, 'function', 'main export is a function' );
+	t.strictEqual( typeof unaryLoopOrder, 'function', 'main export is a function' );
 	t.end();
 });
 
@@ -43,7 +43,7 @@ tape( 'the function returns loop interchange data (row-major)', function test( t
 	sx = [ 4, -2, 1 ];
 	sy = [ -4, 2, 1 ];
 
-	o = loopOrder( sh, sx, sy );
+	o = unaryLoopOrder( sh, sx, sy );
 
 	t.notEqual( o.sh, sh, 'returns new array' );
 	t.strictEqual( isArray( o.sh ), true, 'returns expected value' );
@@ -73,7 +73,7 @@ tape( 'the function returns loop interchange data (column-major)', function test
 	sx = [ 1, -4, 8 ];
 	sy = [ -1, 4, 8 ];
 
-	o = loopOrder( sh, sx, sy );
+	o = unaryLoopOrder( sh, sx, sy );
 
 	t.notEqual( o.sh, sh, 'returns new array' );
 	t.strictEqual( isArray( o.sh ), true, 'returns expected value' );
@@ -103,7 +103,7 @@ tape( 'the function returns loop interchange data (mixed order)', function test(
 	sx = [ 4, -2, 1 ];
 	sy = [ 1, -4, -8 ];
 
-	o = loopOrder( sh, sx, sy );
+	o = unaryLoopOrder( sh, sx, sy );
 
 	t.notEqual( o.sh, sh, 'returns new array' );
 	t.strictEqual( isArray( o.sh ), true, 'returns expected value' );
@@ -124,7 +124,7 @@ tape( 'the function returns loop interchange data (mixed order)', function test(
 });
 
 tape( 'if provided empty arrays, the function returns empty arrays', function test( t ) {
-	var o = loopOrder( [], [], [] );
+	var o = unaryLoopOrder( [], [], [] );
 	t.deepEqual( o.sh, [], 'returns expected value' );
 	t.deepEqual( o.sx, [], 'returns expected value' );
 	t.deepEqual( o.sy, [], 'returns expected value' );