@stdlib/array-next-dtype
v0.3.0
Published
Return the next larger array data type of the same kind.
Downloads
10
Readme
nextDataType
Return the next larger array data type of the same kind.
Installation
npm install @stdlib/array-next-dtype
Usage
var nextDataType = require( '@stdlib/array-next-dtype' );
nextDataType( [dtype] )
If provided a dtype
argument, returns the next larger array data type of the same kind.
var out = nextDataType( 'float32' );
// returns 'float64'
If a data type does not have a next larger data type or the next larger data type is not supported, the function returns -1
.
var out = nextDataType( 'complex128' );
// returns -1
If not provided a dtype
argument, the function returns a table.
var out = nextDataType();
// returns {...}
If provided an unrecognized or unsupported dtype
, the function returns null
.
var out = nextDataType( 'foo' );
// returns null
Examples
var dtypes = require( '@stdlib/array-dtypes' );
var nextDataType = require( '@stdlib/array-next-dtype' );
var DTYPES;
var dt;
var i;
// Get the list of supported array data types:
DTYPES = dtypes();
// Print the next larger data type for each supported data type...
for ( i = 0; i < DTYPES.length; i++ ) {
dt = nextDataType( DTYPES[ i ] );
console.log( '%s => %s', DTYPES[ i ], dt );
}
See Also
@stdlib/array-dtype
: return the data type of an array.@stdlib/array-dtypes
: list of array data types.
Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.