@stdlib/ndarray-base-binary-tiling-block-size 0.2.2 → 0.2.3

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -99,7 +99,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:
@@ -111,8 +111,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] );
 }
@@ -164,7 +164,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -177,8 +177,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-binary-tiling-block-size.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-binary-tiling-block-size
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-binary-tiling-block-size/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/ndarray-base-binary-tiling-block-size/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/ndarray-base-binary-tiling-block-size/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/ndarray-base-binary-tiling-block-size/actions/workflows/test.yml?query=branch:v0.2.3
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-binary-tiling-block-size/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-binary-tiling-block-size?branch=main
@@ -190,8 +190,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.js

@@ -1,7 +1,5 @@
-"use strict";var i=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var s=i(function(f,S){
-var l={BLOCK_SIZE_IN_BYTES:64,BLOCK_SIZE_IN_ELEMENTS:8};S.exports=l
-});var a=i(function(C,I){
-var n=require('@stdlib/ndarray-base-bytes-per-element/dist'),E=s();function L(u,r,B){var e,t,_;return e=n(u),t=n(r),_=n(B),e===null||t===null||_===null?E.BLOCK_SIZE_IN_ELEMENTS:e>t&&e>_?E.BLOCK_SIZE_IN_BYTES/e|0:t>_?E.BLOCK_SIZE_IN_BYTES/t|0:E.BLOCK_SIZE_IN_BYTES/_|0}I.exports=L
-});var N=a();module.exports=N;
+"use strict";var u=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var t=u(function(b,i){
+var c=require('@stdlib/ndarray-base-tiling-block-size/dist');function n(e,r,s){return c([e,r,s])}i.exports=n
+});var o=t();module.exports=o;
 /** @license Apache-2.0 */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../lib/defaults.js", "../lib/main.js", "../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\nvar defaults = {\n\t// Define a default block size (in bytes):\n\t'BLOCK_SIZE_IN_BYTES': 64|0, // 64b is a common cache line size. How applicable the common cache line size is here is debatable, given that, depending on the associated stride(s), the innermost loop may not iterate over adjacent elements. The primary goal is to have a block size in which all data within a block can always fit in (L1) cache, regardless of cache size (i.e., cache-oblivious). For reference, a common L1 cache size is 32kB per core. For best performance, block sizes should be tuned based on system hardware; however, such tuning is not readily available to us here. Without obvious better alternatives, 64b has some theoretical (and practical) underpinning, and it should be good enough for most inputs, especially for ndarrays with near contiguity.\n\n\t// Define a default block size (in elements):\n\t'BLOCK_SIZE_IN_ELEMENTS': 8|0 // 64 bytes / 8 bytes per element (i.e., default element size is same as a double)\n};\n\n\n// EXPORTS //\n\nmodule.exports = defaults;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );\nvar defaults = require( './defaults.js' );\n\n\n// MAIN //\n\n/**\n* Returns a loop block size for multi-dimensional array tiled loops.\n*\n* @param {string} dtypeX - first input array data type\n* @param {string} dtypeY - second input array data type\n* @param {string} dtypeZ - output array data type\n* @returns {integer} block size (in units of elements)\n*\n* @example\n* var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );\n* // returns <number>\n*/\nfunction binaryBlockSize( dtypeX, dtypeY, dtypeZ ) {\n\tvar nbx;\n\tvar nby;\n\tvar nbz;\n\n\tnbx = bytesPerElement( dtypeX );\n\tnby = bytesPerElement( dtypeY );\n\tnbz = bytesPerElement( dtypeZ );\n\tif ( nbx === null || nby === null || nbz === null ) { // e.g., \"generic\" arrays\n\t\treturn defaults.BLOCK_SIZE_IN_ELEMENTS;\n\t}\n\tif ( nbx > nby && nbx > nbz ) {\n\t\treturn ( defaults.BLOCK_SIZE_IN_BYTES/nbx )|0; // asm type annotation\n\t}\n\tif ( nby > nbz ) {\n\t\treturn ( defaults.BLOCK_SIZE_IN_BYTES/nby )|0; // asm type annotation\n\t}\n\treturn ( defaults.BLOCK_SIZE_IN_BYTES/nbz )|0; // asm type annotation\n}\n\n\n// EXPORTS //\n\nmodule.exports = binaryBlockSize;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Resolve a loop block size for multi-dimensional array tiled loops.\n*\n* @module @stdlib/ndarray-base-binary-tiling-block-size\n*\n* @example\n* var binaryBlockSize = require( '@stdlib/ndarray-base-binary-tiling-block-size' );\n*\n* var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );\n* // returns <number>\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
-  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,CAEd,oBAAuB,GAGvB,uBAA0B,CAC3B,EAKAD,EAAO,QAAUC,ICjCjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAkB,QAAS,wCAAyC,EACpEC,EAAW,IAiBf,SAASC,EAAiBC,EAAQC,EAAQC,EAAS,CAClD,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAMN,EAAiBG,CAAO,EAC9BI,EAAMP,EAAiBI,CAAO,EAC9BI,EAAMR,EAAiBK,CAAO,EACzBC,IAAQ,MAAQC,IAAQ,MAAQC,IAAQ,KACrCP,EAAS,uBAEZK,EAAMC,GAAOD,EAAME,EACdP,EAAS,oBAAoBK,EAAM,EAExCC,EAAMC,EACDP,EAAS,oBAAoBM,EAAM,EAEpCN,EAAS,oBAAoBO,EAAM,CAC7C,CAKAT,EAAO,QAAUG,IC7BjB,IAAIO,EAAO,IAKX,OAAO,QAAUA",
-  "names": ["require_defaults", "__commonJSMin", "exports", "module", "defaults", "require_main", "__commonJSMin", "exports", "module", "bytesPerElement", "defaults", "binaryBlockSize", "dtypeX", "dtypeY", "dtypeZ", "nbx", "nby", "nbz", "main"]
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar blockSize = require( '@stdlib/ndarray-base-tiling-block-size' );\n\n\n// MAIN //\n\n/**\n* Returns a loop block size for multi-dimensional array tiled loops.\n*\n* @param {*} dtypeX - first input array data type\n* @param {*} dtypeY - second input array data type\n* @param {*} dtypeZ - output array data type\n* @returns {integer} block size (in units of elements)\n*\n* @example\n* var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );\n* // returns <number>\n*/\nfunction binaryBlockSize( dtypeX, dtypeY, dtypeZ ) {\n\treturn blockSize( [ dtypeX, dtypeY, dtypeZ ] );\n}\n\n\n// EXPORTS //\n\nmodule.exports = binaryBlockSize;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Resolve a loop block size for multi-dimensional array tiled loops.\n*\n* @module @stdlib/ndarray-base-binary-tiling-block-size\n*\n* @example\n* var binaryBlockSize = require( '@stdlib/ndarray-base-binary-tiling-block-size' );\n*\n* var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );\n* // returns <number>\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAY,QAAS,wCAAyC,EAiBlE,SAASC,EAAiBC,EAAQC,EAAQC,EAAS,CAClD,OAAOJ,EAAW,CAAEE,EAAQC,EAAQC,CAAO,CAAE,CAC9C,CAKAL,EAAO,QAAUE,ICZjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "blockSize", "binaryBlockSize", "dtypeX", "dtypeY", "dtypeZ", "main"]
 }

package/docs/types/index.d.ts

@@ -18,6 +18,10 @@
 
 // TypeScript Version: 4.1
 
+/// <reference types="@stdlib/types"/>
+
+import { DataType } from '@stdlib/types/ndarray';
+
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
@@ -30,7 +34,7 @@
 * var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
 * // returns <number>
 */
-declare function binaryBlockSize( dtypeX: string, dtypeY: string, dtypeZ: string ): number;
+declare function binaryBlockSize( dtypeX: DataType, dtypeY: DataType, dtypeZ: DataType ): number;
 
 
 // EXPORTS //

package/lib/main.js

@@ -20,8 +20,7 @@
 
 // MODULES //
 
-var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
-var defaults = require( './defaults.js' );
+var blockSize = require( '@stdlib/ndarray-base-tiling-block-size' );
 
 
 // MAIN //
@@ -29,9 +28,9 @@ var defaults = require( './defaults.js' );
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
-* @param {string} dtypeX - first input array data type
-* @param {string} dtypeY - second input array data type
-* @param {string} dtypeZ - output array data type
+* @param {*} dtypeX - first input array data type
+* @param {*} dtypeY - second input array data type
+* @param {*} dtypeZ - output array data type
 * @returns {integer} block size (in units of elements)
 *
 * @example
@@ -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 ] );
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-binary-tiling-block-size",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Resolve a loop block size for multi-dimensional array tiled loops.",
   "license": "Apache-2.0",
   "author": {
@@ -30,7 +30,7 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/ndarray-base-bytes-per-element": "^0.2.1"
+    "@stdlib/ndarray-base-tiling-block-size": "^0.1.0"
   },
   "devDependencies": {},
   "engines": {
@@ -65,7 +65,6 @@
     "utils",
     "util"
   ],
-  "__stdlib__": {},
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/stdlib"

package/lib/defaults.js

@@ -1,34 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2023 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MAIN //
-
-var defaults = {
-	// Define a default block size (in bytes):
-	'BLOCK_SIZE_IN_BYTES': 64|0, // 64b is a common cache line size. How applicable the common cache line size is here is debatable, given that, depending on the associated stride(s), the innermost loop may not iterate over adjacent elements. The primary goal is to have a block size in which all data within a block can always fit in (L1) cache, regardless of cache size (i.e., cache-oblivious). For reference, a common L1 cache size is 32kB per core. For best performance, block sizes should be tuned based on system hardware; however, such tuning is not readily available to us here. Without obvious better alternatives, 64b has some theoretical (and practical) underpinning, and it should be good enough for most inputs, especially for ndarrays with near contiguity.
-
-	// Define a default block size (in elements):
-	'BLOCK_SIZE_IN_ELEMENTS': 8|0 // 64 bytes / 8 bytes per element (i.e., default element size is same as a double)
-};
-
-
-// EXPORTS //
-
-module.exports = defaults;