Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,10 @@
 
 ### Features
 
+-   [`1e5789c`](https://github.com/stdlib-js/stdlib/commit/1e5789c70b7400b0ff1cd71d06798c1e5b26f16b) - add `blockSize` to namespace
+-   [`a6117b1`](https://github.com/stdlib-js/stdlib/commit/a6117b1bd697083439d740567d41cbfa754f68ab) - add `quinaryBlockSize` to namespace
+-   [`c6dca39`](https://github.com/stdlib-js/stdlib/commit/c6dca39c634f8c016dc6fa4d0330a47bba977eaf) - add `quaternaryBlockSize` to namespace
+-   [`2d51ff6`](https://github.com/stdlib-js/stdlib/commit/2d51ff6a1af79d361401ff928fb755bfaa1170f7) - add `ndarray/base/tiling-block-size`
 -   [`9c75b30`](https://github.com/stdlib-js/stdlib/commit/9c75b302a82df9b6c580b9f8afc647773e5684a3) - add `ndarray/base/quinary-tiling-block-size` [(#9871)](https://github.com/stdlib-js/stdlib/pull/9871)
 -   [`d84de96`](https://github.com/stdlib-js/stdlib/commit/d84de9698683c20fa3b67eb9d2a615a403f6b707) - add `ndarray/base/quaternary-tiling-block-size` [(#9838)](https://github.com/stdlib-js/stdlib/pull/9838)
 -   [`8f8998f`](https://github.com/stdlib-js/stdlib/commit/8f8998f02831c2db69698a26769916d68acfe54f) - update `ndarray/base` TypeScript declarations [(#9913)](https://github.com/stdlib-js/stdlib/pull/9913)
@@ -723,6 +727,18 @@ A total of 43 issues were closed in this release:
 
 <details>
 
+-   [`46c8d0e`](https://github.com/stdlib-js/stdlib/commit/46c8d0eb953a8bd39e4486a93d65aca6c45af934) - **docs:** fix examples _(by Athan Reines)_
+-   [`9d7f220`](https://github.com/stdlib-js/stdlib/commit/9d7f220eca1b55eb1c59b1f31efd91f66a450af2) - **refactor:** use generalized utility _(by Athan Reines)_
+-   [`7f54590`](https://github.com/stdlib-js/stdlib/commit/7f54590d0556e5c8b13d8bc2c527dbfc90e55201) - **refactor:** use generalized utility _(by Athan Reines)_
+-   [`45ee3d6`](https://github.com/stdlib-js/stdlib/commit/45ee3d69be75dcd538d8fde2f2b23ac100995c4b) - **refactor:** use generalized utility _(by Athan Reines)_
+-   [`51e9e67`](https://github.com/stdlib-js/stdlib/commit/51e9e67bf770b750204cb4f97b0420faa06191ce) - **refactor:** use generalized utility _(by Athan Reines)_
+-   [`6ebb5c9`](https://github.com/stdlib-js/stdlib/commit/6ebb5c96300bde3f75f7cbae57fdecf8c5a08f93) - **refactor:** use generalized utility _(by Athan Reines)_
+-   [`24cd22d`](https://github.com/stdlib-js/stdlib/commit/24cd22d47029be52bb7992bcdb839edb7711b68f) - **refactor:** call into generalized utility _(by Athan Reines)_
+-   [`622fb73`](https://github.com/stdlib-js/stdlib/commit/622fb73db38259c72bcbf0d10afa063400914f24) - **test:** fix condition _(by Athan Reines)_
+-   [`1e5789c`](https://github.com/stdlib-js/stdlib/commit/1e5789c70b7400b0ff1cd71d06798c1e5b26f16b) - **feat:** add `blockSize` to namespace _(by Athan Reines)_
+-   [`a6117b1`](https://github.com/stdlib-js/stdlib/commit/a6117b1bd697083439d740567d41cbfa754f68ab) - **feat:** add `quinaryBlockSize` to namespace _(by Athan Reines)_
+-   [`c6dca39`](https://github.com/stdlib-js/stdlib/commit/c6dca39c634f8c016dc6fa4d0330a47bba977eaf) - **feat:** add `quaternaryBlockSize` to namespace _(by Athan Reines)_
+-   [`2d51ff6`](https://github.com/stdlib-js/stdlib/commit/2d51ff6a1af79d361401ff928fb755bfaa1170f7) - **feat:** add `ndarray/base/tiling-block-size` _(by Athan Reines)_
 -   [`9c75b30`](https://github.com/stdlib-js/stdlib/commit/9c75b302a82df9b6c580b9f8afc647773e5684a3) - **feat:** add `ndarray/base/quinary-tiling-block-size` [(#9871)](https://github.com/stdlib-js/stdlib/pull/9871) _(by Muhammad Haris, Athan Reines)_
 -   [`d84de96`](https://github.com/stdlib-js/stdlib/commit/d84de9698683c20fa3b67eb9d2a615a403f6b707) - **feat:** add `ndarray/base/quaternary-tiling-block-size` [(#9838)](https://github.com/stdlib-js/stdlib/pull/9838) _(by Muhammad Haris, Athan Reines)_
 -   [`8f8998f`](https://github.com/stdlib-js/stdlib/commit/8f8998f02831c2db69698a26769916d68acfe54f) - **feat:** update `ndarray/base` TypeScript declarations [(#9913)](https://github.com/stdlib-js/stdlib/pull/9913) _(by stdlib-bot)_

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

@@ -76,7 +76,7 @@ var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
 ```javascript
 var dtypes = require( '@stdlib/ndarray/dtypes' );
 var cartesianSquare = require( '@stdlib/array/base/cartesian-square' );
-var promotionRules = require( '@stdlib/ndarray/promotion-rules' );
+var promoteDataTypes = require( '@stdlib/ndarray/base/promote-dtypes' );
 var binaryBlockSize = require( '@stdlib/ndarray/base/binary-tiling-block-size' );
 
 // Generate a list of input ndarray dtype pairs:
@@ -88,8 +88,8 @@ var b;
 var i;
 console.log( 'block_size, xdtype, ydtype, zdtype' );
 for ( i = 0; i < dt.length; i++ ) {
-    t = promotionRules.apply( null, dt[ i ] );
-    dt[ i ].push( ( t === -1 ) ? 'generic' : t );
+    t = promoteDataTypes( dt[ i ] );
+    dt[ i ].push( ( t === null ) ? 'generic' : t );
     b = binaryBlockSize.apply( null, dt[ i ] );
     console.log( '%d, %s, %s, %s', b, dt[i][0], dt[i][1], dt[i][2] );
 }

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

@@ -20,7 +20,7 @@
 
 var dtypes = require( './../../../dtypes' );
 var cartesianSquare = require( '@stdlib/array/base/cartesian-square' );
-var promotionRules = require( './../../../promotion-rules' );
+var promoteDataTypes = require( './../../../base/promote-dtypes' );
 var binaryBlockSize = require( './../lib' );
 
 // Generate a list of input ndarray dtype pairs:
@@ -32,8 +32,8 @@ var b;
 var i;
 console.log( 'block_size, xdtype, ydtype, zdtype' );
 for ( i = 0; i < dt.length; i++ ) {
-	t = promotionRules.apply( null, dt[ i ] );
-	dt[ i ].push( ( t === -1 ) ? 'generic' : t );
+	t = promoteDataTypes( dt[ i ] );
+	dt[ i ].push( ( t === null ) ? 'generic' : t );
 	b = binaryBlockSize.apply( null, dt[ i ] );
 	console.log( '%d, %s, %s, %s', b, dt[i][0], dt[i][1], dt[i][2] );
 }

base/binary-tiling-block-size/lib/defaults.js

@@ -20,8 +20,7 @@
 
 // MODULES //
 
-var bytesPerElement = require( './../../../base/bytes-per-element' );
-var defaults = require( './defaults.js' );
+var blockSize = require( './../../../base/tiling-block-size' );
 
 
 // MAIN //
@@ -39,23 +38,7 @@ var defaults = require( './defaults.js' );
 * // returns <number>
 */
 function binaryBlockSize( dtypeX, dtypeY, dtypeZ ) {
-	var nbx;
-	var nby;
-	var nbz;
-
-	nbx = bytesPerElement( dtypeX );
-	nby = bytesPerElement( dtypeY );
-	nbz = bytesPerElement( dtypeZ );
-	if ( nbx === null || nby === null || nbz === null ) { // e.g., "generic" arrays
-		return defaults.BLOCK_SIZE_IN_ELEMENTS;
-	}
-	if ( nbx > nby && nbx > nbz ) {
-		return ( defaults.BLOCK_SIZE_IN_BYTES/nbx )|0; // asm type annotation
-	}
-	if ( nby > nbz ) {
-		return ( defaults.BLOCK_SIZE_IN_BYTES/nby )|0; // asm type annotation
-	}
-	return ( defaults.BLOCK_SIZE_IN_BYTES/nbz )|0; // asm type annotation
+	return blockSize( [ dtypeX, dtypeY, dtypeZ ] );
 }
 
 

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

@@ -24,7 +24,7 @@ var tape = require( 'tape' );
 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
 var dtypes = require( './../../../dtypes' );
 var cartesianSquare = require( '@stdlib/array/base/cartesian-square' );
-var promotionRules = require( './../../../promotion-rules' );
+var promoteDataTypes = require( './../../../base/promote-dtypes' );
 var binaryBlockSize = require( './../lib' );
 
 
@@ -48,8 +48,8 @@ tape( 'the function returns a block size', function test( t ) {
 	dt = cartesianSquare( dtypes() );
 
 	for ( i = 0; i < dt.length; i++ ) {
-		pt = promotionRules.apply( null, dt[ i ] );
-		dt[ i ].push( ( pt === -1 ) ? 'generic' : pt );
+		pt = promoteDataTypes( dt[ i ] );
+		dt[ i ].push( ( pt === null ) ? 'generic' : pt );
 		v = binaryBlockSize( dt[ i ][ 0 ], dt[ i ][ 1 ], dt[ i ][ 2 ] );
 		t.strictEqual( isPositiveInteger( v ), true, 'returns a positive integer when provided ('+dt[ i ].join( ', ' )+')' );
 	}

base/binary-tiling-block-size/test/test.js

@@ -1012,6 +1012,15 @@ setReadOnly( ns, 'promoteDataTypes', require( './../../base/promote-dtypes' ) );
 */
 setReadOnly( ns, 'quaternaryLoopOrder', require( './../../base/quaternary-loop-interchange-order' ) );
 
+/**
+* @name quaternaryBlockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/quaternary-tiling-block-size}
+*/
+setReadOnly( ns, 'quaternaryBlockSize', require( './../../base/quaternary-tiling-block-size' ) );
+
 /**
 * @name quinaryLoopOrder
 * @memberof ns
@@ -1021,6 +1030,15 @@ setReadOnly( ns, 'quaternaryLoopOrder', require( './../../base/quaternary-loop-i
 */
 setReadOnly( ns, 'quinaryLoopOrder', require( './../../base/quinary-loop-interchange-order' ) );
 
+/**
+* @name quinaryBlockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/quinary-tiling-block-size}
+*/
+setReadOnly( ns, 'quinaryBlockSize', require( './../../base/quinary-tiling-block-size' ) );
+
 /**
 * @name removeSingletonDimensions
 * @memberof ns
@@ -1264,6 +1282,15 @@ setReadOnly( ns, 'ternaryOutputDataType', require( './../../base/ternary-output-
 */
 setReadOnly( ns, 'ternaryBlockSize', require( './../../base/ternary-tiling-block-size' ) );
 
+/**
+* @name blockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/tiling-block-size}
+*/
+setReadOnly( ns, 'blockSize', require( './../../base/tiling-block-size' ) );
+
 /**
 * @name ndarray2array
 * @memberof ns

base/lib/index.js

@@ -75,19 +75,15 @@ var bsize = nullaryBlockSize( 'float64' );
 
 ```javascript
 var dtypes = require( '@stdlib/ndarray/dtypes' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
 var nullaryBlockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 
 // Get the list of ndarray dtypes:
 var dt = dtypes();
 
-// Resolve the block size for each dtype...
-var b;
-var i;
-console.log( 'block_size, xdtype' );
-for ( i = 0; i < dt.length; i++ ) {
-    b = nullaryBlockSize( dt[ i ] );
-    console.log( '%d, %s', b, dt[ i ] );
-}
+// Resolve the block size for each dtype:
+console.log( 'xdtype, block_size' );
+logEachMap( '%s, %d', dt, nullaryBlockSize );
 ```
 
 </section>

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

@@ -19,16 +19,12 @@
 'use strict';
 
 var dtypes = require( './../../../dtypes' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
 var nullaryBlockSize = require( './../lib' );
 
 // Get the list of ndarray dtypes:
 var dt = dtypes();
 
-// Resolve the block size for each dtype...
-var b;
-var i;
-console.log( 'block_size, xdtype' );
-for ( i = 0; i < dt.length; i++ ) {
-	b = nullaryBlockSize( dt[ i ] );
-	console.log( '%d, %s', b, dt[ i ] );
-}
+// Resolve the block size for each dtype:
+console.log( 'xdtype, block_size' );
+logEachMap( '%s, %d', dt, nullaryBlockSize );