Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -689,6 +689,7 @@ A total of 38 issues were closed in this release:
 
 <details>
 
+-   [`5f0a844`](https://github.com/stdlib-js/stdlib/commit/5f0a844380510aaa97c8ca7d1b539868132ae2e7) - **refactor:** rename/reorder parameters _(by Athan Reines)_
 -   [`f40ccb7`](https://github.com/stdlib-js/stdlib/commit/f40ccb75929e92538b8c366145589addccdaafbe) - **feat:** add `ndarray/base/ternary-loop-interchange-order` [(#9499)](https://github.com/stdlib-js/stdlib/pull/9499) _(by Muhammad Haris, Athan Reines)_
 -   [`1f79854`](https://github.com/stdlib-js/stdlib/commit/1f798549409c47de0261c5396dccf64012e54a9c) - **feat:** add `ndarray/base/ternary-tiling-block-size` [(#9495)](https://github.com/stdlib-js/stdlib/pull/9495) _(by Muhammad Haris, Athan Reines)_
 -   [`327cda9`](https://github.com/stdlib-js/stdlib/commit/327cda9b2dda086b20da9ce256df388573486946) - **feat:** update `ndarray` TypeScript declarations [(#9508)](https://github.com/stdlib-js/stdlib/pull/9508) _(by stdlib-bot)_

base/ternary-tiling-block-size/README.md

@@ -40,7 +40,7 @@ limitations under the License.
 var ternaryBlockSize = require( '@stdlib/ndarray/base/ternary-tiling-block-size' );
 ```
 
-#### ternaryBlockSize( dtypeW, dtypeX, dtypeY, dtypeZ )
+#### ternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW )
 
 Resolves a loop block size according to provided ndarray [dtypes][@stdlib/ndarray/dtypes] for multi-dimensional array tiled loops applying a ternary function.
 
@@ -49,6 +49,13 @@ var bsize = ternaryBlockSize( 'float64', 'float64', 'float64', 'float64' );
 // returns <number>
 ```
 
+The function supports the following arguments:
+
+-   **dtypeX**: first input array data type.
+-   **dtypeY**: second input array data type.
+-   **dtypeZ**: third input array data type.
+-   **dtypeW**: output array data type.
+
 </section>
 
 <!-- /.usage -->
@@ -86,7 +93,7 @@ var dt = cartesianPower( dtypes(), 3 );
 var t;
 var b;
 var i;
-console.log( 'block_size, wdtype, xdtype, ydtype, zdtype' );
+console.log( 'block_size, xdtype, ydtype, zdtype, wdtype' );
 for ( i = 0; i < dt.length; i++ ) {
     t = promotionRules.apply( null, dt[ i ] );
     dt[ i ].push( ( t === -1 ) ? 'generic' : t );

base/ternary-tiling-block-size/benchmark/benchmark.js

@@ -29,14 +29,14 @@ var blockSize = require( './../lib' );
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var dw;
 	var dx;
 	var dy;
 	var dz;
+	var dw;
 	var s;
 	var i;
 
-	dw = [
+	dx = [
 		'float64',
 		'float32',
 		'int8',
@@ -50,7 +50,7 @@ bench( pkg, function benchmark( b ) {
 		'generic',
 		'foobar'
 	];
-	dx = [
+	dy = [
 		'float64',
 		'float32',
 		'int8',
@@ -64,7 +64,7 @@ bench( pkg, function benchmark( b ) {
 		'generic',
 		'foobar'
 	];
-	dy = [
+	dz = [
 		'float64',
 		'float32',
 		'int8',
@@ -78,7 +78,7 @@ bench( pkg, function benchmark( b ) {
 		'generic',
 		'foobar'
 	];
-	dz = [
+	dw = [
 		'float64',
 		'generic',
 		'int32',
@@ -88,7 +88,7 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		s = blockSize( dw[ i%dw.length ], dx[ i%dx.length ], dy[ i%dy.length ], dz[ i%dz.length ] ); // eslint-disable-line max-len
+		s = blockSize( dx[ i%dx.length ], dy[ i%dy.length ], dz[ i%dz.length ], dw[ i%dw.length ] ); // eslint-disable-line max-len
 		if ( typeof s !== 'number' ) {
 			b.fail( 'should return a number' );
 		}

base/ternary-tiling-block-size/docs/repl.txt

@@ -1,19 +1,19 @@
 
-{{alias}}( dtypeW, dtypeX, dtypeY, dtypeZ )
+{{alias}}( dtypeX, dtypeY, dtypeZ, dtypeW )
     Returns a loop block size for multi-dimensional array tiled loops.
 
     Parameters
     ----------
-    dtypeW: string|DataType
+    dtypeX: string|DataType
         First input array data type.
 
-    dtypeX: string|DataType
+    dtypeY: string|DataType
         Second input array data type.
 
-    dtypeY: string|DataType
+    dtypeZ: string|DataType
         Third input array data type.
 
-    dtypeZ: string|DataType
+    dtypeW: string|DataType
         Output array data type.
 
     Returns

base/ternary-tiling-block-size/docs/types/index.d.ts

@@ -25,17 +25,17 @@ import { DataType } from '@stdlib/types/ndarray';
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
-* @param dtypeW - first input array data type
-* @param dtypeX - second input array data type
-* @param dtypeY - third input array data type
-* @param dtypeZ - output array data type
+* @param dtypeX - first input array data type
+* @param dtypeY - second input array data type
+* @param dtypeZ - third input array data type
+* @param dtypeW - output array data type
 * @returns block size (in units of elements)
 *
 * @example
 * var bsize = ternaryBlockSize( 'float64', 'float64', 'float64', 'float64' );
 * // returns <number>
 */
-declare function ternaryBlockSize( dtypeW: DataType, dtypeX: DataType, dtypeY: DataType, dtypeZ: DataType ): number;
+declare function ternaryBlockSize( dtypeX: DataType, dtypeY: DataType, dtypeZ: DataType, dtypeW: DataType ): number;
 
 
 // EXPORTS //

base/ternary-tiling-block-size/examples/index.js

@@ -30,7 +30,7 @@ var dt = cartesianPower( dtypes(), 3 );
 var t;
 var b;
 var i;
-console.log( 'block_size, wdtype, xdtype, ydtype, zdtype' );
+console.log( 'block_size, xdtype, ydtype, zdtype, wdtype' );
 for ( i = 0; i < dt.length; i++ ) {
 	t = promotionRules.apply( null, dt[ i ] );
 	dt[ i ].push( ( t === -1 ) ? 'generic' : t );

base/ternary-tiling-block-size/lib/main.js

@@ -29,31 +29,31 @@ var defaults = require( './defaults.js' );
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
-* @param {*} dtypeW - first input array data type
-* @param {*} dtypeX - second input array data type
-* @param {*} dtypeY - third input array data type
-* @param {*} dtypeZ - output array data type
+* @param {*} dtypeX - first input array data type
+* @param {*} dtypeY - second input array data type
+* @param {*} dtypeZ - third input array data type
+* @param {*} dtypeW - output array data type
 * @returns {integer} block size (in units of elements)
 *
 * @example
 * var bsize = ternaryBlockSize( 'float64', 'float64', 'float64', 'float64' );
 * // returns <number>
 */
-function ternaryBlockSize( dtypeW, dtypeX, dtypeY, dtypeZ ) {
+function ternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW ) {
 	var nbx;
 	var nby;
 	var nbz;
 	var nbw;
 	var max;
 
-	nbx = bytesPerElement( dtypeW );
-	nby = bytesPerElement( dtypeX );
-	nbz = bytesPerElement( dtypeY );
-	nbw = bytesPerElement( dtypeZ );
+	nbx = bytesPerElement( dtypeX );
+	nby = bytesPerElement( dtypeY );
+	nbz = bytesPerElement( dtypeZ );
+	nbw = bytesPerElement( dtypeW );
 	if ( nbx === null || nby === null || nbz === null || nbw === null ) { // e.g., "generic" arrays
 		return defaults.BLOCK_SIZE_IN_ELEMENTS;
 	}
-	// Find the largest element size among all four arrays:
+	// Find the largest element size among all four arrays...
 	max = nbx;
 	if ( nby > max ) {
 		max = nby;