time-to-botec/squiggle/node_modules/@stdlib/ndarray/promotion-rules/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

34 lines
791 B
Plaintext

{{alias}}( [dtype1, dtype2] )
Returns the ndarray data type with the smallest size and closest "kind" to
which ndarray data types can be safely cast.
If not provided data types, the function returns a type promotion table.
If a data type to which data types can be safely cast does *not* exist (or
is not supported), the function returns `-1`.
If provided an unrecognized data type, the function returns `null`.
Parameters
----------
dtype1: string (optional)
ndarray data type.
dtype2: string (optional)
ndarray data type.
Returns
-------
out: Object|string|integer|null
Promotion rule(s).
Examples
--------
> var out = {{alias}}( 'float32', 'int32' )
'float64'
See Also
--------