mirror of
https://github.com/apple/swift-numerics
synced 2026-11-22 04:30:45 +00:00
194 lines
6.9 KiB
Swift
194 lines
6.9 KiB
Swift
//===--- Arithmetic.swift -------------------------------------*- swift -*-===//
|
|
//
|
|
// This source file is part of the Swift Numerics open source project
|
|
//
|
|
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import RealModule
|
|
|
|
// MARK: - Additive structure
|
|
extension Complex: AdditiveArithmetic {
|
|
@_transparent
|
|
public static func +(z: Complex, w: Complex) -> Complex {
|
|
return Complex(z.x + w.x, z.y + w.y)
|
|
}
|
|
|
|
@_transparent
|
|
public static func -(z: Complex, w: Complex) -> Complex {
|
|
return Complex(z.x - w.x, z.y - w.y)
|
|
}
|
|
|
|
@_transparent
|
|
public static func +=(z: inout Complex, w: Complex) {
|
|
z = z + w
|
|
}
|
|
|
|
@_transparent
|
|
public static func -=(z: inout Complex, w: Complex) {
|
|
z = z - w
|
|
}
|
|
}
|
|
|
|
// MARK: - Vector space structure
|
|
//
|
|
// Policy: deliberately not using the * and / operators for these at the
|
|
// moment, because then there's an ambiguity in expressions like 2*z; is
|
|
// that Complex(2) * z or is it RealType(2) * z? This is especially
|
|
// problematic in type inference: suppose we have:
|
|
//
|
|
// let a: RealType = 1
|
|
// let b = 2*a
|
|
//
|
|
// what is the type of b? If we don't have a type context, it's ambiguous.
|
|
// If we have a Complex type context, then b will be inferred to have type
|
|
// Complex! Obviously, that doesn't help anyone.
|
|
//
|
|
// TODO: figure out if there's some way to avoid these surprising results
|
|
// and turn these into operators if/when we have it.
|
|
// (https://github.com/apple/swift-numerics/issues/12)
|
|
extension Complex {
|
|
/// `self` scaled by `a`.
|
|
@usableFromInline @_transparent
|
|
internal func multiplied(by a: RealType) -> Complex {
|
|
// This can be viewed in two different ways, which are mathematically
|
|
// equivalent: either we are computing `self * Complex(a)` (i.e.
|
|
// converting `a` to be a complex value, and then using the complex
|
|
// multiplication) or we are using the scalar product of the vector
|
|
// space structure: `Complex(a*real, a*imaginary)`.
|
|
//
|
|
// Although these two interpretations are _mathematically_ equivalent,
|
|
// they will generate different representations of the point at
|
|
// infinity in general. For example, suppose `self` is represented by
|
|
// `(infinity, 0)`. Then `self * Complex(1)` would evaluate as
|
|
// `(1*infinity - 0*0, 0*infinity + 1*0) = (infinity, nan)`, but
|
|
// the vector space interpretation produces `(infinity, 0)`. This does
|
|
// not matter much, because these are two representations of the same
|
|
// semantic value, but note that one requires four multiplies and two
|
|
// additions, while the one we use requires only two real multiplications.
|
|
Complex(x*a, y*a)
|
|
}
|
|
|
|
/// `self` unscaled by `a`.
|
|
@usableFromInline @_transparent
|
|
internal func divided(by a: RealType) -> Complex {
|
|
// See implementation notes for `multiplied` above.
|
|
Complex(x/a, y/a)
|
|
}
|
|
}
|
|
|
|
// MARK: - Multiplicative structure
|
|
extension Complex: AlgebraicField {
|
|
@_transparent
|
|
public static func *(z: Complex, w: Complex) -> Complex {
|
|
return Complex(z.x*w.x - z.y*w.y, z.x*w.y + z.y*w.x)
|
|
}
|
|
|
|
@_transparent
|
|
public static func /(z: Complex, w: Complex) -> Complex {
|
|
// Try the naive expression z/w = z*conj(w) / |w|^2; if we can compute
|
|
// this without over/underflow, everything is fine and the result is
|
|
// correct. If not, we have to rescale and do the computation carefully.
|
|
let lenSq = w.lengthSquared
|
|
guard lenSq.isNormal else { return rescaledDivide(z, w) }
|
|
return z * (w.conjugate.divided(by: lenSq))
|
|
}
|
|
|
|
@_transparent
|
|
public static func *=(z: inout Complex, w: Complex) {
|
|
z = z * w
|
|
}
|
|
|
|
@_transparent
|
|
public static func /=(z: inout Complex, w: Complex) {
|
|
z = z / w
|
|
}
|
|
|
|
@usableFromInline @_alwaysEmitIntoClient @inline(never)
|
|
internal static func rescaledDivide(_ z: Complex, _ w: Complex) -> Complex {
|
|
if w.isZero { return .infinity }
|
|
if z.isZero || !w.isFinite { return .zero }
|
|
// TODO: detect when RealType is Float and just promote to Double, then
|
|
// use the naive algorithm.
|
|
let zScale = z.magnitude
|
|
let wScale = w.magnitude
|
|
let zNorm = z.divided(by: zScale)
|
|
let wNorm = w.divided(by: wScale)
|
|
let r = (zNorm * wNorm.conjugate).divided(by: wNorm.lengthSquared)
|
|
// At this point, the result is (r * zScale)/wScale computed without
|
|
// undue overflow or underflow. We know that r is close to unity, so
|
|
// the question is simply what order in which to do this computation
|
|
// to avoid spurious overflow or underflow. There are three options
|
|
// to choose from:
|
|
//
|
|
// - r * (zScale / wScale)
|
|
// - (r * zScale) / wScale
|
|
// - (r / wScale) * zScale
|
|
//
|
|
// The simplest case is when zScale / wScale is normal:
|
|
if (zScale / wScale).isNormal {
|
|
return r.multiplied(by: zScale / wScale)
|
|
}
|
|
// Otherwise, we need to compute either rNorm * zScale or rNorm / wScale
|
|
// first. Choose the first if the first scaling behaves well, otherwise
|
|
// choose the other one.
|
|
if (r.magnitude * zScale).isNormal {
|
|
return r.multiplied(by: zScale).divided(by: wScale)
|
|
}
|
|
return r.divided(by: wScale).multiplied(by: zScale)
|
|
}
|
|
|
|
/// A normalized complex number with the same phase as this value.
|
|
///
|
|
/// If such a value cannot be produced (because the phase of zero and
|
|
/// infinity is undefined), `nil` is returned.
|
|
@inlinable
|
|
public var normalized: Complex? {
|
|
if length.isNormal {
|
|
return self.divided(by: length)
|
|
}
|
|
if isZero || !isFinite {
|
|
return nil
|
|
}
|
|
return self.divided(by: magnitude).normalized
|
|
}
|
|
|
|
/// The reciprocal of this value, if it can be computed without undue
|
|
/// overflow or underflow.
|
|
///
|
|
/// If z.reciprocal is non-nil, you can safely replace division by z with
|
|
/// multiplication by this value. It is not advantageous to do this for an
|
|
/// isolated division, but if you are dividing many values by a single
|
|
/// denominator, this may sometimes be a significant performance win.
|
|
///
|
|
/// A typical use case looks something like this:
|
|
/// ```
|
|
/// func divide<T: Real>(data: [Complex<T>], by divisor: Complex<T>) -> [Complex<T>] {
|
|
/// // If divisor is well-scaled, multiply by reciprocal.
|
|
/// if let recip = divisor.reciprocal {
|
|
/// return data.map { $0 * recip }
|
|
/// }
|
|
/// // Fallback on using division.
|
|
/// return data.map { $0 / divisor }
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// Error Bounds:
|
|
///
|
|
/// Unlike real types, when working with complex types, multiplying by the
|
|
/// reciprocal instead of dividing cannot change the result. If the
|
|
/// reciprocal is non-nil, the two computations are always equivalent.
|
|
@inlinable
|
|
public var reciprocal: Complex? {
|
|
let recip = 1/self
|
|
if recip.isNormal || isZero || !isFinite {
|
|
return recip
|
|
}
|
|
return nil
|
|
}
|
|
}
|