@stdlib/ndarray-base-output-dtype 0.1.0

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

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

package/README.md

@@ -0,0 +1,254 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+
+<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>
+
+# outputDataType
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Resolve the output ndarray [data type][@stdlib/ndarray/dtypes] from a list of input ndarray [data types][@stdlib/ndarray/dtypes].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/ndarray-base-output-dtype
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var outputDataType = require( '@stdlib/ndarray-base-output-dtype' );
+```
+
+#### outputDataType( dtypes, policy )
+
+Resolves the output ndarray [data type][@stdlib/ndarray/dtypes] from a list of input ndarray [data types][@stdlib/ndarray/dtypes] according to a [data type policy][@stdlib/ndarray/output-dtype-policies].
+
+```javascript
+var dt = outputDataType( [ 'int32', 'uint32' ], 'floating_point' );
+// returns 'float64'
+```
+
+The function supports the following parameters:
+
+-   **dtypes**: list of input ndarray [data types][@stdlib/ndarray/dtypes].
+-   **policy**: output [data type policy][@stdlib/ndarray/output-dtype-policies].
+
+If `policy` is a [data type][@stdlib/ndarray/dtypes], the function always returns the `policy` value (i.e., the second argument).
+
+```javascript
+var dt = outputDataType( [ 'float32', 'float32' ], 'float64' );
+// returns 'float64'
+
+dt = outputDataType( [ 'int32', 'complex128' ], 'float64' );
+// returns 'float64'
+
+// ...
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   When provided more than [data type][@stdlib/ndarray/dtypes], the function **always** applies [type promotion][@stdlib/ndarray/promotion-rules] to the provided data types, except for the following [data type policies][@stdlib/ndarray/output-dtype-policies]:
+
+    -   `default`
+    -   `default_index`
+    -   `same`
+    -   `<dtype>`
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var naryFunction = require( '@stdlib/utils-nary-function' );
+var unzip = require( '@stdlib/utils-unzip' );
+var cartesianProduct = require( '@stdlib/array-base-cartesian-product' );
+var dtypes = require( '@stdlib/ndarray-dtypes' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
+var outputDataType = require( '@stdlib/ndarray-base-output-dtype' );
+
+// Get the list of real-valued data types:
+var dt = dtypes( 'real' );
+
+// Define a list of output data type policies:
+var policies = [
+    'default',
+    'real',
+    'floating_point',
+    'complex_floating_point',
+    'promoted'
+];
+
+// Generate data type pairs:
+var pairs = cartesianProduct( dt, dt );
+
+// Generate argument pairs:
+var args = cartesianProduct( pairs, policies );
+
+// Unzip the argument pair array:
+args = unzip( args );
+
+// Resolve output data types:
+logEachMap( 'dtypes: (%15s). policy: %-24s. output dtype: %s.', args[ 0 ], args[ 1 ], naryFunction( outputDataType, 2 ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<section class="main-repo" >
+
+* * *
+
+## Notice
+
+This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
+
+For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
+
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
+---
+
+## License
+
+See [LICENSE][stdlib-license].
+
+
+## Copyright
+
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
+
+</section>
+
+<!-- /.stdlib -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-output-dtype.svg
+[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-output-dtype
+
+[test-image]: https://github.com/stdlib-js/ndarray-base-output-dtype/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/actions/workflows/test.yml?query=branch:v0.1.0
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-output-dtype/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-output-dtype?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-output-dtype.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-output-dtype/main
+
+-->
+
+[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
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/deno
+[deno-readme]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/deno/README.md
+[umd-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/umd
+[umd-readme]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/esm
+[esm-readme]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/esm/README.md
+[branches-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/main/branches.md
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-output-dtype/main/LICENSE
+
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
+
+[@stdlib/ndarray/output-dtype-policies]: https://www.npmjs.com/package/@stdlib/ndarray-output-dtype-policies
+
+[@stdlib/ndarray/promotion-rules]: https://www.npmjs.com/package/@stdlib/ndarray-promotion-rules
+
+</section>
+
+<!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var A=b(function(z,F){
+var o=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),c=require('@stdlib/ndarray-base-assert-is-real-floating-point-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-complex-floating-point-data-type/dist'),y=require('@stdlib/ndarray-base-assert-is-integer-data-type/dist'),g=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),u=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),v=require('@stdlib/ndarray-base-assert-is-real-data-type/dist'),T=require('@stdlib/ndarray-base-assert-is-numeric-data-type/dist'),m=require('@stdlib/ndarray-base-assert-is-boolean-data-type/dist'),D=require('@stdlib/ndarray-base-assert-is-integer-index-data-type/dist'),x=require('@stdlib/ndarray-base-assert-is-boolean-index-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-mask-index-data-type/dist'),N=require('@stdlib/ndarray-base-assert-is-data-type/dist'),O=require('@stdlib/assert-is-string/dist').isPrimitive,l=require('@stdlib/ndarray-base-promote-dtypes/dist'),t=require('@stdlib/ndarray-defaults/dist'),I=require('@stdlib/array-base-join/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist'),h=t.get("dtypes.default"),w=t.get("dtypes.default_index"),d=t.get("dtypes.signed_integer"),_=t.get("dtypes.unsigned_integer"),L=t.get("dtypes.real_floating_point"),U=t.get("dtypes.complex_floating_point"),Y={default:k,default_index:S,same:B,promoted:s,accumulation:M},C={floating_point:[o,t.get("dtypes.floating_point")],floating_point_and_generic:[a(o),t.get("dtypes.floating_point")],real_floating_point:[c,P],real_floating_point_and_generic:[a(c),P],complex_floating_point:[f,q],complex_floating_point_and_generic:[a(f),q],integer:[y,t.get("dtypes.integer")],integer_and_generic:[a(y),t.get("dtypes.integer")],signed_integer:[g,d],signed_integer_and_generic:[a(g),d],unsigned_integer:[u,_],unsigned_integer_and_generic:[a(u),_],real:[v,t.get("dtypes.real")],real_and_generic:[a(v),t.get("dtypes.real")],numeric:[T,t.get("dtypes.numeric")],numeric_and_generic:[a(T),t.get("dtypes.numeric")],boolean:[m,t.get("dtypes.boolean")],boolean_and_generic:[a(m),t.get("dtypes.boolean")],integer_index:[D,t.get("dtypes.integer_index")],integer_index_and_generic:[a(D),t.get("dtypes.integer_index")],boolean_index:[x,t.get("dtypes.boolean_index")],boolean_index_and_generic:[a(x),t.get("dtypes.boolean_index")],mask_index:[E,t.get("dtypes.mask_index")],mask_index_and_generic:[a(E),t.get("dtypes.mask_index")]},G={complex128:"float64",complex64:"float32",complex32:"float16"},R={float64:"complex128",float32:"complex64",float16:"complex32"};function a(r){return e;function e(n){return n==="generic"||r(n)}}function k(){return h}function S(){return w}function B(r){var e,n;for(e=r[0],n=1;n<r.length;n++)if(r[n]!==e)throw new Error(p('2GnIH',I(r,", ")));return e}function s(r){var e=l(r);if(e===null)throw new Error(p('2GnII',I(r,", ")));return e}function M(r){var e=s(r);return o(e)||e==="generic"?e:u(e)?l([e,_]):g(e)?l([e,d]):L}function P(r){return G[r]||L}function q(r){return R[r]||U}function X(r,e){var n,i;if(N(e))return e;if(i=Y[e],i!==void 0)return i(r);if(n=s(r),i=C[e],i!==void 0)return i[0](n)?n:O(i[1])?i[1]:i[1](n);throw new TypeError(p('2GnDw',e))}F.exports=X
+});var j=A();module.exports=j;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isRealFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-real-floating-point-data-type' );\nvar isComplexFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-complex-floating-point-data-type' );\nvar isIntegerDataType = require( '@stdlib/ndarray-base-assert-is-integer-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isRealDataType = require( '@stdlib/ndarray-base-assert-is-real-data-type' );\nvar isNumericDataType = require( '@stdlib/ndarray-base-assert-is-numeric-data-type' );\nvar isBooleanDataType = require( '@stdlib/ndarray-base-assert-is-boolean-data-type' );\nvar isIntegerIndexDataType = require( '@stdlib/ndarray-base-assert-is-integer-index-data-type' );\nvar isBooleanIndexDataType = require( '@stdlib/ndarray-base-assert-is-boolean-index-data-type' );\nvar isMaskIndexDataType = require( '@stdlib/ndarray-base-assert-is-mask-index-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_DTYPE = defaults.get( 'dtypes.default' );\nvar DEFAULT_INDEX_DTYPE = defaults.get( 'dtypes.default_index' );\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\nvar DEFAULT_COMPLEX_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.complex_floating_point' );\n\n// Table where, for each respective policy, the value is a function which applies the policy to an input data type...\nvar POLICY_TABLE1 = {\n\t'default': defaultPolicy,\n\t'default_index': defaultIndexPolicy,\n\t'same': samePolicy,\n\t'promoted': promotedPolicy,\n\t'accumulation': accumulationPolicy\n};\n\n// Table where, for each respective policy, the value is an array whose first element is an assertion and whose second element is a fallback data type...\nvar POLICY_TABLE2 = {\n\t// Floating-point policies...\n\t'floating_point': [\n\t\tisFloatingPointDataType,\n\t\tdefaults.get( 'dtypes.floating_point' )\n\t],\n\t'floating_point_and_generic': [\n\t\twrap( isFloatingPointDataType ),\n\t\tdefaults.get( 'dtypes.floating_point' )\n\t],\n\t'real_floating_point': [\n\t\tisRealFloatingPointDataType,\n\t\tresolveDefaultRealFloatingPoint\n\t],\n\t'real_floating_point_and_generic': [\n\t\twrap( isRealFloatingPointDataType ),\n\t\tresolveDefaultRealFloatingPoint\n\t],\n\t'complex_floating_point': [\n\t\tisComplexFloatingPointDataType,\n\t\tresolveDefaultComplexFloatingPoint\n\t],\n\t'complex_floating_point_and_generic': [\n\t\twrap( isComplexFloatingPointDataType ),\n\t\tresolveDefaultComplexFloatingPoint\n\t],\n\n\t// Integer policies...\n\t'integer': [\n\t\tisIntegerDataType,\n\t\tdefaults.get( 'dtypes.integer' )\n\t],\n\t'integer_and_generic': [\n\t\twrap( isIntegerDataType ),\n\t\tdefaults.get( 'dtypes.integer' )\n\t],\n\t'signed_integer': [\n\t\tisSignedIntegerDataType,\n\t\tDEFAULT_SIGNED_INTEGER_DTYPE\n\t],\n\t'signed_integer_and_generic': [\n\t\twrap( isSignedIntegerDataType ),\n\t\tDEFAULT_SIGNED_INTEGER_DTYPE\n\t],\n\t'unsigned_integer': [\n\t\tisUnsignedIntegerDataType,\n\t\tDEFAULT_UNSIGNED_INTEGER_DTYPE\n\t],\n\t'unsigned_integer_and_generic': [\n\t\twrap( isUnsignedIntegerDataType ),\n\t\tDEFAULT_UNSIGNED_INTEGER_DTYPE\n\t],\n\n\t// Real-valued number policies...\n\t'real': [\n\t\tisRealDataType,\n\t\tdefaults.get( 'dtypes.real' )\n\t],\n\t'real_and_generic': [\n\t\twrap( isRealDataType ),\n\t\tdefaults.get( 'dtypes.real' )\n\t],\n\n\t// Real- and complex-valued number policies...\n\t'numeric': [\n\t\tisNumericDataType,\n\t\tdefaults.get( 'dtypes.numeric' )\n\t],\n\t'numeric_and_generic': [\n\t\twrap( isNumericDataType ),\n\t\tdefaults.get( 'dtypes.numeric' )\n\t],\n\n\t// Boolean policies...\n\t'boolean': [\n\t\tisBooleanDataType,\n\t\tdefaults.get( 'dtypes.boolean' )\n\t],\n\t'boolean_and_generic': [\n\t\twrap( isBooleanDataType ),\n\t\tdefaults.get( 'dtypes.boolean' )\n\t],\n\n\t// Index policies...\n\t'integer_index': [\n\t\tisIntegerIndexDataType,\n\t\tdefaults.get( 'dtypes.integer_index' )\n\t],\n\t'integer_index_and_generic': [\n\t\twrap( isIntegerIndexDataType ),\n\t\tdefaults.get( 'dtypes.integer_index' )\n\t],\n\t'boolean_index': [\n\t\tisBooleanIndexDataType,\n\t\tdefaults.get( 'dtypes.boolean_index' )\n\t],\n\t'boolean_index_and_generic': [\n\t\twrap( isBooleanIndexDataType ),\n\t\tdefaults.get( 'dtypes.boolean_index' )\n\t],\n\t'mask_index': [\n\t\tisMaskIndexDataType,\n\t\tdefaults.get( 'dtypes.mask_index' )\n\t],\n\t'mask_index_and_generic': [\n\t\twrap( isMaskIndexDataType ),\n\t\tdefaults.get( 'dtypes.mask_index' )\n\t]\n};\n\n// Table mapping complex-valued floating-point data types to real-valued floating-point data types having the same precision:\nvar COMPLEX2FLOAT = {\n\t'complex128': 'float64',\n\t'complex64': 'float32',\n\t'complex32': 'float16'\n};\n\n// Table mapping real-valued floating-point data types to complex-valued floating-point data types having the same precision:\nvar FLOAT2COMPLEX = {\n\t'float64': 'complex128',\n\t'float32': 'complex64',\n\t'float16': 'complex32'\n};\n\n\n// FUNCTIONS //\n\n/**\n* Wraps a data type validation function to also check for a \"generic\" data type.\n*\n* @private\n* @param {Function} fcn - validation function\n* @returns {Function} wrapped validation function\n*/\nfunction wrap( fcn ) {\n\treturn wrapper;\n\n\t/**\n\t* Tests whether a provided data type is either \"generic\" or satisfies a data type validation function.\n\t*\n\t* @private\n\t* @param {*} value - input value\n\t* @returns {boolean} boolean indicating whether a provided value passes a test\n\t*/\n\tfunction wrapper( value ) {\n\t\treturn ( value === 'generic' ) || fcn( value );\n\t}\n}\n\n/**\n* Returns the default data type.\n*\n* @private\n* @returns {string} output ndarray data type\n*/\nfunction defaultPolicy() {\n\t// When the policy is \"default\", the output data type should always be the default data type without consideration for the input data types:\n\treturn DEFAULT_DTYPE;\n}\n\n/**\n* Returns the default index data type.\n*\n* @private\n* @returns {string} output ndarray data type\n*/\nfunction defaultIndexPolicy() {\n\t// When the policy is \"default_index\", the output data type should always be the default index data type without consideration for the input data types:\n\treturn DEFAULT_INDEX_DTYPE;\n}\n\n/**\n* Applies the \"same\" policy by returning the common input data type.\n*\n* @private\n* @param {StringArray} dtypes - input ndarray data types\n* @throws {Error} invalid data types\n* @returns {string} output ndarray data type\n*/\nfunction samePolicy( dtypes ) {\n\tvar dt;\n\tvar i;\n\n\tdt = dtypes[ 0 ];\n\tfor ( i = 1; i < dtypes.length; i++ ) {\n\t\t// When the policy is \"same\", we require that all data types (both input and output) be the same...\n\t\tif ( dtypes[ i ] !== dt ) {\n\t\t\tthrow new Error( format( 'invalid argument. Unable to resolve an output data type. The output data type policy is \"same\" and yet the input data types are not equal. Data types: [%s].', join( dtypes, ', ' ) ) );\n\t\t}\n\t}\n\treturn dt;\n}\n\n/**\n* Applies the \"promoted\" policy by applying type promotion to the list of provided data types.\n*\n* @private\n* @param {StringArray} dtypes - input ndarray data types\n* @throws {Error} must provide data types which can be safely cast to a common data type\n* @returns {string} output ndarray data type\n*/\nfunction promotedPolicy( dtypes ) {\n\tvar dt = promoteDataTypes( dtypes );\n\tif ( dt === null ) {\n\t\tthrow new Error( format( 'invalid argument. Unable to apply type promotion rules when resolving a data type to which the input data types can be safely cast. Data types: [%s].', join( dtypes, ', ' ) ) );\n\t}\n\treturn dt;\n}\n\n/**\n* Applies the \"accumulation\" policy to the list of input data types.\n*\n* @private\n* @param {StringArray} dtypes - input ndarray data types\n* @throws {Error} must provide data types which can be safely cast to a common data type\n* @returns {string} output ndarray data type\n*/\nfunction accumulationPolicy( dtypes ) {\n\tvar dt = promotedPolicy( dtypes );\n\n\t// If the promoted data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\tif ( isFloatingPointDataType( dt ) || dt === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\treturn dt;\n\t}\n\t// Unless the promoted data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in small range integer data types (e.g., `int8`) is at high risk for overflow, especially for ndarrays containing many elements...\n\tif ( isUnsignedIntegerDataType( dt ) ) {\n\t\treturn promoteDataTypes( [ dt, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t}\n\tif ( isSignedIntegerDataType( dt ) ) {\n\t\treturn promoteDataTypes( [ dt, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t}\n\t// For all other data types, accumulate in the default real-valued floating-point data type...\n\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n}\n\n/**\n* Resolves a default real-valued floating-point data type which preserves floating-point precision.\n*\n* @private\n* @param {string} dtype - input ndarray data type\n* @returns {string} output ndarray data type\n*/\nfunction resolveDefaultRealFloatingPoint( dtype ) {\n\treturn COMPLEX2FLOAT[ dtype ] || DEFAULT_REAL_FLOATING_POINT_DTYPE;\n}\n\n/**\n* Resolves a default complex-valued floating-point data type which preserves floating-point precision.\n*\n* @private\n* @param {string} dtype - input ndarray data type\n* @returns {string} output ndarray data type\n*/\nfunction resolveDefaultComplexFloatingPoint( dtype ) {\n\treturn FLOAT2COMPLEX[ dtype ] || DEFAULT_COMPLEX_FLOATING_POINT_DTYPE;\n}\n\n\n// MAIN //\n\n/**\n* Resolves the output data type from a list of input ndarray data types.\n*\n* @param {StringArray} dtypes - list of input ndarray data types\n* @param {string} policy - output ndarray data type policy\n* @throws {TypeError} second argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} output ndarray data type\n*\n* @example\n* var dt = resolve( [ 'float64' ], 'complex_floating_point' );\n* // returns <string>\n*/\nfunction resolve( dtypes, policy ) {\n\tvar dt;\n\tvar p;\n\n\t// First, check whether the policy mandates that the output data type always be a specific data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\t// Next, check whether the policy is one in which we may be able to avoid type promotion...\n\tp = POLICY_TABLE1[ policy ];\n\tif ( p !== void 0 ) {\n\t\treturn p( dtypes );\n\t}\n\t// For all other policies, we always apply type promotion rules...\n\tdt = promotedPolicy( dtypes );\n\n\t// Check whether the policy requires determining the data type \"kind\"...\n\tp = POLICY_TABLE2[ policy ];\n\tif ( p !== void 0 ) {\n\t\t// Check whether the promoted data type belongs to the data type \"kind\"...\n\t\tif ( p[ 0 ]( dt ) ) {\n\t\t\t// If so, we can just return the promoted data type:\n\t\t\treturn dt;\n\t\t}\n\t\t// Otherwise, we need to fallback to a default data type belonging to that \"kind\"...\n\t\tif ( isString( p[ 1 ] ) ) {\n\t\t\treturn p[ 1 ];\n\t\t}\n\t\treturn p[ 1 ]( dt );\n\t}\n\tthrow new TypeError( format( 'invalid argument. Second argument must be a supported data type policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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 the output data type from a list of input ndarray data types.\n*\n* @module @stdlib/ndarray-base-output-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-output-dtype' );\n*\n* var dt = resolve( [ 'float64' ], 'complex_floating_point' );\n* // returns <string>\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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA8B,QAAS,8DAA+D,EACtGC,EAAiC,QAAS,iEAAkE,EAC5GC,EAAoB,QAAS,kDAAmD,EAChFC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAiB,QAAS,+CAAgD,EAC1EC,EAAoB,QAAS,kDAAmD,EAChFC,EAAoB,QAAS,kDAAmD,EAChFC,EAAyB,QAAS,wDAAyD,EAC3FC,EAAyB,QAAS,wDAAyD,EAC3FC,EAAsB,QAAS,qDAAsD,EACrFC,EAAa,QAAS,0CAA2C,EACjEC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAAgBH,EAAS,IAAK,gBAAiB,EAC/CI,EAAsBJ,EAAS,IAAK,sBAAuB,EAC3DK,EAA+BL,EAAS,IAAK,uBAAwB,EACrEM,EAAiCN,EAAS,IAAK,yBAA0B,EACzEO,EAAoCP,EAAS,IAAK,4BAA6B,EAC/EQ,EAAuCR,EAAS,IAAK,+BAAgC,EAGrFS,EAAgB,CACnB,QAAWC,EACX,cAAiBC,EACjB,KAAQC,EACR,SAAYC,EACZ,aAAgBC,CACjB,EAGIC,EAAgB,CAEnB,eAAkB,CACjB9B,EACAe,EAAS,IAAK,uBAAwB,CACvC,EACA,2BAA8B,CAC7BgB,EAAM/B,CAAwB,EAC9Be,EAAS,IAAK,uBAAwB,CACvC,EACA,oBAAuB,CACtBd,EACA+B,CACD,EACA,gCAAmC,CAClCD,EAAM9B,CAA4B,EAClC+B,CACD,EACA,uBAA0B,CACzB9B,EACA+B,CACD,EACA,mCAAsC,CACrCF,EAAM7B,CAA+B,EACrC+B,CACD,EAGA,QAAW,CACV9B,EACAY,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBgB,EAAM5B,CAAkB,EACxBY,EAAS,IAAK,gBAAiB,CAChC,EACA,eAAkB,CACjBX,EACAgB,CACD,EACA,2BAA8B,CAC7BW,EAAM3B,CAAwB,EAC9BgB,CACD,EACA,iBAAoB,CACnBf,EACAgB,CACD,EACA,6BAAgC,CAC/BU,EAAM1B,CAA0B,EAChCgB,CACD,EAGA,KAAQ,CACPf,EACAS,EAAS,IAAK,aAAc,CAC7B,EACA,iBAAoB,CACnBgB,EAAMzB,CAAe,EACrBS,EAAS,IAAK,aAAc,CAC7B,EAGA,QAAW,CACVR,EACAQ,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBgB,EAAMxB,CAAkB,EACxBQ,EAAS,IAAK,gBAAiB,CAChC,EAGA,QAAW,CACVP,EACAO,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBgB,EAAMvB,CAAkB,EACxBO,EAAS,IAAK,gBAAiB,CAChC,EAGA,cAAiB,CAChBN,EACAM,EAAS,IAAK,sBAAuB,CACtC,EACA,0BAA6B,CAC5BgB,EAAMtB,CAAuB,EAC7BM,EAAS,IAAK,sBAAuB,CACtC,EACA,cAAiB,CAChBL,EACAK,EAAS,IAAK,sBAAuB,CACtC,EACA,0BAA6B,CAC5BgB,EAAMrB,CAAuB,EAC7BK,EAAS,IAAK,sBAAuB,CACtC,EACA,WAAc,CACbJ,EACAI,EAAS,IAAK,mBAAoB,CACnC,EACA,uBAA0B,CACzBgB,EAAMpB,CAAoB,EAC1BI,EAAS,IAAK,mBAAoB,CACnC,CACD,EAGImB,EAAgB,CACnB,WAAc,UACd,UAAa,UACb,UAAa,SACd,EAGIC,EAAgB,CACnB,QAAW,aACX,QAAW,YACX,QAAW,WACZ,EAYA,SAASJ,EAAMK,EAAM,CACpB,OAAOC,EASP,SAASA,EAASC,EAAQ,CACzB,OAASA,IAAU,WAAeF,EAAKE,CAAM,CAC9C,CACD,CAQA,SAASb,GAAgB,CAExB,OAAOP,CACR,CAQA,SAASQ,GAAqB,CAE7B,OAAOP,CACR,CAUA,SAASQ,EAAYY,EAAS,CAC7B,IAAIC,EACAC,EAGJ,IADAD,EAAKD,EAAQ,CAAE,EACTE,EAAI,EAAGA,EAAIF,EAAO,OAAQE,IAE/B,GAAKF,EAAQE,CAAE,IAAMD,EACpB,MAAM,IAAI,MAAOvB,EAAQ,+JAAgKD,EAAMuB,EAAQ,IAAK,CAAE,CAAE,EAGlN,OAAOC,CACR,CAUA,SAASZ,EAAgBW,EAAS,CACjC,IAAIC,EAAK1B,EAAkByB,CAAO,EAClC,GAAKC,IAAO,KACX,MAAM,IAAI,MAAOvB,EAAQ,wJAAyJD,EAAMuB,EAAQ,IAAK,CAAE,CAAE,EAE1M,OAAOC,CACR,CAUA,SAASX,EAAoBU,EAAS,CACrC,IAAIC,EAAKZ,EAAgBW,CAAO,EAGhC,OAAKvC,EAAyBwC,CAAG,GAAKA,IAAO,UACrCA,EAGHnC,EAA2BmC,CAAG,EAC3B1B,EAAkB,CAAE0B,EAAInB,CAA+B,CAAE,EAE5DjB,EAAyBoC,CAAG,EACzB1B,EAAkB,CAAE0B,EAAIpB,CAA6B,CAAE,EAGxDE,CACR,CASA,SAASU,EAAiCU,EAAQ,CACjD,OAAOR,EAAeQ,CAAM,GAAKpB,CAClC,CASA,SAASW,EAAoCS,EAAQ,CACpD,OAAOP,EAAeO,CAAM,GAAKnB,CAClC,CAkBA,SAASoB,EAASJ,EAAQK,EAAS,CAClC,IAAIJ,EACAK,EAGJ,GAAKjC,EAAYgC,CAAO,EACvB,OAAOA,EAIR,GADAC,EAAIrB,EAAeoB,CAAO,EACrBC,IAAM,OACV,OAAOA,EAAGN,CAAO,EAOlB,GAJAC,EAAKZ,EAAgBW,CAAO,EAG5BM,EAAIf,EAAec,CAAO,EACrBC,IAAM,OAEV,OAAKA,EAAG,CAAE,EAAGL,CAAG,EAERA,EAGH3B,EAAUgC,EAAG,CAAE,CAAE,EACdA,EAAG,CAAE,EAENA,EAAG,CAAE,EAAGL,CAAG,EAEnB,MAAM,IAAI,UAAWvB,EAAQ,uFAAwF2B,CAAO,CAAE,CAC/H,CAKA7C,EAAO,QAAU4C,IClVjB,IAAIG,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isRealFloatingPointDataType", "isComplexFloatingPointDataType", "isIntegerDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isRealDataType", "isNumericDataType", "isBooleanDataType", "isIntegerIndexDataType", "isBooleanIndexDataType", "isMaskIndexDataType", "isDataType", "isString", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_DTYPE", "DEFAULT_INDEX_DTYPE", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "DEFAULT_COMPLEX_FLOATING_POINT_DTYPE", "POLICY_TABLE1", "defaultPolicy", "defaultIndexPolicy", "samePolicy", "promotedPolicy", "accumulationPolicy", "POLICY_TABLE2", "wrap", "resolveDefaultRealFloatingPoint", "resolveDefaultComplexFloatingPoint", "COMPLEX2FLOAT", "FLOAT2COMPLEX", "fcn", "wrapper", "value", "dtypes", "dt", "i", "dtype", "resolve", "policy", "p", "main"]
+}

package/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+import { DataType, OutputPolicy } from '@stdlib/types/ndarray';
+
+/**
+* Resolves the output data type from a list of input ndarray data types.
+*
+* @param dtypes - input ndarray data types
+* @param policy - output ndarray data type policy
+* @returns output ndarray data type
+*
+* @example
+* var dt = outputDataType( [ 'float64' ], 'complex_floating_point' );
+* // returns <string>
+*/
+declare function outputDataType( dtypes: ArrayLike<DataType>, policy: OutputPolicy | DataType ): DataType;
+
+
+// EXPORTS //
+
+export = outputDataType;

package/lib/index.js

@@ -0,0 +1,40 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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';
+
+/**
+* Resolve the output data type from a list of input ndarray data types.
+*
+* @module @stdlib/ndarray-base-output-dtype
+*
+* @example
+* var resolve = require( '@stdlib/ndarray-base-output-dtype' );
+*
+* var dt = resolve( [ 'float64' ], 'complex_floating_point' );
+* // returns <string>
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,373 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+/* eslint-disable id-length */
+
+'use strict';
+
+// MODULES //
+
+var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );
+var isRealFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-real-floating-point-data-type' );
+var isComplexFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-complex-floating-point-data-type' );
+var isIntegerDataType = require( '@stdlib/ndarray-base-assert-is-integer-data-type' );
+var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );
+var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );
+var isRealDataType = require( '@stdlib/ndarray-base-assert-is-real-data-type' );
+var isNumericDataType = require( '@stdlib/ndarray-base-assert-is-numeric-data-type' );
+var isBooleanDataType = require( '@stdlib/ndarray-base-assert-is-boolean-data-type' );
+var isIntegerIndexDataType = require( '@stdlib/ndarray-base-assert-is-integer-index-data-type' );
+var isBooleanIndexDataType = require( '@stdlib/ndarray-base-assert-is-boolean-index-data-type' );
+var isMaskIndexDataType = require( '@stdlib/ndarray-base-assert-is-mask-index-data-type' );
+var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );
+var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );
+var defaults = require( '@stdlib/ndarray-defaults' );
+var join = require( '@stdlib/array-base-join' );
+var format = require( '@stdlib/string-format' );
+
+
+// VARIABLES //
+
+var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
+var DEFAULT_INDEX_DTYPE = defaults.get( 'dtypes.default_index' );
+var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );
+var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );
+var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );
+var DEFAULT_COMPLEX_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.complex_floating_point' );
+
+// Table where, for each respective policy, the value is a function which applies the policy to an input data type...
+var POLICY_TABLE1 = {
+	'default': defaultPolicy,
+	'default_index': defaultIndexPolicy,
+	'same': samePolicy,
+	'promoted': promotedPolicy,
+	'accumulation': accumulationPolicy
+};
+
+// Table where, for each respective policy, the value is an array whose first element is an assertion and whose second element is a fallback data type...
+var POLICY_TABLE2 = {
+	// Floating-point policies...
+	'floating_point': [
+		isFloatingPointDataType,
+		defaults.get( 'dtypes.floating_point' )
+	],
+	'floating_point_and_generic': [
+		wrap( isFloatingPointDataType ),
+		defaults.get( 'dtypes.floating_point' )
+	],
+	'real_floating_point': [
+		isRealFloatingPointDataType,
+		resolveDefaultRealFloatingPoint
+	],
+	'real_floating_point_and_generic': [
+		wrap( isRealFloatingPointDataType ),
+		resolveDefaultRealFloatingPoint
+	],
+	'complex_floating_point': [
+		isComplexFloatingPointDataType,
+		resolveDefaultComplexFloatingPoint
+	],
+	'complex_floating_point_and_generic': [
+		wrap( isComplexFloatingPointDataType ),
+		resolveDefaultComplexFloatingPoint
+	],
+
+	// Integer policies...
+	'integer': [
+		isIntegerDataType,
+		defaults.get( 'dtypes.integer' )
+	],
+	'integer_and_generic': [
+		wrap( isIntegerDataType ),
+		defaults.get( 'dtypes.integer' )
+	],
+	'signed_integer': [
+		isSignedIntegerDataType,
+		DEFAULT_SIGNED_INTEGER_DTYPE
+	],
+	'signed_integer_and_generic': [
+		wrap( isSignedIntegerDataType ),
+		DEFAULT_SIGNED_INTEGER_DTYPE
+	],
+	'unsigned_integer': [
+		isUnsignedIntegerDataType,
+		DEFAULT_UNSIGNED_INTEGER_DTYPE
+	],
+	'unsigned_integer_and_generic': [
+		wrap( isUnsignedIntegerDataType ),
+		DEFAULT_UNSIGNED_INTEGER_DTYPE
+	],
+
+	// Real-valued number policies...
+	'real': [
+		isRealDataType,
+		defaults.get( 'dtypes.real' )
+	],
+	'real_and_generic': [
+		wrap( isRealDataType ),
+		defaults.get( 'dtypes.real' )
+	],
+
+	// Real- and complex-valued number policies...
+	'numeric': [
+		isNumericDataType,
+		defaults.get( 'dtypes.numeric' )
+	],
+	'numeric_and_generic': [
+		wrap( isNumericDataType ),
+		defaults.get( 'dtypes.numeric' )
+	],
+
+	// Boolean policies...
+	'boolean': [
+		isBooleanDataType,
+		defaults.get( 'dtypes.boolean' )
+	],
+	'boolean_and_generic': [
+		wrap( isBooleanDataType ),
+		defaults.get( 'dtypes.boolean' )
+	],
+
+	// Index policies...
+	'integer_index': [
+		isIntegerIndexDataType,
+		defaults.get( 'dtypes.integer_index' )
+	],
+	'integer_index_and_generic': [
+		wrap( isIntegerIndexDataType ),
+		defaults.get( 'dtypes.integer_index' )
+	],
+	'boolean_index': [
+		isBooleanIndexDataType,
+		defaults.get( 'dtypes.boolean_index' )
+	],
+	'boolean_index_and_generic': [
+		wrap( isBooleanIndexDataType ),
+		defaults.get( 'dtypes.boolean_index' )
+	],
+	'mask_index': [
+		isMaskIndexDataType,
+		defaults.get( 'dtypes.mask_index' )
+	],
+	'mask_index_and_generic': [
+		wrap( isMaskIndexDataType ),
+		defaults.get( 'dtypes.mask_index' )
+	]
+};
+
+// Table mapping complex-valued floating-point data types to real-valued floating-point data types having the same precision:
+var COMPLEX2FLOAT = {
+	'complex128': 'float64',
+	'complex64': 'float32',
+	'complex32': 'float16'
+};
+
+// Table mapping real-valued floating-point data types to complex-valued floating-point data types having the same precision:
+var FLOAT2COMPLEX = {
+	'float64': 'complex128',
+	'float32': 'complex64',
+	'float16': 'complex32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Wraps a data type validation function to also check for a "generic" data type.
+*
+* @private
+* @param {Function} fcn - validation function
+* @returns {Function} wrapped validation function
+*/
+function wrap( fcn ) {
+	return wrapper;
+
+	/**
+	* Tests whether a provided data type is either "generic" or satisfies a data type validation function.
+	*
+	* @private
+	* @param {*} value - input value
+	* @returns {boolean} boolean indicating whether a provided value passes a test
+	*/
+	function wrapper( value ) {
+		return ( value === 'generic' ) || fcn( value );
+	}
+}
+
+/**
+* Returns the default data type.
+*
+* @private
+* @returns {string} output ndarray data type
+*/
+function defaultPolicy() {
+	// When the policy is "default", the output data type should always be the default data type without consideration for the input data types:
+	return DEFAULT_DTYPE;
+}
+
+/**
+* Returns the default index data type.
+*
+* @private
+* @returns {string} output ndarray data type
+*/
+function defaultIndexPolicy() {
+	// When the policy is "default_index", the output data type should always be the default index data type without consideration for the input data types:
+	return DEFAULT_INDEX_DTYPE;
+}
+
+/**
+* Applies the "same" policy by returning the common input data type.
+*
+* @private
+* @param {StringArray} dtypes - input ndarray data types
+* @throws {Error} invalid data types
+* @returns {string} output ndarray data type
+*/
+function samePolicy( dtypes ) {
+	var dt;
+	var i;
+
+	dt = dtypes[ 0 ];
+	for ( i = 1; i < dtypes.length; i++ ) {
+		// When the policy is "same", we require that all data types (both input and output) be the same...
+		if ( dtypes[ i ] !== dt ) {
+			throw new Error( format( 'invalid argument. Unable to resolve an output data type. The output data type policy is "same" and yet the input data types are not equal. Data types: [%s].', join( dtypes, ', ' ) ) );
+		}
+	}
+	return dt;
+}
+
+/**
+* Applies the "promoted" policy by applying type promotion to the list of provided data types.
+*
+* @private
+* @param {StringArray} dtypes - input ndarray data types
+* @throws {Error} must provide data types which can be safely cast to a common data type
+* @returns {string} output ndarray data type
+*/
+function promotedPolicy( dtypes ) {
+	var dt = promoteDataTypes( dtypes );
+	if ( dt === null ) {
+		throw new Error( format( 'invalid argument. Unable to apply type promotion rules when resolving a data type to which the input data types can be safely cast. Data types: [%s].', join( dtypes, ', ' ) ) );
+	}
+	return dt;
+}
+
+/**
+* Applies the "accumulation" policy to the list of input data types.
+*
+* @private
+* @param {StringArray} dtypes - input ndarray data types
+* @throws {Error} must provide data types which can be safely cast to a common data type
+* @returns {string} output ndarray data type
+*/
+function accumulationPolicy( dtypes ) {
+	var dt = promotedPolicy( dtypes );
+
+	// If the promoted data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...
+	if ( isFloatingPointDataType( dt ) || dt === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited
+		return dt;
+	}
+	// Unless the promoted data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in small range integer data types (e.g., `int8`) is at high risk for overflow, especially for ndarrays containing many elements...
+	if ( isUnsignedIntegerDataType( dt ) ) {
+		return promoteDataTypes( [ dt, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );
+	}
+	if ( isSignedIntegerDataType( dt ) ) {
+		return promoteDataTypes( [ dt, DEFAULT_SIGNED_INTEGER_DTYPE ] );
+	}
+	// For all other data types, accumulate in the default real-valued floating-point data type...
+	return DEFAULT_REAL_FLOATING_POINT_DTYPE;
+}
+
+/**
+* Resolves a default real-valued floating-point data type which preserves floating-point precision.
+*
+* @private
+* @param {string} dtype - input ndarray data type
+* @returns {string} output ndarray data type
+*/
+function resolveDefaultRealFloatingPoint( dtype ) {
+	return COMPLEX2FLOAT[ dtype ] || DEFAULT_REAL_FLOATING_POINT_DTYPE;
+}
+
+/**
+* Resolves a default complex-valued floating-point data type which preserves floating-point precision.
+*
+* @private
+* @param {string} dtype - input ndarray data type
+* @returns {string} output ndarray data type
+*/
+function resolveDefaultComplexFloatingPoint( dtype ) {
+	return FLOAT2COMPLEX[ dtype ] || DEFAULT_COMPLEX_FLOATING_POINT_DTYPE;
+}
+
+
+// MAIN //
+
+/**
+* Resolves the output data type from a list of input ndarray data types.
+*
+* @param {StringArray} dtypes - list of input ndarray data types
+* @param {string} policy - output ndarray data type policy
+* @throws {TypeError} second argument must be a recognized data type policy
+* @throws {Error} unexpected error
+* @returns {string} output ndarray data type
+*
+* @example
+* var dt = resolve( [ 'float64' ], 'complex_floating_point' );
+* // returns <string>
+*/
+function resolve( dtypes, policy ) {
+	var dt;
+	var p;
+
+	// First, check whether the policy mandates that the output data type always be a specific data type...
+	if ( isDataType( policy ) ) {
+		return policy;
+	}
+	// Next, check whether the policy is one in which we may be able to avoid type promotion...
+	p = POLICY_TABLE1[ policy ];
+	if ( p !== void 0 ) {
+		return p( dtypes );
+	}
+	// For all other policies, we always apply type promotion rules...
+	dt = promotedPolicy( dtypes );
+
+	// Check whether the policy requires determining the data type "kind"...
+	p = POLICY_TABLE2[ policy ];
+	if ( p !== void 0 ) {
+		// Check whether the promoted data type belongs to the data type "kind"...
+		if ( p[ 0 ]( dt ) ) {
+			// If so, we can just return the promoted data type:
+			return dt;
+		}
+		// Otherwise, we need to fallback to a default data type belonging to that "kind"...
+		if ( isString( p[ 1 ] ) ) {
+			return p[ 1 ];
+		}
+		return p[ 1 ]( dt );
+	}
+	throw new TypeError( format( 'invalid argument. Second argument must be a supported data type policy. Value: `%s`.', policy ) );
+}
+
+
+// EXPORTS //
+
+module.exports = resolve;

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@stdlib/ndarray-base-output-dtype",
+  "version": "0.1.0",
+  "description": "Resolve the output data type from a list of input ndarray data types.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/ndarray-base-output-dtype.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/array-base-join": "^0.1.1",
+    "@stdlib/assert-is-string": "^0.2.2",
+    "@stdlib/ndarray-base-assert-is-boolean-data-type": "^0.2.0",
+    "@stdlib/ndarray-base-assert-is-boolean-index-data-type": "^0.1.0",
+    "@stdlib/ndarray-base-assert-is-complex-floating-point-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-data-type": "^0.2.2",
+    "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-integer-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-integer-index-data-type": "^0.1.0",
+    "@stdlib/ndarray-base-assert-is-mask-index-data-type": "^0.1.0",
+    "@stdlib/ndarray-base-assert-is-numeric-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-real-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-real-floating-point-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.0",
+    "@stdlib/ndarray-base-promote-dtypes": "^0.1.0",
+    "@stdlib/ndarray-defaults": "^0.4.0",
+    "@stdlib/string-format": "^0.2.2",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "types",
+    "ndarray",
+    "dtypes",
+    "dtype",
+    "data",
+    "multidimensional",
+    "array",
+    "utilities",
+    "utility",
+    "utils",
+    "util",
+    "resolve",
+    "return",
+    "output"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}