@stdlib/ndarray-base-unary-tiling-block-size 0.0.1 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # unaryBlockSize
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -161,8 +172,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-unary-tiling-block-size.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-unary-tiling-block-size
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-unary-tiling-block-size/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/ndarray-base-unary-tiling-block-size/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/ndarray-base-unary-tiling-block-size/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/ndarray-base-unary-tiling-block-size/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-unary-tiling-block-size/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-unary-tiling-block-size?branch=main
@@ -175,7 +186,7 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import unaryBlockSize from '../docs/types/index';
+export = unaryBlockSize;

package/dist/index.js

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

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/defaults.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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) 2022 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 - input array data type\n* @param {string} dtypeY - output array data type\n* @returns {integer} block size (in units of elements)\n*\n* @example\n* var bsize = unaryBlockSize( 'float64', 'float64' );\n* // returns <number>\n*/\nfunction unaryBlockSize( dtypeX, dtypeY ) {\n\tvar nbx;\n\tvar nby;\n\n\tnbx = bytesPerElement( dtypeX );\n\tnby = bytesPerElement( dtypeY );\n\tif ( nbx === null || nby === null ) { // e.g., \"generic\" arrays\n\t\treturn defaults.BLOCK_SIZE_IN_ELEMENTS;\n\t}\n\tif ( nbx > nby ) {\n\t\treturn ( defaults.BLOCK_SIZE_IN_BYTES/nbx )|0; // asm type annotation\n\t}\n\treturn ( defaults.BLOCK_SIZE_IN_BYTES/nby )|0; // asm type annotation\n}\n\n\n// EXPORTS //\n\nmodule.exports = unaryBlockSize;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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-unary-tiling-block-size\n*\n* @example\n* var unaryBlockSize = require( '@stdlib/ndarray-base-unary-tiling-block-size' );\n*\n* var bsize = unaryBlockSize( '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,IAgBf,SAASC,EAAgBC,EAAQC,EAAS,CACzC,IAAIC,EACAC,EAIJ,OAFAD,EAAML,EAAiBG,CAAO,EAC9BG,EAAMN,EAAiBI,CAAO,EACzBC,IAAQ,MAAQC,IAAQ,KACrBL,EAAS,uBAEZI,EAAMC,EACDL,EAAS,oBAAoBI,EAAM,EAEpCJ,EAAS,oBAAoBK,EAAM,CAC7C,CAKAP,EAAO,QAAUG,ICvBjB,IAAIK,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_defaults", "__commonJSMin", "exports", "module", "defaults", "require_main", "__commonJSMin", "exports", "module", "bytesPerElement", "defaults", "unaryBlockSize", "dtypeX", "dtypeY", "nbx", "nby", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-unary-tiling-block-size",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Resolve a loop block size for multi-dimensional array tiled loops.",
   "license": "Apache-2.0",
   "author": {
@@ -37,13 +37,13 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/ndarray-base-bytes-per-element": "^0.0.x"
+    "@stdlib/ndarray-base-bytes-per-element": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-base-cartesian-square": "^0.0.x",
-    "@stdlib/assert-is-positive-integer": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/ndarray-dtypes": "^0.0.x",
+    "@stdlib/array-base-cartesian-square": "^0.0.3",
+    "@stdlib/assert-is-positive-integer": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/ndarray-dtypes": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
@@ -82,7 +82,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,27 +0,0 @@
-
-{{alias}}( dtypeX, dtypeY )
-    Returns a loop block size for multi-dimensional array tiled loops.
-
-    Parameters
-    ----------
-    dtypeX: string
-        Input array data type.
-
-    dtypeY: string
-        Output array data type.
-
-    Returns
-    -------
-    out: integer
-        Block size.
-
-    Examples
-    --------
-    > var out = {{alias}}( 'float64', 'float64' )
-    <number>
-    > out = {{alias}}( 'int32', 'float64' )
-    <number>
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,57 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2022 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.
-*/
-
-import unaryBlockSize = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	unaryBlockSize( 'float64', 'float64' ); // $ExpectType number
-	unaryBlockSize( 'generic', 'generic' ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a string...
-{
-	unaryBlockSize( 123, 'float64' ); // $ExpectError
-	unaryBlockSize( true, 'float64' ); // $ExpectError
-	unaryBlockSize( false, 'float64' ); // $ExpectError
-	unaryBlockSize( null, 'float64' ); // $ExpectError
-	unaryBlockSize( {}, 'float64' ); // $ExpectError
-	unaryBlockSize( [], 'float64' ); // $ExpectError
-	unaryBlockSize( ( x: number ): number => x, 'float64' ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a string...
-{
-	unaryBlockSize( 'int32', 123 ); // $ExpectError
-	unaryBlockSize( 'int32', true ); // $ExpectError
-	unaryBlockSize( 'int32', false ); // $ExpectError
-	unaryBlockSize( 'int32', null ); // $ExpectError
-	unaryBlockSize( 'int32', {} ); // $ExpectError
-	unaryBlockSize( 'int32', [] ); // $ExpectError
-	unaryBlockSize( 'int32', ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	unaryBlockSize(); // $ExpectError
-	unaryBlockSize( 'float64' ); // $ExpectError
-	unaryBlockSize( 'float64', 'float64', 'float64' ); // $ExpectError
-}