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!

# isAllowedCast [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] > Determine whether an ndarray [data type][@stdlib/ndarray/dtypes] can be cast to another ndarray [data type][@stdlib/ndarray/dtypes] according to a specified [casting mode][@stdlib/ndarray/casting-modes].
## Installation ```bash npm install @stdlib/ndarray-base-assert-is-allowed-data-type-cast ```
## Usage ```javascript var isAllowedCast = require( '@stdlib/ndarray-base-assert-is-allowed-data-type-cast' ); ``` #### isAllowedCast( from, to, casting ) Returns a boolean indicating whether an ndarray [data type][@stdlib/ndarray/dtypes] can be cast to another ndarray [data type][@stdlib/ndarray/dtypes] according to a specified [casting][@stdlib/ndarray/casting-modes] mode. ```javascript var bool = isAllowedCast( 'float32', 'float64', 'safe' ); // returns true bool = isAllowedCast( 'float64', 'int32', 'safe' ); // returns false ``` The following [casting][@stdlib/ndarray/casting-modes] modes are supported: - **none**: only allow casting between identical types. - **equiv**: allow casting between identical and byte swapped types. - **safe**: only allow "safe" casts. - **mostly-safe**: allow "safe" casts and, for floating-point data types, downcasts. - **same-kind**: allow "safe" casts and casts within the same kind (e.g., between signed integers or between floats). - **unsafe**: allow casting between all types (including between integers and floats).
## Examples ```javascript var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); var unzip = require( '@stdlib/utils-unzip' ); var dtypes = require( '@stdlib/ndarray-base-dtype-strings' ); var modes = require( '@stdlib/ndarray-casting-modes' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var isAllowedCast = require( '@stdlib/ndarray-base-assert-is-allowed-data-type-cast' ); // Generate a list of dtype pairs and casting modes: var pairs = nCartesianProduct( dtypes(), dtypes(), modes() ); // Unzip the list into individual arrays: var lists = unzip( pairs ); // For each data type pair and mode, determine whether one can cast to another data type: logEachMap( '%s => %s. %s: %s.', lists[ 0 ], lists[ 1 ], lists[ 2 ], isAllowedCast ); ```
* * * ## 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-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-assert-is-allowed-data-type-cast.svg [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-assert-is-allowed-data-type-cast [test-image]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/actions/workflows/test.yml/badge.svg?branch=v0.3.1 [test-url]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/actions/workflows/test.yml?query=branch:v0.3.1 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast?branch=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-assert-is-allowed-data-type-cast/tree/deno [deno-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/tree/umd [umd-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/tree/esm [esm-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-assert-is-allowed-data-type-cast/main/LICENSE [@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes [@stdlib/ndarray/casting-modes]: https://www.npmjs.com/package/@stdlib/ndarray-casting-modes