mirror of
https://github.com/apple/swift-numerics
synced 2026-11-22 04:30:45 +00:00
1.5 KiB
1.5 KiB
Complex
A complex number type represented by its real and imaginary parts, and equipped with the usual arithmetic operators and math functions.
Overview
You can access these Cartesian components using the real and imaginary properties.
let z = Complex(1,-1) // 1 - i
let re = z.real // 1
let im = z.imaginary // -1
All Complex numbers with a non-finite component are treated as a single
"point at infinity," with infinite magnitude and indeterminant phase. Thus,
the real and imaginary parts of an infinity are nan.
let w = Complex<Double>.infinity
w == -w // true
let re = w.real // .nan
let im = w.imag // .nan
See doc:Infinity for more details.
The magnitude property of a complex number is the infinity norm of the
value (a.k.a. “maximum norm” or “Чебышёв [Chebyshev] norm”). To get the two
norm (a.k.a. "Euclidean norm"), use the length property. See
doc:Magnitude for more details.
Topics
Real and imaginary parts
realimaginaryrawStorageinit(_:_:)init(_:)-5aesjinit(imaginary:)
Phase, length and magnitude
magnitudelengthlengthSquarednormalizedphasepolarinit(length:phase:)
Scaling by real numbers
multiplied(by:)divided(by:)
Complex-specific operations
conjugate
Classification
isZeroisSubnormalisNormalisFinite