@stdlib/strided-base-nullary-addon-dispatch 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>
+
 # dispatch
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -293,8 +304,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/strided-base-nullary-addon-dispatch.svg
 [npm-url]: https://npmjs.org/package/@stdlib/strided-base-nullary-addon-dispatch
 
-[test-image]: https://github.com/stdlib-js/strided-base-nullary-addon-dispatch/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/strided-base-nullary-addon-dispatch/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/strided-base-nullary-addon-dispatch/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/strided-base-nullary-addon-dispatch/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-base-nullary-addon-dispatch/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/strided-base-nullary-addon-dispatch?branch=main
@@ -307,7 +318,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 dispatch from '../docs/types/index';
+export = dispatch;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var p=function(a,n){return function(){return n||a((n={exports:{}}).exports,n),n.exports}};var w=p(function(z,q){
+var c=require('@stdlib/assert-is-function/dist'),T=require('@stdlib/assert-is-typed-array-like/dist'),s=require('@stdlib/strided-base-dtype-resolve-enum/dist'),C=require('@stdlib/strided-base-reinterpret-complex64/dist'),V=require('@stdlib/strided-base-reinterpret-complex128/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),d=s("complex64"),L=s("complex128");function O(a,n){if(!c(a))throw new TypeError(g('1fR3c',a));if(!c(n))throw new TypeError(g('1fR2H',n));return v;function v(u,r,e,t){var i;if(!T(e))return n(u,r,e,t),e;if(r=s(r),r===null)throw new TypeError(format('1fR1L'));return r===d?i=C(e,0):r===L?i=V(e,0):i=e,a(u,r,i,t),e}}q.exports=O
+});var E=p(function(D,h){
+var f=require('@stdlib/assert-is-function/dist'),P=require('@stdlib/assert-is-typed-array-like/dist'),F=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,l=require('@stdlib/strided-base-dtype-resolve-enum/dist'),M=require('@stdlib/strided-base-reinterpret-complex64/dist'),b=require('@stdlib/strided-base-reinterpret-complex128/dist'),A=require('@stdlib/strided-base-offset-view/dist'),I=require('@stdlib/strided-base-min-view-buffer-index/dist'),m=require('@stdlib/error-tools-fmtprodmsg/dist'),S=l("complex64"),U=l("complex128");function B(a,n){if(!f(a))throw new TypeError(m('1fR3c',a));if(!f(n))throw new TypeError(m('1fR2H',n));return v;function v(u,r,e,t,i){var o;if(!P(e))return n(u,r,e,t,i),e;if(r=l(r),r===null)throw new TypeError(format('1fR1L'));if(!F(i))throw new TypeError(m('1fRAE',i));return i=I(u,t,i),r===S?o=M(e,i):r===U?o=b(e,i):o=A(e,i),a(u,r,o,t),e}}h.exports=B
+});var R=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),y=w(),j=E();R(y,"ndarray",j);module.exports=y;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/ndarray.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// MODULES //\n\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isTypedArrayLike = require( '@stdlib/assert-is-typed-array-like' );\nvar resolve = require( '@stdlib/strided-base-dtype-resolve-enum' );\nvar reinterpretComplex64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar COMPLEX64 = resolve( 'complex64' );\nvar COMPLEX128 = resolve( 'complex128' );\n\n\n// MAIN //\n\n/**\n* Returns a function which dispatches to a native add-on applying a nullary function.\n*\n* ## Notes\n*\n* -   The returned function has the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type.\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*\n* -   The add-on function should have the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type (enumeration constant).\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*\n* -   The fallback function should have the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type.\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*\n* @param {Function} addon - add-on interface\n* @param {Function} fallback - fallback function\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be a function\n* @returns {Function} dispatch function\n*\n* @example\n* function addon( N, dtypeX, x, strideX ) {\n*     // Call into native add-on...\n* }\n*\n* function fallback( N, dtypeX, x, strideX ) {\n*     // Fallback JavaScript implementation...\n* }\n*\n* // Create a dispatch function:\n* var f = dispatch( addon, fallback );\n*\n* // ...\n*\n* // Invoke the dispatch function with strided array arguments:\n* f( 2, 'generic', [ 1, 2 ], 1 );\n*/\nfunction dispatch( addon, fallback ) {\n\tif ( !isFunction( addon ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', addon ) );\n\t}\n\tif ( !isFunction( fallback ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fallback ) );\n\t}\n\treturn dispatcher;\n\n\t/**\n\t* Dispatches to a native add-on.\n\t*\n\t* @private\n\t* @param {integer} N - number of indexed elements\n\t* @param {*} dtypeX - `x` data type\n\t* @param {Collection} x - output array\n\t* @param {integer} strideX - `x` stride length\n\t* @throws {TypeError} unable to resolve a strided array function supporting the provided array argument data types\n\t* @returns {Collection} `x`\n\t*/\n\tfunction dispatcher( N, dtypeX, x, strideX ) {\n\t\tvar viewX;\n\n\t\t// WARNING: we assume that, if we're provided something resembling a typed array, we're provided a typed array; however, this can lead to potential unintended errors as the native add-on may not work with non-typed array objects (e.g., generic arrays)...\n\t\tif ( !isTypedArrayLike( x ) ) {\n\t\t\tfallback( N, dtypeX, x, strideX );\n\t\t\treturn x;\n\t\t}\n\t\tdtypeX = resolve( dtypeX );\n\t\tif ( dtypeX === null ) {\n\t\t\tthrow new TypeError( 'invalid arguments. Unable to resolve a strided array function supporting the provided array argument data types.' );\n\t\t}\n\t\tif ( dtypeX === COMPLEX64 ) {\n\t\t\tviewX = reinterpretComplex64( x, 0 );\n\t\t} else if ( dtypeX === COMPLEX128 ) {\n\t\t\tviewX = reinterpretComplex128( x, 0 );\n\t\t} else {\n\t\t\tviewX = x;\n\t\t}\n\t\taddon( N, dtypeX, viewX, strideX );\n\t\treturn x;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = dispatch;\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 isFunction = require( '@stdlib/assert-is-function' );\nvar isTypedArrayLike = require( '@stdlib/assert-is-typed-array-like' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar resolve = require( '@stdlib/strided-base-dtype-resolve-enum' );\nvar reinterpretComplex64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar offsetView = require( '@stdlib/strided-base-offset-view' );\nvar minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar COMPLEX64 = resolve( 'complex64' );\nvar COMPLEX128 = resolve( 'complex128' );\n\n\n// MAIN //\n\n/**\n* Returns a function which dispatches to a native add-on applying a nullary function using alternative indexing semantics.\n*\n* ## Notes\n*\n* -   The returned function has the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX, offsetX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type.\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*     -   **offsetX**: starting `x` index.\n*\n* -   The add-on function should have the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type (enumeration constant).\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*\n* -   The fallback function should have the following signature:\n*\n*     ```text\n*     f( N, dtypeX, x, strideX, offsetX )\n*     ```\n*\n*     where\n*\n*     -   **N**: number of indexed elements.\n*     -   **dtypeX**: `x` data type.\n*     -   **x**: output array.\n*     -   **strideX**: `x` stride length.\n*     -   **offsetX**: starting `x` index.\n*\n* @param {Function} addon - add-on interface\n* @param {Function} fallback - fallback function\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be a function\n* @returns {Function} dispatch function\n*\n* @example\n* function addon( N, dtypeX, x, strideX ) {\n*     // Call into native add-on...\n* }\n*\n* function fallback( N, dtypeX, x, strideX, offsetX ) {\n*     // Fallback JavaScript implementation...\n* }\n*\n* // Create a dispatch function:\n* var f = dispatch( addon, fallback );\n*\n* // ...\n*\n* // Invoke the dispatch function with strided array arguments:\n* f( 2, 'generic', [ 1, 2 ], 1, 0 );\n*/\nfunction dispatch( addon, fallback ) {\n\tif ( !isFunction( addon ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', addon ) );\n\t}\n\tif ( !isFunction( fallback ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fallback ) );\n\t}\n\treturn dispatcher;\n\n\t/**\n\t* Dispatches to a native add-on.\n\t*\n\t* @private\n\t* @param {integer} N - number of indexed elements\n\t* @param {*} dtypeX - `x` data type\n\t* @param {Collection} x - output array\n\t* @param {integer} strideX - `x` stride length\n\t* @param {NonNegativeInteger} offsetX - starting `x` index\n\t* @throws {TypeError} fifth argument must be a nonnegative integer\n\t* @throws {TypeError} unable to resolve a strided array function supporting the provided array argument data types\n\t* @returns {Collection} `x`\n\t*/\n\tfunction dispatcher( N, dtypeX, x, strideX, offsetX ) {\n\t\tvar viewX;\n\n\t\t// WARNING: we assume that, if we're provided something resembling a typed array, we're provided a typed array; however, this can lead to potential unintended errors as the native add-on may not work with non-typed array objects (e.g., generic arrays)...\n\t\tif ( !isTypedArrayLike( x ) ) {\n\t\t\tfallback( N, dtypeX, x, strideX, offsetX );\n\t\t\treturn x;\n\t\t}\n\t\tdtypeX = resolve( dtypeX );\n\t\tif ( dtypeX === null ) {\n\t\t\tthrow new TypeError( 'invalid arguments. Unable to resolve a strided array function supporting the provided array argument data types.' );\n\t\t}\n\t\tif ( !isNonNegativeInteger( offsetX ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output array offset must be a nonnegative integer. Value: `%s`.', offsetX ) );\n\t\t}\n\t\toffsetX = minViewBufferIndex( N, strideX, offsetX );\n\t\tif ( dtypeX === COMPLEX64 ) {\n\t\t\tviewX = reinterpretComplex64( x, offsetX );\n\t\t} else if ( dtypeX === COMPLEX128 ) {\n\t\t\tviewX = reinterpretComplex128( x, offsetX );\n\t\t} else {\n\t\t\tviewX = offsetView( x, offsetX );\n\t\t}\n\t\taddon( N, dtypeX, viewX, strideX );\n\t\treturn x;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = dispatch;\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* Dispatch to a native add-on applying a nullary function.\n*\n* @module @stdlib/strided-base-nullary-addon-dispatch\n*\n* @example\n* var dispatch = require( '@stdlib/strided-base-nullary-addon-dispatch' );\n*\n* function addon( N, dtypeX, x, strideX ) {\n*     // Call into native add-on...\n* }\n*\n* function fallback( N, dtypeX, x, strideX ) {\n*     // Fallback JavaScript implementation...\n* }\n*\n* // Create a dispatch function:\n* var f = dispatch( addon, fallback );\n*\n* // ...\n*\n* // Invoke the dispatch function with strided array arguments:\n* f( 2, 'generic', [ 1, 2 ], 1 );\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,4BAA6B,EACnDC,EAAmB,QAAS,oCAAqC,EACjEC,EAAU,QAAS,yCAA0C,EAC7DC,EAAuB,QAAS,4CAA6C,EAC7EC,EAAwB,QAAS,6CAA8C,EAC/EC,EAAS,QAAS,uBAAwB,EAK1CC,EAAYJ,EAAS,WAAY,EACjCK,EAAaL,EAAS,YAAa,EAwEvC,SAASM,EAAUC,EAAOC,EAAW,CACpC,GAAK,CAACV,EAAYS,CAAM,EACvB,MAAM,IAAI,UAAWJ,EAAQ,oEAAqEI,CAAM,CAAE,EAE3G,GAAK,CAACT,EAAYU,CAAS,EAC1B,MAAM,IAAI,UAAWL,EAAQ,qEAAsEK,CAAS,CAAE,EAE/G,OAAOC,EAaP,SAASA,EAAYC,EAAGC,EAAQC,EAAGC,EAAU,CAC5C,IAAIC,EAGJ,GAAK,CAACf,EAAkBa,CAAE,EACzB,OAAAJ,EAAUE,EAAGC,EAAQC,EAAGC,CAAQ,EACzBD,EAGR,GADAD,EAASX,EAASW,CAAO,EACpBA,IAAW,KACf,MAAM,IAAI,UAAW,kHAAmH,EAEzI,OAAKA,IAAWP,EACfU,EAAQb,EAAsBW,EAAG,CAAE,EACxBD,IAAWN,EACtBS,EAAQZ,EAAuBU,EAAG,CAAE,EAEpCE,EAAQF,EAETL,EAAOG,EAAGC,EAAQG,EAAOD,CAAQ,EAC1BD,CACR,CACD,CAKAf,EAAO,QAAUS,ICxJjB,IAAAS,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,4BAA6B,EACnDC,EAAmB,QAAS,oCAAqC,EACjEC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAU,QAAS,yCAA0C,EAC7DC,EAAuB,QAAS,4CAA6C,EAC7EC,EAAwB,QAAS,6CAA8C,EAC/EC,EAAa,QAAS,kCAAmC,EACzDC,EAAqB,QAAS,4CAA6C,EAC3EC,EAAS,QAAS,uBAAwB,EAK1CC,EAAYN,EAAS,WAAY,EACjCO,EAAaP,EAAS,YAAa,EA0EvC,SAASQ,EAAUC,EAAOC,EAAW,CACpC,GAAK,CAACb,EAAYY,CAAM,EACvB,MAAM,IAAI,UAAWJ,EAAQ,oEAAqEI,CAAM,CAAE,EAE3G,GAAK,CAACZ,EAAYa,CAAS,EAC1B,MAAM,IAAI,UAAWL,EAAQ,qEAAsEK,CAAS,CAAE,EAE/G,OAAOC,EAeP,SAASA,EAAYC,EAAGC,EAAQC,EAAGC,EAASC,EAAU,CACrD,IAAIC,EAGJ,GAAK,CAACnB,EAAkBgB,CAAE,EACzB,OAAAJ,EAAUE,EAAGC,EAAQC,EAAGC,EAASC,CAAQ,EAClCF,EAGR,GADAD,EAASb,EAASa,CAAO,EACpBA,IAAW,KACf,MAAM,IAAI,UAAW,kHAAmH,EAEzI,GAAK,CAACd,EAAsBiB,CAAQ,EACnC,MAAM,IAAI,UAAWX,EAAQ,oFAAqFW,CAAQ,CAAE,EAE7H,OAAAA,EAAUZ,EAAoBQ,EAAGG,EAASC,CAAQ,EAC7CH,IAAWP,EACfW,EAAQhB,EAAsBa,EAAGE,CAAQ,EAC9BH,IAAWN,EACtBU,EAAQf,EAAuBY,EAAGE,CAAQ,EAE1CC,EAAQd,EAAYW,EAAGE,CAAQ,EAEhCP,EAAOG,EAAGC,EAAQI,EAAOF,CAAQ,EAC1BD,CACR,CACD,CAKAlB,EAAO,QAAUY,ICpHjB,IAAIU,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isFunction", "isTypedArrayLike", "resolve", "reinterpretComplex64", "reinterpretComplex128", "format", "COMPLEX64", "COMPLEX128", "dispatch", "addon", "fallback", "dispatcher", "N", "dtypeX", "x", "strideX", "viewX", "require_ndarray", "__commonJSMin", "exports", "module", "isFunction", "isTypedArrayLike", "isNonNegativeInteger", "resolve", "reinterpretComplex64", "reinterpretComplex128", "offsetView", "minViewBufferIndex", "format", "COMPLEX64", "COMPLEX128", "dispatch", "addon", "fallback", "dispatcher", "N", "dtypeX", "x", "strideX", "offsetX", "viewX", "setReadOnly", "main", "ndarray"]
+}

package/docs/types/index.d.ts

@@ -16,11 +16,11 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/object';
+import { Collection } from '@stdlib/types/array';
 
 /**
 * Add-on function.
@@ -35,7 +35,7 @@ import { Collection } from '@stdlib/types/object';
 *     // Call into native add-on...
 * }
 */
-type AddonFcn = ( N: number, dtypeX: number, x: Collection, strideX: number ) => any; // tslint:disable-line:max-line-length
+type AddonFcn<T, U> = ( N: number, dtypeX: number, x: Collection<T>, strideX: number ) => U;
 
 /**
 * Fallback function.
@@ -50,7 +50,7 @@ type AddonFcn = ( N: number, dtypeX: number, x: Collection, strideX: number ) =>
 *     // Fallback JavaScript implementation...
 * }
 */
-type FallbackFcn = ( N: number, dtypeX: any, x: Collection, strideX: number ) => any; // tslint:disable-line:max-line-length
+type FallbackFcn<T, U> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number ) => U;
 
 /**
 * Fallback function supporting alternative indexing semantics.
@@ -66,7 +66,7 @@ type FallbackFcn = ( N: number, dtypeX: any, x: Collection, strideX: number ) =>
 *     // Fallback JavaScript implementation...
 * }
 */
-type FallbackFcnWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number ) => any; // tslint:disable-line:max-line-length
+type FallbackFcnWithOffsets<T, U> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, offsetX: number ) => U;
 
 /**
 * Dispatches to a native add-on.
@@ -77,7 +77,7 @@ type FallbackFcnWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX:
 * @param strideX - `x` stride length
 * @returns `x`
 */
-type Dispatcher = ( N: number, dtypeX: any, x: Collection, strideX: number ) => Collection; // tslint:disable-line:max-line-length
+type Dispatcher<T> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number ) => Collection<T>;
 
 /**
 * Dispatches to a native add-on.
@@ -89,7 +89,7 @@ type Dispatcher = ( N: number, dtypeX: any, x: Collection, strideX: number ) =>
 * @param offsetX - starting `x` index
 * @returns `x`
 */
-type DispatcherWithOffsets = ( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number ) => Collection; // tslint:disable-line:max-line-length
+type DispatcherWithOffsets<T> = ( N: number, dtypeX: any, x: Collection<T>, strideX: number, offsetX: number ) => Collection<T>;
 
 /**
 * Interface for creating a native add-on dispatcher.
@@ -119,7 +119,7 @@ interface Dispatch {
 	* // Invoke the dispatch function with strided array arguments:
 	* f( 2, 'generic', [ 1, 2 ], 1 );
 	*/
-	( addon: AddonFcn, fallback: FallbackFcn ): Dispatcher;
+	<T = unknown, U = unknown>( addon: AddonFcn<T, U>, fallback: FallbackFcn<T, U> ): Dispatcher<T>;
 
 	/**
 	* Returns a function which dispatches to a native add-on applying a nullary function using alternative indexing semantics.
@@ -145,7 +145,7 @@ interface Dispatch {
 	* // Invoke the dispatch function with strided array arguments:
 	* f( 2, 'generic', [ 1, 2 ], 1, 0 );
 	*/
-	ndarray( addon: AddonFcn, fallback: FallbackFcnWithOffsets ): DispatcherWithOffsets; // tslint:disable-line:max-line-length
+	ndarray<T = unknown, U = unknown>( addon: AddonFcn<T, U>, fallback: FallbackFcnWithOffsets<T, U> ): DispatcherWithOffsets<T>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/strided-base-nullary-addon-dispatch",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Dispatch to a native add-on applying a nullary function.",
   "license": "Apache-2.0",
   "author": {
@@ -37,27 +37,28 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/assert-is-typed-array-like": "^0.0.x",
-    "@stdlib/strided-base-dtype-resolve-enum": "^0.0.x",
-    "@stdlib/strided-base-min-view-buffer-index": "^0.0.x",
-    "@stdlib/strided-base-offset-view": "^0.0.x",
-    "@stdlib/strided-base-reinterpret-complex128": "^0.0.x",
-    "@stdlib/strided-base-reinterpret-complex64": "^0.0.x",
-    "@stdlib/string-format": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/assert-is-typed-array-like": "^0.1.0",
+    "@stdlib/strided-base-dtype-resolve-enum": "^0.1.0",
+    "@stdlib/strided-base-min-view-buffer-index": "^0.1.0",
+    "@stdlib/strided-base-offset-view": "^0.1.0",
+    "@stdlib/strided-base-reinterpret-complex128": "^0.1.0",
+    "@stdlib/strided-base-reinterpret-complex64": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-complex128": "^0.0.x",
-    "@stdlib/array-complex64": "^0.0.x",
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-float32array": "^0.0.x",
-    "@stdlib/assert-is-float64array": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/array-complex128": "^0.0.6",
+    "@stdlib/array-complex64": "^0.0.6",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-float32array": "^0.1.0",
+    "@stdlib/assert-is-float64array": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/utils-noop": "^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"
@@ -89,7 +90,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,135 +0,0 @@
-
-{{alias}}( addon, fallback )
-    Returns a function which dispatches to a native add-on applying a nullary
-    function.
-
-    The returned function has the following signature:
-
-      f( N, dtypeX, x, strideX )
-
-    where
-
-    - N: number of indexed elements.
-    - dtypeX: `x` data type.
-    - x: output array.
-    - strideX: `x` stride length.
-
-    To determine whether to dispatch to the `addon` function, the returned
-    dispatch function checks whether the provided arrays are typed arrays.
-
-    If the provided arrays are typed arrays, the dispatch function invokes the
-    `addon` function; otherwise, the dispatch function invokes the `fallback`
-    function.
-
-    Parameters
-    ----------
-    addon: Function
-        Add-on interface. The function should have the following signature:
-
-          f( N, dtypeX, x, strideX )
-
-        where
-
-        - N: number of indexed elements.
-        - dtypeX: `x` data type (enumeration constant).
-        - x: output array.
-        - strideX: `x` stride length.
-
-    fallback: Function
-        Fallback function. The function should have the following signature:
-
-          f( N, dtypeX, x, strideX )
-
-        where
-
-        - N: number of indexed elements.
-        - dtypeX: `x` data type.
-        - x: output array.
-        - strideX: `x` stride length.
-
-    Returns
-    -------
-    fcn: Function
-        Dispatch function.
-
-    Examples
-    --------
-    > function addon( N, dx, x, sx ) {
-    ...     // Call into native add-on...
-    ... };
-    > function fallback( N, dx, x, sx ) {
-    ...     // Fallback JavaScript implementation...
-    ... };
-    > var f = {{alias}}( addon, fallback );
-    > f( 2, 'generic', [ 1, 2 ], 1 );
-
-
-{{alias}}.ndarray( addon, fallback )
-    Returns a function which dispatches to a native add-on applying a nullary
-    function using alternative indexing semantics.
-
-    The returned function has the following signature:
-
-      f( N, dtypeX, x, strideX, offsetX )
-
-    where
-
-    - N: number of indexed elements.
-    - dtypeX: `x` data type.
-    - x: output array.
-    - strideX: `x` stride length.
-    - offsetX: starting `x` index.
-
-    To determine whether to dispatch to the `addon` function, the returned
-    dispatch function checks whether the provided arrays are typed arrays.
-
-    If the provided arrays are typed arrays, the dispatch function invokes the
-    `addon` function; otherwise, the dispatch function invokes the `fallback`
-    function.
-
-    Parameters
-    ----------
-    addon: Function
-        Add-on interface. The function should have the following signature:
-
-          f( N, dtypeX, x, strideX )
-
-        where
-
-        - N: number of indexed elements.
-        - dtypeX: `x` data type (enumeration constant).
-        - x: output array.
-        - strideX: `x` stride length.
-
-    fallback: Function
-        Fallback function. The function should have the following signature:
-
-          f( N, dtypeX, x, strideX, offsetX )
-
-        where
-
-        - N: number of indexed elements.
-        - dtypeX: `x` data type.
-        - x: output array.
-        - strideX: `x` stride length.
-        - offsetX: starting `x` index.
-
-    Returns
-    -------
-    fcn: Function
-        Dispatch function.
-
-    Examples
-    --------
-    > function addon( N, dx, x, sx ) {
-    ...     // Call into native add-on...
-    ... };
-    > function fallback( N, dx, x, sx, ox ) {
-    ...     // Fallback JavaScript implementation...
-    ... };
-    > var f = {{alias}}.ndarray( addon, fallback );
-    > f( 2, 'generic', [ 1, 2 ], 1, 0 );
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,269 +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.
-*/
-
-/// <reference types="@stdlib/types"/>
-
-import { Collection } from '@stdlib/types/object';
-import dispatch = require( './index' );
-
-
-// FUNCTIONS //
-
-/**
-* Add-on function.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type (enumeration constant)
-* @param x - output array
-* @param strideX - `x` stride length
-*/
-function addon( N: number, dtypeX: number, x: Collection, strideX: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeX ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		x[ i * strideX ] = i;
-	}
-}
-
-/**
-* Fallback function.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type
-* @param x - output array
-* @param strideX - `x` stride length
-*/
-function fallback( N: number, dtypeX: any, x: Collection, strideX: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeX ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		x[ i * strideX ] = i;
-	}
-}
-
-/**
-* Fallback function with alternative indexing semantics.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type
-* @param x - output array
-* @param strideX - `x` stride length
-* @param offsetX - starting `x` index
-*/
-function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeX ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		x[ offsetX + ( i * strideX ) ] = i;
-	}
-}
-
-
-// TESTS //
-
-// The function returns a dispatch function...
-{
-	dispatch( addon, fallback ); // $ExpectType Dispatcher
-}
-
-// The compiler throws an error if not provided a first argument which is an add-on function...
-{
-	dispatch( '10', fallback ); // $ExpectError
-	dispatch( 10, fallback ); // $ExpectError
-	dispatch( true, fallback ); // $ExpectError
-	dispatch( false, fallback ); // $ExpectError
-	dispatch( null, fallback ); // $ExpectError
-	dispatch( undefined, fallback ); // $ExpectError
-	dispatch( [], fallback ); // $ExpectError
-	dispatch( {}, fallback ); // $ExpectError
-	dispatch( ( x: string ): string => x, fallback ); // $ExpectError
-}
-
-// The compiler throws an error if not provided a second argument which is a fallback function...
-{
-	dispatch( addon, '10' ); // $ExpectError
-	dispatch( addon, 10 ); // $ExpectError
-	dispatch( addon, true ); // $ExpectError
-	dispatch( addon, false ); // $ExpectError
-	dispatch( addon, null ); // $ExpectError
-	dispatch( addon, undefined ); // $ExpectError
-	dispatch( addon, [] ); // $ExpectError
-	dispatch( addon, {} ); // $ExpectError
-	dispatch( addon, ( x: string ): string => x ); // $ExpectError
-}
-
-// The returned function returns a collection...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, 1 ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the returned function is not provided a first argument which is a number...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch( addon, fallback );
-
-	f( '10', 'float64', x, 1 ); // $ExpectError
-	f( true, 'float64', x, 1 ); // $ExpectError
-	f( false, 'float64', x, 1 ); // $ExpectError
-	f( null, 'float64', x, 1 ); // $ExpectError
-	f( undefined, 'float64', x, 1 ); // $ExpectError
-	f( [], 'float64', x, 1 ); // $ExpectError
-	f( {}, 'float64', x, 1 ); // $ExpectError
-	f( ( x: number ): number => x, 'float64', x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a third argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', true, 1 ); // $ExpectError
-	f( x.length, 'float64', false, 1 ); // $ExpectError
-	f( x.length, 'float64', null, 1 ); // $ExpectError
-	f( x.length, 'float64', undefined, 1 ); // $ExpectError
-	f( x.length, 'float64', {}, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fourth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, '10' ); // $ExpectError
-	f( x.length, 'float64', x, true ); // $ExpectError
-	f( x.length, 'float64', x, false ); // $ExpectError
-	f( x.length, 'float64', x, null ); // $ExpectError
-	f( x.length, 'float64', x, undefined ); // $ExpectError
-	f( x.length, 'float64', x, [] ); // $ExpectError
-	f( x.length, 'float64', x, {} ); // $ExpectError
-	f( x.length, 'float64', x, ( x: number ): number => x ); // $ExpectError
-}
-
-// Attached to the main export is an `ndarray` method which returns a dispatch function...
-{
-	dispatch.ndarray( addon, fallbackWithOffsets ); // $ExpectType DispatcherWithOffsets
-}
-
-// The compiler throws an error if the `ndarray` method is not provided a first argument which is an add-on function...
-{
-	dispatch.ndarray( '10', fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( 10, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( true, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( false, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( null, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( undefined, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( [], fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( {}, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( ( x: string ): string => x, fallbackWithOffsets ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is not provided a second argument which is a fallback function...
-{
-	dispatch.ndarray( addon, '10' ); // $ExpectError
-	dispatch.ndarray( addon, 10 ); // $ExpectError
-	dispatch.ndarray( addon, true ); // $ExpectError
-	dispatch.ndarray( addon, false ); // $ExpectError
-	dispatch.ndarray( addon, null ); // $ExpectError
-	dispatch.ndarray( addon, undefined ); // $ExpectError
-	dispatch.ndarray( addon, [] ); // $ExpectError
-	dispatch.ndarray( addon, {} ); // $ExpectError
-	dispatch.ndarray( addon, ( x: string ): string => x ); // $ExpectError
-}
-
-// The `ndarray` method returns a function which returns a collection...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0 ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the returned function is not provided a first argument which is a number...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( '10', 'float64', x, 1, 0 ); // $ExpectError
-	f( true, 'float64', x, 1, 0 ); // $ExpectError
-	f( false, 'float64', x, 1, 0 ); // $ExpectError
-	f( null, 'float64', x, 1, 0 ); // $ExpectError
-	f( undefined, 'float64', x, 1, 0 ); // $ExpectError
-	f( [], 'float64', x, 1, 0 ); // $ExpectError
-	f( {}, 'float64', x, 1, 0 ); // $ExpectError
-	f( ( x: number ): number => x, 'float64', x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a third argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', true, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', false, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', null, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', undefined, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', {}, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fourth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, '10', 0 ); // $ExpectError
-	f( x.length, 'float64', x, true, 0 ); // $ExpectError
-	f( x.length, 'float64', x, false, 0 ); // $ExpectError
-	f( x.length, 'float64', x, null, 0 ); // $ExpectError
-	f( x.length, 'float64', x, undefined, 0 ); // $ExpectError
-	f( x.length, 'float64', x, [], 0 ); // $ExpectError
-	f( x.length, 'float64', x, {}, 0 ); // $ExpectError
-	f( x.length, 'float64', x, ( x: number ): number => x, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fifth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, '10' ); // $ExpectError
-	f( x.length, 'float64', x, 1, true ); // $ExpectError
-	f( x.length, 'float64', x, 1, false ); // $ExpectError
-	f( x.length, 'float64', x, 1, null ); // $ExpectError
-	f( x.length, 'float64', x, 1, undefined ); // $ExpectError
-	f( x.length, 'float64', x, 1, [] ); // $ExpectError
-	f( x.length, 'float64', x, 1, {} ); // $ExpectError
-	f( x.length, 'float64', x, 1, ( x: number ): number => x ); // $ExpectError
-}