131 lines
3.3 KiB
Markdown
131 lines
3.3 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 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.
|
|
|
|
-->
|
|
|
|
# Same Kind Casts
|
|
|
|
> Return a list of ndarray [data types][@stdlib/ndarray/dtypes] to which a provided ndarray [data type][@stdlib/ndarray/dtypes] can be safely cast or cast within the same "kind".
|
|
|
|
<!-- 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="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var sameKindCasts = require( '@stdlib/ndarray/same-kind-casts' );
|
|
```
|
|
|
|
#### sameKindCasts( \[dtype] )
|
|
|
|
If provided a `dtype` argument, returns a list of ndarray [data types][@stdlib/ndarray/dtypes] to which a provided ndarray [data type][@stdlib/ndarray/dtypes] can be safely cast or cast within the same "kind" (e.g., between signed integers or between floating-point numbers).
|
|
|
|
```javascript
|
|
var out = sameKindCasts( 'float64' );
|
|
// e.g., returns [ 'float64', 'float32', ... ]
|
|
```
|
|
|
|
If not provided a `dtype` argument, the function returns a casting table.
|
|
|
|
```javascript
|
|
var out = sameKindCasts();
|
|
// returns {...}
|
|
|
|
var f64 = out[ 'float64' ];
|
|
// returns {...}
|
|
|
|
var v = f64[ 'float32' ];
|
|
// returns 1
|
|
```
|
|
|
|
If provided an unrecognized or unsupported `dtype`, the function returns `null`.
|
|
|
|
```javascript
|
|
var out = sameKindCasts( 'foo' );
|
|
// returns null
|
|
```
|
|
|
|
</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">
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<!-- Package usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var dtypes = require( '@stdlib/ndarray/dtypes' );
|
|
var sameKindCasts = require( '@stdlib/ndarray/same-kind-casts' );
|
|
|
|
var DTYPES;
|
|
var list;
|
|
var i;
|
|
|
|
// Get the list of supported ndarray data types:
|
|
DTYPES = dtypes();
|
|
|
|
// Print the list of ndarray data types to which a data type can be cast...
|
|
for ( i = 0; i < DTYPES.length; i++ ) {
|
|
list = sameKindCasts( DTYPES[ i ] );
|
|
console.log( '%s: %s', DTYPES[ i ], list.join( ', ' ) );
|
|
}
|
|
```
|
|
|
|
</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 all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/dtypes
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|