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

45 lines
816 B
Plaintext
Raw Normal View History

{{alias}}( real, imag )
64-bit complex number constructor.
Both the real and imaginary components are stored as single-precision
floating-point numbers.
Parameters
----------
real: number
Real component.
imag: number
Imaginary component.
Returns
-------
z: Complex64
64-bit complex number.
z.re: number
Read-only property returning the real component.
z.im: number
Read-only property returning the imaginary component.
z.BYTES_PER_ELEMENT
Size (in bytes) of each component. Value: 4.
z.byteLength
Length (in bytes) of a complex number. Value: 8.
Examples
--------
> var z = new {{alias}}( 5.0, 3.0 )
<Complex64>
> z.re
5.0
> z.im
3.0
See Also
--------