@stdlib/ndarray-output-dtype-policies

List of output ndarray data type policies.

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

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 stdlib types util utilities utility utils
Last synced: 6 months ago · JSON representation ·

Repository

List of output ndarray data type policies.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array data dtype dtypes javascript multidimensional ndarray node node-js nodejs stdlib types util utilities utility utils
Created almost 3 years ago · Last pushed 8 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!

Policies

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

List of output ndarray data type policies.

## Installation ```bash npm install @stdlib/ndarray-output-dtype-policies ``` 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 policies = require( '@stdlib/ndarray-output-dtype-policies' ); ``` #### policies() Returns a list of ndarray data type policies. ```javascript var out = policies(); // e.g., returns [ 'same', 'promoted', ... ] ``` The output array contains the following data type policies: - `same`: return the same data type. - `promoted`: return a promoted data type. - `accumulation`: return a data type amenable to accumulation. - `boolean`: return a boolean data type. - `boolean_and_generic`: return a boolean or "generic" data type. - `signed_integer`: return a signed integer data type. - `signed_integer_and_generic`: return a signed integer or "generic" data type. - `unsigned_integer`: return an unsigned integer data type. - `unsigned_integer_and_generic`: return an unsigned integer or "generic" data type. - `integer`: return an integer data type (i.e., either signed or unsigned). - `integer_and_generic`: return an integer (i.e., either signed or unsigned) or "generic" data type. - `floating_point`: return a floating-point data type (i.e., either real-valued or complex-valued). - `floating_point_and_generic`: return a floating-point (i.e., either real-valued or complex-valued) or "generic" data type. - `real_floating_point`: return a real-valued floating-point data type. - `real_floating_point_and_generic`: return a real-valued or "generic" floating-point data type. - `complex_floating_point`: return a complex-valued floating-point data type. - `complex_floating_point_and_generic`: return a complex-valued or "generic" floating-point data type. - `real`: return a real-valued data type. - `real_and_generic`: return a real-valued or "generic" data type. - `numeric`: return a numeric data type. - `numeric_and_generic`: return a numeric or "generic" data type. - `integer_index`: return an integer index data type. - `integer_index_and_generic`: return an integer index or "generic" data type. - `boolean_index`: return a boolean index data type. - `boolean_index_and_generic`: return a boolean index or "generic" data type. - `mask_index`: return a mask index data type. - `mask_index_and_generic`: return a mask index or "generic" data type. - `default`: return the default data type. - `default_index`: return the default index data type.
## Examples ```javascript var indexOf = require( '@stdlib/utils-index-of' ); var policies = require( '@stdlib/ndarray-output-dtype-policies' ); var POLICIES = policies(); function isPolicy( str ) { if ( indexOf( POLICIES, str ) === -1 ) { return false; } return true; } var bool = isPolicy( 'same' ); // returns true bool = isPolicy( 'real_floating_point' ); // returns true bool = isPolicy( 'promoted' ); // returns true bool = isPolicy( 'beep' ); // returns false ```
* * * ## 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
  • Push event: 45
Last Year
  • Push event: 45

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 212 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 2
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-output-dtype-policies

List of output ndarray data type policies.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 3
  • Dependent Repositories: 2
  • Downloads: 212 Last month
Rankings
Dependent packages count: 5.9%
Dependent repos count: 7.6%
Average: 12.3%
Forks count: 15.4%
Downloads: 16.0%
Stargazers count: 16.7%
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 7 months ago

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v2 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
package.json npm
  • @stdlib/assert-has-own-property ^0.0.7 development
  • @stdlib/assert-is-nonnegative-integer ^0.0.7 development
  • @stdlib/assert-is-string-array ^0.0.9 development
  • @stdlib/bench ^0.0.12 development
  • @stdlib/utils-index-of ^0.0.8 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.7
  • @stdlib/utils-define-read-only-property ^0.0.8
  • @stdlib/utils-keys ^0.0.7
  • @stdlib/utils-library-manifest ^0.0.8