Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/array-safe-casts
Return a list of array data types to which a provided array data type can be safely cast.
https://github.com/stdlib-js/array-safe-casts
array cast casting javascript node node-js nodejs promotion rules stdlib types util utilities utility utils
Last synced: 15 days ago
JSON representation
Return a list of array data types to which a provided array data type can be safely cast.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-safe-casts
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T16:00:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T09:19:29.000Z (about 2 months ago)
- Last Synced: 2025-01-01T21:47:43.753Z (26 days ago)
- Topics: array, cast, casting, javascript, node, node-js, nodejs, promotion, rules, stdlib, types, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.09 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# Safe Casts
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a list of array [data types][@stdlib/array/dtypes] to which a provided array [data type][@stdlib/array/dtypes] can be safely cast.
## Installation
```bash
npm install @stdlib/array-safe-casts
```
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 safeCasts = require( '@stdlib/array-safe-casts' );
```
#### safeCasts( \[dtype] )
If provided a `dtype` argument, returns a list of array [data types][@stdlib/array/dtypes] to which a provided array [data type][@stdlib/array/dtypes] can be safely cast.
```javascript
var out = safeCasts( 'float32' );
// e.g., returns [ 'float32', 'float64', 'complex64', 'complex128', 'generic' ]
```
If not provided a `dtype` argument, the function returns a casting table.
```javascript
var out = safeCasts();
// returns {...}
var f32 = out[ 'float32' ];
// returns {...}
var v = f32[ 'float64' ];
// returns 1
```
If provided an unrecognized or unsupported `dtype`, the function returns `null`.
```javascript
var out = safeCasts( 'foo' );
// returns null
```
## Examples
```javascript
var dtypes = require( '@stdlib/array-dtypes' );
var safeCasts = require( '@stdlib/array-safe-casts' );
// Get the list of supported array data types:
var DTYPES = dtypes();
// Print the list of array data types to which a data type can be safely cast...
var list;
var i;
for ( i = 0; i < DTYPES.length; i++ ) {
list = safeCasts( DTYPES[ i ] );
console.log( '%s: %s', DTYPES[ i ], list.join( ', ' ) );
}
```
* * *
## See Also
- [`@stdlib/array-convert`][@stdlib/array/convert]: convert an array to an array of a different data type.
- [`@stdlib/array-convert-same`][@stdlib/array/convert-same]: convert an array to the same data type as a second input array.
- [`@stdlib/array-dtypes`][@stdlib/array/dtypes]: list of array data types.
- [`@stdlib/array-mostly-safe-casts`][@stdlib/array/mostly-safe-casts]: return a list of array data types to which a provided array data type can be safely cast and, for floating-point data types, can be downcast.
- [`@stdlib/array-same-kind-casts`][@stdlib/array/same-kind-casts]: return a list of array data types to which a provided array data type can be safely cast or cast within the same kind.
- [`@stdlib/ndarray-safe-casts`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast.
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-safe-casts.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-safe-casts
[test-image]: https://github.com/stdlib-js/array-safe-casts/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-safe-casts/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-safe-casts/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-safe-casts?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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/array-safe-casts/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-safe-casts/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-safe-casts/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-safe-casts/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-safe-casts/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-safe-casts/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-safe-casts/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-safe-casts/main/LICENSE
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes
[@stdlib/array/convert]: https://github.com/stdlib-js/array-convert
[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same
[@stdlib/array/mostly-safe-casts]: https://github.com/stdlib-js/array-mostly-safe-casts
[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/array-same-kind-casts
[@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/ndarray-safe-casts