time-to-botec/squiggle/node_modules/@stdlib/assert/is-complex/docs/repl.txt

30 lines
591 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is a 64-bit or 128-bit complex number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a 64-bit or 128-bit complex
number.
Examples
--------
> var bool = {{alias}}( new {{alias:@stdlib/complex/float32}}( 2.0, 2.0 ) )
true
> bool = {{alias}}( new {{alias:@stdlib/complex/float64}}( 3.0, 1.0 ) )
true
> bool = {{alias}}( 3.14 )
false
> bool = {{alias}}( {} )
false
See Also
--------