time-to-botec/squiggle/node_modules/@stdlib/ndarray/same-kind-casts/docs/repl.txt

29 lines
678 B
Plaintext
Raw Normal View History

{{alias}}( [dtype] )
Returns a list of ndarray data types to which a provided ndarray data type
can be safely cast or cast within the same "kind".
If not provided an ndarray data type, the function returns a casting table.
If provided an unrecognized ndarray data type, the function returns `null`.
Parameters
----------
dtype: string (optional)
ndarray data type.
Returns
-------
out: Object|Array<string>|null
ndarray data types to which a data type can be safely cast or cast
within the same "kind".
Examples
--------
> var out = {{alias}}( 'float32' )
<Array>
See Also
--------