Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-base-output-dtype

Resolve the output data type from a list of input ndarray data types.

https://github.com/stdlib-js/ndarray-base-output-dtype

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

array data dtype dtypes javascript multidimensional ndarray node node-js nodejs output resolve return stdlib types util utilities utility utils
Last synced: 4 months ago · JSON representation ·

Repository

Resolve the output data type from a list of input ndarray data types.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array data dtype dtypes javascript multidimensional ndarray node node-js nodejs output resolve return stdlib types util utilities utility utils
Created 8 months ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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.

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.

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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

outputDataType

NPM version Build Status Coverage Status <!-- dependencies -->

Resolve the output ndarray data type from a list of input ndarray data types.

## Installation ```bash npm install @stdlib/ndarray-base-output-dtype ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## 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' // ... ```
## 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` - ``
## Examples ```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 ) ); ```
* * * ## 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 © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

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

GitHub Events

Total
  • Member event: 1
  • Push event: 9
  • Create event: 5
Last Year
  • Member event: 1
  • Push event: 9
  • Create event: 5