mirror of
https://github.com/apple/swift-numerics
synced 2026-11-22 04:30:45 +00:00
Compare commits
61
Commits
biginteger
..
1.1.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0c0290ff6b | ||
|
|
cc9f8e3c5f | ||
|
|
bbadd4b853 | ||
|
|
e46ddfe087 | ||
|
|
1653d35461 | ||
|
|
207fea2fc1 | ||
|
|
c16e7a9617 | ||
|
|
416b94a80e | ||
|
|
1a19d0d28d | ||
|
|
d91884bb27 | ||
|
|
6bd8a0cc08 | ||
|
|
05472f917c | ||
|
|
658bcd12f4 | ||
|
|
b95ca135a6 | ||
|
|
fd82b65b04 | ||
|
|
6356eb395b | ||
|
|
1be6eb5b47 | ||
|
|
2b458e8aeb | ||
|
|
31fe14d084 | ||
|
|
c327d04b01 | ||
|
|
9b36b1ce46 | ||
|
|
7888cf22cc | ||
|
|
1d23717b47 | ||
|
|
0d774a5bc3 | ||
|
|
7ba979e24b | ||
|
|
d0ffe3c0e0 | ||
|
|
e750ab6419 | ||
|
|
06e2bf1f76 | ||
|
|
c4cc31ea95 | ||
|
|
7b1e0db437 | ||
|
|
e30276bff2 | ||
|
|
ddc8ce302b | ||
|
|
b5adc8c39b | ||
|
|
683c8f210a | ||
|
|
c69fea9be8 | ||
|
|
3ee07816b2 | ||
|
|
53afff107a | ||
|
|
1043e9ed38 | ||
|
|
e7af7dffbc | ||
|
|
da661919b9 | ||
|
|
6deae1b98f | ||
|
|
155cfc306c | ||
|
|
877fd0aa9a | ||
|
|
262cbea1f2 | ||
|
|
84c41a0bef | ||
|
|
a883d95a4d | ||
|
|
3d6de9f3ef | ||
|
|
3fa18ae9b5 | ||
|
|
1ba2178227 | ||
|
|
97bab250eb | ||
|
|
ab63ebd7b2 | ||
|
|
347f1e31fe | ||
|
|
fa7db5761d | ||
|
|
907430bdad | ||
|
|
57ad9c588b | ||
|
|
05a3ee869f | ||
|
|
4e905b38b7 | ||
|
|
43e0f5b026 | ||
|
|
0599b610d9 | ||
|
|
2fae6a86e3 | ||
|
|
faa65e8842 |
No files matched your search
@@ -0,0 +1,22 @@
|
||||
name: Pull request
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, reopened, synchronize]
|
||||
|
||||
jobs:
|
||||
tests:
|
||||
name: Test
|
||||
uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
|
||||
with:
|
||||
enable_wasm_sdk_build: true
|
||||
wasm_sdk_build_command: swift build --target Numerics
|
||||
soundness:
|
||||
name: Soundness
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
|
||||
with:
|
||||
license_header_check_project_name: "Swift Numerics"
|
||||
# https://github.com/apple/swift-numerics/issues/303
|
||||
license_header_check_enabled: false
|
||||
# https://github.com/apple/swift-numerics/issues/302
|
||||
format_check_enabled: false
|
||||
@@ -1,4 +1,4 @@
|
||||
version: 1
|
||||
builder:
|
||||
configs:
|
||||
- documentation_targets: [Numerics, RealModule, ComplexModule, BigIntModule]
|
||||
- documentation_targets: [Numerics, RealModule, ComplexModule]
|
||||
+1
-4
@@ -11,7 +11,7 @@ cmake_minimum_required(VERSION 3.16)
|
||||
project(swift-numerics
|
||||
LANGUAGES Swift)
|
||||
|
||||
list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules)
|
||||
list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules)
|
||||
|
||||
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
@@ -22,9 +22,6 @@ include(CTest)
|
||||
include(SwiftSupport)
|
||||
|
||||
add_subdirectory(Sources)
|
||||
if(BUILD_TESTING)
|
||||
add_subdirectory(Tests)
|
||||
endif()
|
||||
|
||||
get_property(SWIFT_NUMERICS_EXPORTS GLOBAL PROPERTY SWIFT_NUMERICS_EXPORTS)
|
||||
export(TARGETS ${SWIFT_NUMERICS_EXPORTS}
|
||||
|
||||
+3
-40
@@ -1,9 +1,9 @@
|
||||
// swift-tools-version:5.5
|
||||
// swift-tools-version:5.9
|
||||
//===--- Package.swift ----------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -18,7 +18,6 @@ let package = Package(
|
||||
|
||||
name: "swift-numerics",
|
||||
products: [
|
||||
.library(name: "BigIntModule", targets: ["BigIntModule"]),
|
||||
.library(name: "ComplexModule", targets: ["ComplexModule"]),
|
||||
.library(name: "Numerics", targets: ["Numerics"]),
|
||||
.library(name: "RealModule", targets: ["RealModule"]),
|
||||
@@ -26,27 +25,15 @@ let package = Package(
|
||||
|
||||
targets: [
|
||||
// MARK: - Public API
|
||||
.target(
|
||||
name: "BigIntModule",
|
||||
dependencies: [],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "ComplexModule",
|
||||
dependencies: ["RealModule"],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "IntegerUtilities",
|
||||
dependencies: [],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "Numerics",
|
||||
dependencies: ["ComplexModule", "IntegerUtilities", "RealModule", "BigIntModule"],
|
||||
dependencies: ["ComplexModule", "RealModule"],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
@@ -72,40 +59,16 @@ let package = Package(
|
||||
),
|
||||
|
||||
// MARK: - Unit test bundles
|
||||
.testTarget(
|
||||
name: "BigIntTests",
|
||||
dependencies: ["BigIntModule"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "ComplexTests",
|
||||
dependencies: ["_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "IntegerUtilitiesTests",
|
||||
dependencies: ["IntegerUtilities", "_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "RealTests",
|
||||
dependencies: ["_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
// MARK: - Test executables
|
||||
.executableTarget(
|
||||
name: "ComplexLog",
|
||||
dependencies: ["Numerics", "_TestSupport"],
|
||||
path: "Tests/Executable/ComplexLog"
|
||||
),
|
||||
|
||||
.executableTarget(
|
||||
name: "ComplexLog1p",
|
||||
dependencies: ["Numerics", "_TestSupport"],
|
||||
path: "Tests/Executable/ComplexLog1p"
|
||||
)
|
||||
]
|
||||
)
|
||||
@@ -1,111 +0,0 @@
|
||||
// swift-tools-version:5.4
|
||||
//===--- Package.swift ----------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 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 PackageDescription
|
||||
|
||||
let excludedFilenames = ["CMakeLists.txt", "README.md"]
|
||||
|
||||
let package = Package(
|
||||
|
||||
name: "swift-numerics",
|
||||
products: [
|
||||
.library(name: "BigIntModule", targets: ["BigIntModule"]),
|
||||
.library(name: "ComplexModule", targets: ["ComplexModule"]),
|
||||
.library(name: "Numerics", targets: ["Numerics"]),
|
||||
.library(name: "RealModule", targets: ["RealModule"]),
|
||||
],
|
||||
|
||||
targets: [
|
||||
// MARK: - Public API
|
||||
.target(
|
||||
name: "BigIntModule",
|
||||
dependencies: [],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "ComplexModule",
|
||||
dependencies: ["RealModule"],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "IntegerUtilities",
|
||||
dependencies: [],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "Numerics",
|
||||
dependencies: ["ComplexModule", "IntegerUtilities", "RealModule", "BigIntModule"],
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "RealModule",
|
||||
dependencies: ["_NumericsShims"],
|
||||
exclude: excludedFilenames,
|
||||
linkerSettings: [
|
||||
.linkedLibrary("m", .when(platforms: [.linux, .android]))
|
||||
]
|
||||
),
|
||||
|
||||
// MARK: - Implementation details
|
||||
.target(
|
||||
name: "_NumericsShims",
|
||||
exclude: excludedFilenames
|
||||
),
|
||||
|
||||
.target(
|
||||
name: "_TestSupport",
|
||||
dependencies: ["Numerics"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
// MARK: - Unit test bundles
|
||||
.testTarget(
|
||||
name: "BigIntTests",
|
||||
dependencies: ["BigIntModule"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "ComplexTests",
|
||||
dependencies: ["_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "IntegerUtilitiesTests",
|
||||
dependencies: ["IntegerUtilities", "_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
.testTarget(
|
||||
name: "RealTests",
|
||||
dependencies: ["_TestSupport"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
|
||||
// MARK: - Test executables
|
||||
.executableTarget(
|
||||
name: "ComplexLog",
|
||||
dependencies: ["Numerics", "_TestSupport"],
|
||||
path: "Tests/Executable/ComplexLog"
|
||||
),
|
||||
|
||||
.executableTarget(
|
||||
name: "ComplexLog1p",
|
||||
dependencies: ["Numerics", "_TestSupport"],
|
||||
path: "Tests/Executable/ComplexLog1p"
|
||||
)
|
||||
]
|
||||
)
|
||||
@@ -42,7 +42,7 @@ To use Swift Numerics in a SwiftPM project:
|
||||
1. Add the following line to the dependencies in your `Package.swift` file:
|
||||
|
||||
```swift
|
||||
.package(url: "https://github.com/apple/swift-numerics", from: "1.0.0"),
|
||||
.package(url: "https://github.com/apple/swift-numerics", from: "1.1.0"),
|
||||
```
|
||||
|
||||
2. Add `Numerics` as a dependency for your target:
|
||||
@@ -84,7 +84,7 @@ Swift Numerics uses GitHub issues to track bugs and features. We use pull reques
|
||||
1. Raise an issue with the [new module] tag.
|
||||
2. Raise a PR with an implementation sketch.
|
||||
3. Once you have some consensus, ask an admin to create a feature branch against which PRs can be raised.
|
||||
4. When the design has stabilized and is functional enough to be useful, raise a PR to merge the new module to master.
|
||||
4. When the design has stabilized and is functional enough to be useful, raise a PR to merge the new module to main.
|
||||
|
||||
### How to propose a new feature for an existing module
|
||||
|
||||
@@ -105,8 +105,6 @@ Questions about how to use Swift Numerics modules, or issues that are not clearl
|
||||
|
||||
1. [`RealModule`](Sources/RealModule/README.md)
|
||||
2. [`ComplexModule`](Sources/ComplexModule/README.md)
|
||||
3. [`IntegerUtilities`](Sources/IntegerUtilities/README.md) (on main only, not yet present in a released tag)
|
||||
4. [`BigIntModule`](Sources/BigIntModule/README.md) (on branch only)
|
||||
|
||||
## Future expansion
|
||||
|
||||
|
||||
@@ -1,810 +0,0 @@
|
||||
//===--- BigInt.swift -----------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2020 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
public struct BigInt: SignedInteger {
|
||||
|
||||
public typealias Words = [UInt]
|
||||
|
||||
public private(set) var words: Words
|
||||
|
||||
@usableFromInline
|
||||
internal init(_uncheckedWords: Words) {
|
||||
self.words = _uncheckedWords
|
||||
}
|
||||
|
||||
public init<T>(bitPattern source: T) where T: BinaryInteger {
|
||||
words = Words(source.words)
|
||||
BigInt._dropExcessWords(words: &words)
|
||||
}
|
||||
|
||||
@usableFromInline
|
||||
internal var _isNegative: Bool {
|
||||
words[words.endIndex - 1] > Int.max
|
||||
}
|
||||
|
||||
private static let _digits: [BigInt] = (0 ... 36).map {
|
||||
BigInt(_uncheckedWords: [UInt(bitPattern: $0)])
|
||||
}
|
||||
|
||||
private static let _digitRadix = BigInt(_uncheckedWords: [0, 1])
|
||||
}
|
||||
|
||||
// MARK: - Basic Behaviors
|
||||
|
||||
extension BigInt: Equatable {
|
||||
|
||||
@inlinable
|
||||
public static func == (lhs: BigInt, rhs: BigInt) -> Bool {
|
||||
lhs.words == rhs.words
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func != (lhs: BigInt, rhs: BigInt) -> Bool {
|
||||
!(lhs == rhs)
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: Hashable {
|
||||
|
||||
@inlinable
|
||||
public func hash(into hasher: inout Hasher) {
|
||||
hasher.combine(words)
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: Comparable {
|
||||
|
||||
@inlinable
|
||||
public static func < (lhs: BigInt, rhs: BigInt) -> Bool {
|
||||
let lhsNegative = lhs._isNegative
|
||||
let rhsNegative = rhs._isNegative
|
||||
|
||||
if lhsNegative && !rhsNegative { return true }
|
||||
if rhsNegative && !lhsNegative { return false }
|
||||
|
||||
if (lhsNegative && rhsNegative) || (!lhsNegative && !rhsNegative) {
|
||||
if lhs.words.count > rhs.words.count {
|
||||
return lhsNegative ? true : false
|
||||
}
|
||||
if lhs.words.count < rhs.words.count {
|
||||
return lhsNegative ? false : true
|
||||
}
|
||||
|
||||
for i in stride(from: lhs.words.count - 1, through: 0, by: -1) {
|
||||
if lhs.words[i] > rhs.words[i] {
|
||||
return false
|
||||
} else if lhs.words[i] < rhs.words[i] {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: LosslessStringConvertible {
|
||||
|
||||
public init?(_ description: String) {
|
||||
self.init(description, radix: 10)
|
||||
}
|
||||
|
||||
public init?<T>(_ description: T, radix: Int = 10) where T: StringProtocol {
|
||||
precondition(2 ... 36 ~= radix, "Radix not in range 2 ... 36")
|
||||
|
||||
self = 0
|
||||
|
||||
let isNegative = description.hasPrefix("-")
|
||||
let hasPrefix = isNegative || description.hasPrefix("+")
|
||||
let utf8 = description.utf8.dropFirst(hasPrefix ? 1 : 0)
|
||||
guard !utf8.isEmpty else { return nil }
|
||||
|
||||
for var byte in utf8 {
|
||||
switch byte {
|
||||
case UInt8(ascii: "0") ... UInt8(ascii: "9"):
|
||||
byte -= UInt8(ascii: "0")
|
||||
case UInt8(ascii: "A") ... UInt8(ascii: "Z"):
|
||||
byte -= UInt8(ascii: "A")
|
||||
byte += 10
|
||||
case UInt8(ascii: "a") ... UInt8(ascii: "z"):
|
||||
byte -= UInt8(ascii: "a")
|
||||
byte += 10
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
guard byte < radix else { return nil }
|
||||
self *= BigInt._digits[radix]
|
||||
self += BigInt._digits[Int(byte)]
|
||||
}
|
||||
|
||||
if isNegative {
|
||||
self.negate()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: Decodable {
|
||||
|
||||
public init(from decoder: Decoder) throws {
|
||||
let singleValueContainer = try decoder.singleValueContainer()
|
||||
let description = try singleValueContainer.decode(String.self)
|
||||
guard let result = BigInt(description) else {
|
||||
throw DecodingError.dataCorruptedError(
|
||||
in: singleValueContainer,
|
||||
debugDescription: "BigInt(\(description.debugDescription)) failed")
|
||||
}
|
||||
self = result
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: Encodable {
|
||||
|
||||
public func encode(to encoder: Encoder) throws {
|
||||
var singleValueContainer = encoder.singleValueContainer()
|
||||
try singleValueContainer.encode(description)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Numeric Protocols
|
||||
|
||||
extension BigInt: ExpressibleByIntegerLiteral {
|
||||
|
||||
public init(integerLiteral value: Int) {
|
||||
if value >= 0, value < BigInt._digits.count {
|
||||
self = BigInt._digits[value]
|
||||
} else {
|
||||
words = [UInt(bitPattern: value)]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: AdditiveArithmetic {
|
||||
|
||||
@inlinable
|
||||
public static func + (lhs: BigInt, rhs: BigInt) -> BigInt {
|
||||
var result = lhs
|
||||
result += rhs
|
||||
return result
|
||||
}
|
||||
|
||||
public static func += (lhs: inout BigInt, rhs: BigInt) {
|
||||
if lhs.words.count == 1, rhs.words.count == 1 {
|
||||
let lhsWord = lhs.words[0]
|
||||
let rhsWord = rhs.words[0]
|
||||
|
||||
let (result, isOverflow) = lhsWord.addingReportingOverflow(rhsWord)
|
||||
|
||||
if !isOverflow && result < Int.max {
|
||||
lhs.words[0] = result
|
||||
return
|
||||
}
|
||||
let knownNegativeResult = lhsWord > Int.max && rhsWord > Int.max
|
||||
|
||||
if lhsWord > Int.max || rhsWord > Int.max, !knownNegativeResult {
|
||||
// positive + negative is always smaller, so overflow is a red herring
|
||||
lhs.words[0] = result
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
var isOverflow = false
|
||||
|
||||
var rhsWords = rhs.words
|
||||
|
||||
lhs.words.append(lhs._isNegative ? UInt.max : 0)
|
||||
rhsWords.append(rhs._isNegative ? UInt.max : 0)
|
||||
|
||||
BigInt._signExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
var temp: UInt = 0
|
||||
for index in 0 ..< lhs.words.count {
|
||||
var carryOverflow = false
|
||||
|
||||
if isOverflow {
|
||||
(temp, carryOverflow) = rhsWords[index].addingReportingOverflow(1)
|
||||
} else {
|
||||
temp = rhsWords[index]
|
||||
}
|
||||
|
||||
(lhs.words[index], isOverflow) = lhs.words[index].addingReportingOverflow(temp)
|
||||
|
||||
isOverflow = carryOverflow || isOverflow
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func - (lhs: BigInt, rhs: BigInt) -> BigInt {
|
||||
var result = lhs
|
||||
result -= rhs
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func -= (lhs: inout BigInt, rhs: BigInt) {
|
||||
lhs += -rhs
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: Numeric {
|
||||
|
||||
public init?<T>(exactly source: T) where T: BinaryInteger {
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public var magnitude: BigInt { _isNegative ? -self : self }
|
||||
|
||||
public static func * (lhs: BigInt, rhs: BigInt) -> BigInt {
|
||||
let lhsIsNeg = lhs.words[lhs.words.endIndex - 1] > Int.max
|
||||
let rhsIsNeg = rhs.words[rhs.words.endIndex - 1] > Int.max
|
||||
|
||||
let lhsWords = lhsIsNeg ? (-lhs).words : lhs.words
|
||||
let rhsWords = rhsIsNeg ? (-rhs).words : rhs.words
|
||||
|
||||
let count = lhsWords.count + rhsWords.count + 1
|
||||
var newWords = Words(repeating: 0, count: count)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
var carry: UInt = 0
|
||||
var digit: UInt = 0
|
||||
|
||||
var lastJ: Int = 0
|
||||
for j in i ..< (lhsWords.count + i) {
|
||||
var (high, low) = rhsWords[i].multipliedFullWidth(by: lhsWords[j - i])
|
||||
var isOverflow: Bool
|
||||
(digit, isOverflow) = low.addingReportingOverflow(newWords[j])
|
||||
if isOverflow {
|
||||
high += 1
|
||||
}
|
||||
|
||||
(digit, isOverflow) = digit.addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
high += 1
|
||||
}
|
||||
|
||||
carry = high
|
||||
newWords[j] = digit
|
||||
lastJ = j
|
||||
}
|
||||
|
||||
if carry != 0 {
|
||||
let isOverflow: Bool
|
||||
(digit, isOverflow) = newWords[lastJ + 1].addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
carry = 1
|
||||
}
|
||||
newWords[lastJ + 1] = digit
|
||||
}
|
||||
}
|
||||
|
||||
for i in stride(from: count - 1, through: 1, by: -1) {
|
||||
if newWords[i] == 0, newWords[i - 1] <= Int.max {
|
||||
newWords.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if lhsIsNeg || rhsIsNeg, !(lhsIsNeg && rhsIsNeg) {
|
||||
return -BigInt(_uncheckedWords: newWords)
|
||||
}
|
||||
|
||||
return BigInt(_uncheckedWords: newWords)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func *= (lhs: inout BigInt, rhs: BigInt) {
|
||||
lhs = lhs * rhs
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: SignedNumeric {
|
||||
|
||||
public mutating func negate() {
|
||||
var isOverflow = true
|
||||
for i in 0 ..< words.count {
|
||||
if isOverflow {
|
||||
(words[i], isOverflow) = (~words[i]).addingReportingOverflow(1)
|
||||
} else {
|
||||
words[i] = ~words[i]
|
||||
}
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &words)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static prefix func - (x: BigInt) -> BigInt {
|
||||
var result = x
|
||||
result.negate()
|
||||
return result
|
||||
}
|
||||
}
|
||||
|
||||
extension BigInt: BinaryInteger {
|
||||
|
||||
public init?<T>(exactly source: T) where T: BinaryFloatingPoint {
|
||||
guard source.isFinite, source == source.rounded(.towardZero) else {
|
||||
return nil
|
||||
}
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public init<T>(_ source: T) where T: BinaryFloatingPoint {
|
||||
precondition(
|
||||
source.isFinite,
|
||||
"""
|
||||
\(type(of: source)) value cannot be converted to BigInt because it is \
|
||||
either infinite or NaN
|
||||
""")
|
||||
|
||||
let isNegative = source < 0.0
|
||||
var float = isNegative ? -source : source
|
||||
|
||||
if let _ = UInt(exactly: T.greatestFiniteMagnitude) {
|
||||
words = [UInt(float)]
|
||||
} else {
|
||||
var words = Words()
|
||||
let radix = T(sign: .plus, exponent: T.Exponent(UInt.bitWidth), significand: 1)
|
||||
repeat {
|
||||
let digit = UInt(float.truncatingRemainder(dividingBy: radix))
|
||||
words.append(digit)
|
||||
float = (float / radix).rounded(.towardZero)
|
||||
} while float != 0
|
||||
|
||||
if let last = words.last, last >= Int.max {
|
||||
words.append(0)
|
||||
}
|
||||
self.words = words
|
||||
}
|
||||
|
||||
if isNegative {
|
||||
self.negate()
|
||||
}
|
||||
}
|
||||
|
||||
public init<T>(_ source: T) where T: BinaryInteger {
|
||||
if source >= 0, source < BigInt._digits.count {
|
||||
self = BigInt._digits[Int(source)]
|
||||
} else {
|
||||
words = Words(source.words)
|
||||
if source > 0 && source.words[source.words.endIndex - 1] > Int.max {
|
||||
words.append(0)
|
||||
}
|
||||
// needed to handle sign-extended multi-word numbers that
|
||||
// actually fit in a single word
|
||||
BigInt._dropExcessWords(words: &words)
|
||||
}
|
||||
}
|
||||
|
||||
public init<T>(clamping source: T) where T: BinaryInteger {
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public init<T>(truncatingIfNeeded source: T) where T: BinaryInteger {
|
||||
words = Words(source.words)
|
||||
}
|
||||
|
||||
public var bitWidth: Int { words.count * UInt.bitWidth }
|
||||
|
||||
public var trailingZeroBitCount: Int {
|
||||
var totalZeros = 0
|
||||
for word in words {
|
||||
if word == 0 {
|
||||
totalZeros += UInt.bitWidth
|
||||
} else {
|
||||
totalZeros += word.trailingZeroBitCount
|
||||
break
|
||||
}
|
||||
}
|
||||
return totalZeros
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func / (lhs: BigInt, rhs: BigInt) -> BigInt {
|
||||
let (result, _) = _div(lhs: lhs, rhs: rhs)
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func /= (lhs: inout BigInt, rhs: BigInt) {
|
||||
lhs = lhs / rhs
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func % (lhs: BigInt, rhs: BigInt) -> BigInt {
|
||||
let (_, result) = _div(lhs: lhs, rhs: rhs)
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func %= (lhs: inout BigInt, rhs: BigInt) {
|
||||
lhs = lhs % rhs
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static prefix func ~ (x: BigInt) -> BigInt {
|
||||
let newWords = x.words.map { ~$0 }
|
||||
return BigInt(_uncheckedWords: Words(newWords))
|
||||
}
|
||||
|
||||
public static func &= (lhs: inout BigInt, rhs: BigInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigInt._signExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] &= rhsWords[i]
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func |= (lhs: inout BigInt, rhs: BigInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigInt._signExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] |= rhsWords[i]
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func ^= (lhs: inout BigInt, rhs: BigInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigInt._signExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] &= rhsWords[i]
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func <<= <RHS>(lhs: inout BigInt, rhs: RHS) where RHS: BinaryInteger {
|
||||
if rhs.signum() < 0 {
|
||||
lhs >>= rhs.magnitude
|
||||
return
|
||||
}
|
||||
|
||||
let wordLength = UInt.bitWidth
|
||||
let isNegative = lhs._isNegative
|
||||
|
||||
let (fullWords, remainder) = rhs.quotientAndRemainder(dividingBy: RHS(wordLength))
|
||||
lhs.words = Words(repeating: 0, count: Int(fullWords)) + lhs.words + [isNegative ? UInt.max : 0]
|
||||
|
||||
if remainder > 0 {
|
||||
var value: UInt = 0
|
||||
for i in 0 ..< lhs.words.count {
|
||||
let temp = lhs.words[i] >> (wordLength - Int(remainder))
|
||||
lhs.words[i] <<= Int(remainder)
|
||||
if i > 0 {
|
||||
lhs.words[i] &= UInt.max << Int(remainder)
|
||||
lhs.words[i] |= value
|
||||
}
|
||||
|
||||
value = temp
|
||||
}
|
||||
|
||||
if isNegative {
|
||||
lhs.words[lhs.words.count - 1] |= (UInt.max << Int(remainder))
|
||||
}
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func >>= <RHS>(lhs: inout BigInt, rhs: RHS) where RHS: BinaryInteger {
|
||||
if rhs.signum() < 0 {
|
||||
lhs <<= rhs.magnitude
|
||||
return
|
||||
}
|
||||
|
||||
let wordLength = UInt.bitWidth
|
||||
let isNegative = lhs._isNegative
|
||||
|
||||
let (fullWords, remainder) = rhs.quotientAndRemainder(dividingBy: RHS(wordLength))
|
||||
if fullWords < lhs.words.count {
|
||||
lhs.words.removeFirst(Int(fullWords))
|
||||
} else {
|
||||
lhs = isNegative ? -1 : 0
|
||||
return
|
||||
}
|
||||
|
||||
if remainder > 0 {
|
||||
let mask = ~(UInt.max << remainder)
|
||||
var value: UInt = 0
|
||||
for i in stride(from: lhs.words.count - 1, through: 0, by: -1) {
|
||||
let temp = lhs.words[i] & mask
|
||||
lhs.words[i] >>= remainder
|
||||
lhs.words[i] |= (value << (UInt.bitWidth - Int(remainder)))
|
||||
value = temp
|
||||
}
|
||||
}
|
||||
|
||||
if isNegative {
|
||||
lhs.words[lhs.words.count - 1] |= (UInt.max << (UInt.bitWidth - Int(remainder)))
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public func quotientAndRemainder(dividingBy rhs: BigInt) -> (quotient: BigInt, remainder: BigInt) {
|
||||
return BigInt._div(lhs: self, rhs: rhs)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public func signum() -> BigInt { _isNegative ? -1 : (self == 0) ? 0 : 1 }
|
||||
}
|
||||
|
||||
// MARK: -
|
||||
|
||||
extension BigInt {
|
||||
|
||||
/// See _The Art of Computer Programming_ volume 2 by Donald Knuth, Section 4.3.1: The Classical Algorithms
|
||||
private static func _findQhat(
|
||||
high: UInt,
|
||||
low: UInt.Magnitude,
|
||||
divisor: UInt,
|
||||
nextVdigit: UInt,
|
||||
nextUdigit: UInt
|
||||
) -> UInt {
|
||||
var qhat: Array<UInt>
|
||||
var rhat: Array<UInt>
|
||||
if high >= divisor {
|
||||
let v = divisor
|
||||
let u = [low, high]
|
||||
var r: UInt = 0
|
||||
qhat = Words(repeating: 0, count: 2)
|
||||
for j in (0...1).reversed() {
|
||||
let uj = u[j]
|
||||
(qhat[j], r) = v.dividingFullWidth((r, uj))
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: &qhat)
|
||||
rhat = [r]
|
||||
} else {
|
||||
let (qhatWord, rhatWord) = divisor.dividingFullWidth((high, low))
|
||||
qhat = [qhatWord]
|
||||
rhat = [rhatWord]
|
||||
}
|
||||
|
||||
repeat {
|
||||
var qhatTooLarge = false
|
||||
|
||||
if qhat.count > 1 {
|
||||
qhatTooLarge = true
|
||||
} else {
|
||||
// All of the following is computing and checking qhat*v_n-2 > rhat*b + u_j+n-2
|
||||
// from TAoCP Volume 2 Section 4.3.1, Algorithm D, step D3
|
||||
let (comp_lhs_hi, comp_lhs_lo) = qhat[0].multipliedFullWidth(by: nextVdigit)
|
||||
|
||||
if comp_lhs_hi > rhat[0] {
|
||||
qhatTooLarge = true
|
||||
} else if comp_lhs_hi == rhat[0] && comp_lhs_lo > nextUdigit {
|
||||
qhatTooLarge = true
|
||||
}
|
||||
}
|
||||
|
||||
// high >= divisor is standing in for the test qhat >= b from Algorithm D step D3
|
||||
if qhatTooLarge {
|
||||
// begin qhat -= 1
|
||||
if qhat.count == 1 {
|
||||
qhat[0] -= 1
|
||||
} else {
|
||||
let (qlow, underflow) = qhat[0].subtractingReportingOverflow(1)
|
||||
qhat[0] = qlow
|
||||
if qhat[1] > 0 && underflow {
|
||||
qhat[1] -= 1
|
||||
if qhat[1] == 0 {
|
||||
qhat.remove(at: 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
// end qhat -= 1
|
||||
|
||||
// begin rhat += divisor
|
||||
let (rhatResult, overflow) : (UInt, Bool)
|
||||
if rhat.count == 1 || rhat[1] == 0 {
|
||||
(rhatResult, overflow) = rhat[0].addingReportingOverflow(divisor)
|
||||
rhat[0] = rhatResult
|
||||
if overflow {
|
||||
rhat.append(1)
|
||||
}
|
||||
} // we don't need an else because rhat is already larger than BigInt._digitRadix
|
||||
// end rhat += divisor
|
||||
} else {
|
||||
break
|
||||
}
|
||||
} while rhat.count == 1 // equivalent to rhat < b
|
||||
|
||||
return qhat[0]
|
||||
}
|
||||
|
||||
/// See _The Art of Computer Programming_ volume 2 by Donald Knuth, Section 4.3.1: The Classical Algorithms
|
||||
@usableFromInline
|
||||
internal static func _div(lhs: BigInt, rhs: BigInt) -> (quotient: BigInt, remainder: BigInt) {
|
||||
precondition(rhs != _digits[0], "Division by zero error!")
|
||||
|
||||
if lhs.words.count == 1, rhs.words.count == 1 {
|
||||
let (quot, rem) = Int(bitPattern: lhs.words[0]).quotientAndRemainder(dividingBy: Int(bitPattern: rhs.words[0]))
|
||||
return (BigInt(_uncheckedWords: [UInt(bitPattern: quot)]), BigInt(_uncheckedWords: [UInt(bitPattern: rem)]))
|
||||
}
|
||||
|
||||
let lhsIsNeg = lhs._isNegative
|
||||
let rhsIsNeg = rhs._isNegative
|
||||
|
||||
var lhsWords = lhsIsNeg ? (-lhs).words : lhs.words
|
||||
var rhsWords = rhsIsNeg ? (-rhs).words : rhs.words
|
||||
|
||||
// See the answer to exercise 16 in Section 4.3.1 of TAOCP
|
||||
if rhsWords.count == 1 || (rhsWords.count == 2 && rhsWords[1] == 0) {
|
||||
let v = rhsWords[0]
|
||||
let u = lhsWords
|
||||
var r: UInt = 0
|
||||
var quot = Words(repeating: 0, count: u.count)
|
||||
for j in (0...(u.count - 1)).reversed() {
|
||||
let uj = u[j]
|
||||
(quot[j], r) = v.dividingFullWidth((r, uj))
|
||||
}
|
||||
|
||||
if quot[u.count - 1] > UInt(Int.max) {
|
||||
quot.append(0)
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: ")
|
||||
return (quotient: BigInt(_uncheckedWords: quot), remainder: BigInt(r))
|
||||
}
|
||||
|
||||
while rhsWords[rhsWords.endIndex - 1] == 0 {
|
||||
rhsWords.removeLast()
|
||||
}
|
||||
|
||||
if rhsWords.count > lhsWords.count { return (0, lhs) }
|
||||
|
||||
if lhsWords.count <= rhsWords.count {
|
||||
for _ in 0 ... (rhsWords.count - lhsWords.count) {
|
||||
lhsWords.append(0)
|
||||
}
|
||||
}
|
||||
|
||||
let m = lhsWords.count - rhsWords.count
|
||||
let n = rhsWords.count
|
||||
|
||||
let bitWidth = UInt(UInt.bitWidth)
|
||||
|
||||
let s = UInt(rhsWords[n - 1].leadingZeroBitCount)
|
||||
let rn = UnsafeMutablePointer<UInt>.allocate(capacity: n)
|
||||
rn.initialize(repeating: 0, count: n)
|
||||
defer { rn.deallocate() }
|
||||
for i in (1 ... (n - 1)).reversed() {
|
||||
rn[i] = (rhsWords[i] << s) | (rhsWords[i - 1] >> (bitWidth - s))
|
||||
}
|
||||
rn[0] = rhsWords[0] << s
|
||||
|
||||
let ln = UnsafeMutablePointer<UInt>.allocate(capacity: m + n + 1)
|
||||
ln.initialize(repeating: 0, count: m + n + 1)
|
||||
defer { ln.deallocate() }
|
||||
ln[m + n] = lhsWords[m + n - 1] >> (bitWidth - s)
|
||||
for i in (1 ... (m + n - 1)).reversed() {
|
||||
ln[i] = (lhsWords[i] << s) | (lhsWords[i - 1] >> (bitWidth - s))
|
||||
}
|
||||
ln[0] = lhsWords[0] << s
|
||||
|
||||
let resultSize = m + 1
|
||||
var quot = Words(repeating: 0, count: resultSize)
|
||||
|
||||
for j in (0 ... m).reversed() {
|
||||
let qhat = _findQhat(
|
||||
high: ln[j + n],
|
||||
low: UInt.Magnitude(ln[j + n - 1]),
|
||||
divisor: rn[n - 1],
|
||||
nextVdigit: rn[n - 2],
|
||||
nextUdigit: ln[j + n - 2])
|
||||
|
||||
var carry: UInt = 0
|
||||
var isOverflow = false
|
||||
var borrow: UInt = 0
|
||||
var underflow = false
|
||||
for i in 0 ..< n {
|
||||
if borrow > 0 {
|
||||
(ln[i + j], underflow) = ln[i + j].subtractingReportingOverflow(borrow)
|
||||
borrow = underflow ? 1 : 0
|
||||
}
|
||||
|
||||
var (pHigh, pLow) = qhat.multipliedFullWidth(by: rn[i])
|
||||
(pLow, isOverflow) = pLow.addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
pHigh += 1
|
||||
}
|
||||
|
||||
(ln[i + j], underflow) = ln[i + j].subtractingReportingOverflow(pLow)
|
||||
if underflow {
|
||||
borrow += 1
|
||||
}
|
||||
|
||||
carry = pHigh
|
||||
}
|
||||
|
||||
(ln[j + n], underflow) = ln[j + n].subtractingReportingOverflow(carry + borrow)
|
||||
|
||||
if underflow {
|
||||
let newQhat = qhat - 1
|
||||
|
||||
carry = 0
|
||||
var total: UInt = 0
|
||||
for i in 0 ..< n {
|
||||
(total, isOverflow) = ln[i + j].addingReportingOverflow(carry)
|
||||
carry = isOverflow ? 1 : 0
|
||||
(ln[i + j], isOverflow) = total.addingReportingOverflow(rn[i])
|
||||
if carry == 0 { carry = isOverflow ? 1 : 0 }
|
||||
}
|
||||
(ln[j + n], _) = ln[j + n].addingReportingOverflow(carry)
|
||||
|
||||
quot[j] = newQhat
|
||||
} else {
|
||||
quot[j] = qhat
|
||||
}
|
||||
}
|
||||
|
||||
var rem = Words(repeating: 0, count: n)
|
||||
|
||||
for i in 0 ..< (n - 1) {
|
||||
rem[i] = (ln[i] >> s) | ln[i + 1] << (bitWidth - s)
|
||||
}
|
||||
rem[n - 1] = ln[n - 1] >> s
|
||||
|
||||
if rem[n - 1] > UInt(Int.max) {
|
||||
rem.append(0)
|
||||
}
|
||||
|
||||
BigInt._dropExcessWords(words: ")
|
||||
BigInt._dropExcessWords(words: &rem)
|
||||
|
||||
return (BigInt(_uncheckedWords: quot), BigInt(_uncheckedWords: rem))
|
||||
}
|
||||
|
||||
private static func _signExtend(lhsWords: inout Words, rhsWords: inout Words) {
|
||||
let lhsIsNeg = (lhsWords.last ?? 0) >> (UInt.bitWidth - Int(1)) == 1
|
||||
let rhsIsNeg = (rhsWords.last ?? 0) >> (UInt.bitWidth - Int(1)) == 1
|
||||
|
||||
if lhsWords.count > rhsWords.count {
|
||||
for _ in 0 ..< (lhsWords.count - rhsWords.count) {
|
||||
rhsIsNeg ? rhsWords.append(UInt.max) : rhsWords.append(0)
|
||||
}
|
||||
} else if rhsWords.count > lhsWords.count {
|
||||
for _ in 0 ..< (rhsWords.count - lhsWords.count) {
|
||||
lhsIsNeg ? lhsWords.append(UInt.max) : lhsWords.append(0)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@usableFromInline
|
||||
internal static func _dropExcessWords(words: inout Words) {
|
||||
while words.count > 1, words[words.endIndex - 1] == 0 {
|
||||
if words[words.endIndex - 2] <= Int.max {
|
||||
words.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
while words.count > 1, words[words.endIndex - 1] == UInt.max {
|
||||
if words[words.endIndex - 2] > Int.max {
|
||||
words.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,751 +0,0 @@
|
||||
//===--- BigUInt.swift ----------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2020 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
public struct BigUInt: UnsignedInteger {
|
||||
|
||||
public typealias Words = [UInt]
|
||||
|
||||
public private(set) var words: Words
|
||||
|
||||
@usableFromInline
|
||||
internal init(_uncheckedWords: Words) {
|
||||
self.words = _uncheckedWords
|
||||
}
|
||||
|
||||
public init<T>(bitPattern source: T) where T: BinaryInteger {
|
||||
words = Words(source.words)
|
||||
BigUInt._dropExcessWords(words: &words)
|
||||
}
|
||||
|
||||
@usableFromInline
|
||||
internal var _isNegative: Bool {
|
||||
words[words.endIndex - 1] > Int.max
|
||||
}
|
||||
|
||||
private static let _digits: [BigUInt] = (0 ... 36).map {
|
||||
BigUInt(_uncheckedWords: [UInt(bitPattern: $0)])
|
||||
}
|
||||
|
||||
private static let _digitRadix = BigInt(_uncheckedWords: [0, 1])
|
||||
}
|
||||
|
||||
// MARK: - Basic Behaviors
|
||||
|
||||
extension BigUInt: Equatable {
|
||||
|
||||
@inlinable
|
||||
public static func == (lhs: BigUInt, rhs: BigUInt) -> Bool {
|
||||
lhs.words == rhs.words
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func != (lhs: BigUInt, rhs: BigUInt) -> Bool {
|
||||
!(lhs == rhs)
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: Hashable {
|
||||
|
||||
@inlinable
|
||||
public func hash(into hasher: inout Hasher) {
|
||||
hasher.combine(words)
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: Comparable {
|
||||
|
||||
@inlinable
|
||||
public static func < (lhs: BigUInt, rhs: BigUInt) -> Bool {
|
||||
let lhsNegative = lhs._isNegative
|
||||
let rhsNegative = rhs._isNegative
|
||||
|
||||
if lhsNegative && !rhsNegative { return true }
|
||||
if rhsNegative && !lhsNegative { return false }
|
||||
|
||||
if (lhsNegative && rhsNegative) || (!lhsNegative && !rhsNegative) {
|
||||
if lhs.words.count > rhs.words.count {
|
||||
return lhsNegative ? true : false
|
||||
}
|
||||
if lhs.words.count < rhs.words.count {
|
||||
return lhsNegative ? false : true
|
||||
}
|
||||
|
||||
for i in stride(from: lhs.words.count - 1, through: 0, by: -1) {
|
||||
if lhs.words[i] > rhs.words[i] {
|
||||
return false
|
||||
} else if lhs.words[i] < rhs.words[i] {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: LosslessStringConvertible {
|
||||
|
||||
public init?(_ description: String) {
|
||||
self.init(description, radix: 10)
|
||||
}
|
||||
|
||||
public init?<T>(_ description: T, radix: Int = 10) where T: StringProtocol {
|
||||
precondition(2 ... 36 ~= radix, "Radix not in range 2 ... 36")
|
||||
|
||||
self = 0
|
||||
|
||||
let hasPrefix = description.hasPrefix("+")
|
||||
let utf8 = description.utf8.dropFirst(hasPrefix ? 1 : 0)
|
||||
guard !utf8.isEmpty else { return nil }
|
||||
|
||||
for var byte in utf8 {
|
||||
switch byte {
|
||||
case UInt8(ascii: "0") ... UInt8(ascii: "9"):
|
||||
byte -= UInt8(ascii: "0")
|
||||
case UInt8(ascii: "A") ... UInt8(ascii: "Z"):
|
||||
byte -= UInt8(ascii: "A")
|
||||
byte += 10
|
||||
case UInt8(ascii: "a") ... UInt8(ascii: "z"):
|
||||
byte -= UInt8(ascii: "a")
|
||||
byte += 10
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
guard byte < radix else { return nil }
|
||||
self *= BigUInt._digits[radix]
|
||||
self += BigUInt._digits[Int(byte)]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: Decodable {
|
||||
|
||||
public init(from decoder: Decoder) throws {
|
||||
let singleValueContainer = try decoder.singleValueContainer()
|
||||
let description = try singleValueContainer.decode(String.self)
|
||||
guard let result = BigUInt(description) else {
|
||||
throw DecodingError.dataCorruptedError(
|
||||
in: singleValueContainer,
|
||||
debugDescription: "BigUInt(\(description.debugDescription)) failed")
|
||||
}
|
||||
self = result
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: Encodable {
|
||||
|
||||
public func encode(to encoder: Encoder) throws {
|
||||
var singleValueContainer = encoder.singleValueContainer()
|
||||
try singleValueContainer.encode(description)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Numeric Protocols
|
||||
|
||||
extension BigUInt: ExpressibleByIntegerLiteral {
|
||||
|
||||
public init(integerLiteral value: Int) {
|
||||
if value < BigUInt._digits.count {
|
||||
self = BigUInt._digits[value]
|
||||
} else {
|
||||
words = [UInt(bitPattern: value)]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: AdditiveArithmetic {
|
||||
|
||||
@inlinable
|
||||
public static func + (lhs: BigUInt, rhs: BigUInt) -> BigUInt {
|
||||
var result = lhs
|
||||
result += rhs
|
||||
return result
|
||||
}
|
||||
|
||||
public static func += (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
if lhs.words.count == 1, rhs.words.count == 1 {
|
||||
let lhsWord = lhs.words[0]
|
||||
let rhsWord = rhs.words[0]
|
||||
|
||||
let (result, isOverflow) = lhsWord.addingReportingOverflow(rhsWord)
|
||||
|
||||
if !isOverflow && result < Int.max {
|
||||
lhs.words[0] = result
|
||||
return
|
||||
}
|
||||
let knownNegativeResult = lhsWord > Int.max && rhsWord > Int.max
|
||||
|
||||
if lhsWord > Int.max || rhsWord > Int.max, !knownNegativeResult {
|
||||
// positive + negative is always smaller, so overflow is a red herring
|
||||
lhs.words[0] = result
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
var isOverflow = false
|
||||
|
||||
var rhsWords = rhs.words
|
||||
|
||||
lhs.words.append(0)
|
||||
rhsWords.append(0)
|
||||
BigUInt._zeroExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
var temp: UInt = 0
|
||||
for index in 0 ..< lhs.words.count {
|
||||
var carryOverflow = false
|
||||
|
||||
if isOverflow {
|
||||
(temp, carryOverflow) = rhsWords[index].addingReportingOverflow(1)
|
||||
} else {
|
||||
temp = rhsWords[index]
|
||||
}
|
||||
|
||||
(lhs.words[index], isOverflow) = lhs.words[index].addingReportingOverflow(temp)
|
||||
|
||||
isOverflow = carryOverflow || isOverflow
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func - (lhs: BigUInt, rhs: BigUInt) -> BigUInt {
|
||||
var result = lhs
|
||||
result -= rhs
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func -= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
lhs = .init(_uncheckedWords: (BigInt(_uncheckedWords: lhs.words) + -BigInt(_uncheckedWords: rhs.words)).words)
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: Numeric {
|
||||
|
||||
public init?<T>(exactly source: T) where T: BinaryInteger {
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public var magnitude: BigUInt { self }
|
||||
|
||||
public static func * (lhs: BigUInt, rhs: BigUInt) -> BigUInt {
|
||||
let lhsWords = lhs.words
|
||||
let rhsWords = rhs.words
|
||||
|
||||
let count = lhsWords.count + rhsWords.count + 1
|
||||
var newWords = Words(repeating: 0, count: count)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
var carry: UInt = 0
|
||||
var digit: UInt = 0
|
||||
|
||||
var lastJ: Int = 0
|
||||
for j in i ..< (lhsWords.count + i) {
|
||||
var (high, low) = rhsWords[i].multipliedFullWidth(by: lhsWords[j - i])
|
||||
var isOverflow: Bool
|
||||
(digit, isOverflow) = low.addingReportingOverflow(newWords[j])
|
||||
if isOverflow {
|
||||
high += 1
|
||||
}
|
||||
|
||||
(digit, isOverflow) = digit.addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
high += 1
|
||||
}
|
||||
|
||||
carry = high
|
||||
newWords[j] = digit
|
||||
lastJ = j
|
||||
}
|
||||
|
||||
if carry != 0 {
|
||||
let isOverflow: Bool
|
||||
(digit, isOverflow) = newWords[lastJ + 1].addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
carry = 1
|
||||
}
|
||||
newWords[lastJ + 1] = digit
|
||||
}
|
||||
}
|
||||
|
||||
for i in stride(from: count - 1, through: 1, by: -1) {
|
||||
if newWords[i] == 0, newWords[i - 1] <= Int.max {
|
||||
newWords.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return BigUInt(_uncheckedWords: newWords)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func *= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
lhs = lhs * rhs
|
||||
}
|
||||
}
|
||||
|
||||
extension BigUInt: BinaryInteger {
|
||||
|
||||
public init?<T>(exactly source: T) where T: BinaryFloatingPoint {
|
||||
guard source.isFinite, source == source.rounded(.towardZero) else {
|
||||
return nil
|
||||
}
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public init<T>(_ source: T) where T: BinaryFloatingPoint {
|
||||
precondition(
|
||||
source.isFinite && source >= 0.0,
|
||||
"""
|
||||
\(type(of: source)) value cannot be converted to BigUInt because it is \
|
||||
either infinite, NaN, or negative
|
||||
""")
|
||||
|
||||
var float = source
|
||||
|
||||
if let _ = UInt(exactly: T.greatestFiniteMagnitude) {
|
||||
words = [UInt(float)]
|
||||
} else {
|
||||
var words = Words()
|
||||
let radix = T(sign: .plus, exponent: T.Exponent(UInt.bitWidth), significand: 1)
|
||||
repeat {
|
||||
let digit = UInt(float.truncatingRemainder(dividingBy: radix))
|
||||
words.append(digit)
|
||||
float = (float / radix).rounded(.towardZero)
|
||||
} while float != 0
|
||||
|
||||
if let last = words.last, last >= Int.max {
|
||||
words.append(0)
|
||||
}
|
||||
self.words = words
|
||||
}
|
||||
}
|
||||
|
||||
public init<T>(_ source: T) where T: BinaryInteger {
|
||||
if source >= 0, source < BigUInt._digits.count {
|
||||
self = BigUInt._digits[Int(source)]
|
||||
} else {
|
||||
words = Words(source.words)
|
||||
if source > 0 && source.words[source.words.endIndex - 1] > Int.max {
|
||||
words.append(0)
|
||||
}
|
||||
// needed to handle sign-extended multi-word numbers that
|
||||
// actually fit in a single word
|
||||
BigUInt._dropExcessWords(words: &words)
|
||||
}
|
||||
}
|
||||
|
||||
public init<T>(clamping source: T) where T: BinaryInteger {
|
||||
self.init(source)
|
||||
}
|
||||
|
||||
public init<T>(truncatingIfNeeded source: T) where T: BinaryInteger {
|
||||
words = Words(source.words)
|
||||
}
|
||||
|
||||
public var bitWidth: Int { words.count * UInt.bitWidth }
|
||||
|
||||
public var trailingZeroBitCount: Int {
|
||||
var totalZeros = 0
|
||||
for word in words {
|
||||
if word == 0 {
|
||||
totalZeros += UInt.bitWidth
|
||||
} else {
|
||||
totalZeros += word.trailingZeroBitCount
|
||||
break
|
||||
}
|
||||
}
|
||||
return totalZeros
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func / (lhs: BigUInt, rhs: BigUInt) -> BigUInt {
|
||||
let (result, _) = _div(lhs: lhs, rhs: rhs)
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func /= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
lhs = lhs / rhs
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func % (lhs: BigUInt, rhs: BigUInt) -> BigUInt {
|
||||
let (_, result) = _div(lhs: lhs, rhs: rhs)
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static func %= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
lhs = lhs % rhs
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public static prefix func ~ (x: BigUInt) -> BigUInt {
|
||||
let newWords = x.words.map { ~$0 }
|
||||
return BigUInt(_uncheckedWords: Words(newWords))
|
||||
}
|
||||
|
||||
public static func &= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigUInt._zeroExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] &= rhsWords[i]
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func |= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigUInt._zeroExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] |= rhsWords[i]
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func ^= (lhs: inout BigUInt, rhs: BigUInt) {
|
||||
var rhsWords = rhs.words
|
||||
BigUInt._zeroExtend(lhsWords: &lhs.words, rhsWords: &rhsWords)
|
||||
|
||||
for i in 0 ..< rhsWords.count {
|
||||
lhs.words[i] &= rhsWords[i]
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func <<= <RHS>(lhs: inout BigUInt, rhs: RHS) where RHS: BinaryInteger {
|
||||
if rhs.signum() < 0 {
|
||||
lhs >>= rhs.magnitude
|
||||
return
|
||||
}
|
||||
|
||||
let wordLength = UInt.bitWidth
|
||||
|
||||
let (fullWords, remainder) = rhs.quotientAndRemainder(dividingBy: RHS(wordLength))
|
||||
lhs.words = Words(repeating: 0, count: Int(fullWords)) + lhs.words + [0]
|
||||
|
||||
if remainder > 0 {
|
||||
var value: UInt = 0
|
||||
for i in 0 ..< lhs.words.count {
|
||||
let temp = lhs.words[i] >> (wordLength - Int(remainder))
|
||||
lhs.words[i] <<= Int(remainder)
|
||||
if i > 0 {
|
||||
lhs.words[i] &= UInt.max << Int(remainder)
|
||||
lhs.words[i] |= value
|
||||
}
|
||||
|
||||
value = temp
|
||||
}
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
public static func >>= <RHS>(lhs: inout BigUInt, rhs: RHS) where RHS: BinaryInteger {
|
||||
if rhs.signum() < 0 {
|
||||
lhs <<= rhs.magnitude
|
||||
return
|
||||
}
|
||||
|
||||
let wordLength = UInt.bitWidth
|
||||
|
||||
let (fullWords, remainder) = rhs.quotientAndRemainder(dividingBy: RHS(wordLength))
|
||||
if fullWords < lhs.words.count {
|
||||
lhs.words.removeFirst(Int(fullWords))
|
||||
} else {
|
||||
lhs = 0
|
||||
return
|
||||
}
|
||||
|
||||
if remainder > 0 {
|
||||
let mask = ~(UInt.max << remainder)
|
||||
var value: UInt = 0
|
||||
for i in stride(from: lhs.words.count - 1, through: 0, by: -1) {
|
||||
let temp = lhs.words[i] & mask
|
||||
lhs.words[i] >>= remainder
|
||||
lhs.words[i] |= (value << (UInt.bitWidth - Int(remainder)))
|
||||
value = temp
|
||||
}
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &lhs.words)
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public func quotientAndRemainder(dividingBy rhs: BigUInt) -> (quotient: BigUInt, remainder: BigUInt) {
|
||||
return BigUInt._div(lhs: self, rhs: rhs)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: -
|
||||
|
||||
extension BigUInt {
|
||||
|
||||
/// See _The Art of Computer Programming_ volume 2 by Donald Knuth, Section 4.3.1: The Classical Algorithms
|
||||
private static func _findQhat(
|
||||
high: UInt,
|
||||
low: UInt.Magnitude,
|
||||
divisor: UInt,
|
||||
nextVdigit: UInt,
|
||||
nextUdigit: UInt
|
||||
) -> UInt {
|
||||
var qhat: Array<UInt>
|
||||
var rhat: Array<UInt>
|
||||
if high >= divisor {
|
||||
let v = divisor
|
||||
let u = [low, high]
|
||||
var r: UInt = 0
|
||||
qhat = Words(repeating: 0, count: 2)
|
||||
for j in (0...1).reversed() {
|
||||
let uj = u[j]
|
||||
(qhat[j], r) = v.dividingFullWidth((r, uj))
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: &qhat)
|
||||
rhat = [r]
|
||||
} else {
|
||||
let (qhatWord, rhatWord) = divisor.dividingFullWidth((high, low))
|
||||
qhat = [qhatWord]
|
||||
rhat = [rhatWord]
|
||||
}
|
||||
|
||||
repeat {
|
||||
var qhatTooLarge = false
|
||||
|
||||
if qhat.count > 1 {
|
||||
qhatTooLarge = true
|
||||
} else {
|
||||
// All of the following is computing and checking qhat*v_n-2 > rhat*b + u_j+n-2
|
||||
// from TAoCP Volume 2 Section 4.3.1, Algorithm D, step D3
|
||||
let (comp_lhs_hi, comp_lhs_lo) = qhat[0].multipliedFullWidth(by: nextVdigit)
|
||||
|
||||
if comp_lhs_hi > rhat[0] {
|
||||
qhatTooLarge = true
|
||||
} else if comp_lhs_hi == rhat[0] && comp_lhs_lo > nextUdigit {
|
||||
qhatTooLarge = true
|
||||
}
|
||||
}
|
||||
|
||||
// high >= divisor is standing in for the test qhat >= b from Algorithm D step D3
|
||||
if qhatTooLarge {
|
||||
// begin qhat -= 1
|
||||
if qhat.count == 1 {
|
||||
qhat[0] -= 1
|
||||
} else {
|
||||
let (qlow, underflow) = qhat[0].subtractingReportingOverflow(1)
|
||||
qhat[0] = qlow
|
||||
if qhat[1] > 0 && underflow {
|
||||
qhat[1] -= 1
|
||||
if qhat[1] == 0 {
|
||||
qhat.remove(at: 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
// end qhat -= 1
|
||||
|
||||
// begin rhat += divisor
|
||||
let (rhatResult, overflow) : (UInt, Bool)
|
||||
if rhat.count == 1 || rhat[1] == 0 {
|
||||
(rhatResult, overflow) = rhat[0].addingReportingOverflow(divisor)
|
||||
rhat[0] = rhatResult
|
||||
if overflow {
|
||||
rhat.append(1)
|
||||
}
|
||||
} // we don't need an else because rhat is already larger than BigInt._digitRadix
|
||||
// end rhat += divisor
|
||||
} else {
|
||||
break
|
||||
}
|
||||
} while rhat.count == 1 // equivalent to rhat < b
|
||||
|
||||
return qhat[0]
|
||||
}
|
||||
|
||||
/// See _The Art of Computer Programming_ volume 2 by Donald Knuth, Section 4.3.1: The Classical Algorithms
|
||||
@usableFromInline
|
||||
internal static func _div(lhs: BigUInt, rhs: BigUInt) -> (quotient: BigUInt, remainder: BigUInt) {
|
||||
precondition(rhs != _digits[0], "Division by zero error!")
|
||||
|
||||
if lhs.words.count == 1, rhs.words.count == 1 {
|
||||
let (quot, rem) = Int(bitPattern: lhs.words[0]).quotientAndRemainder(dividingBy: Int(bitPattern: rhs.words[0]))
|
||||
return (BigUInt(_uncheckedWords: [UInt(bitPattern: quot)]), BigUInt(_uncheckedWords: [UInt(bitPattern: rem)]))
|
||||
}
|
||||
|
||||
var lhsWords = lhs.words
|
||||
var rhsWords = rhs.words
|
||||
|
||||
// See the answer to exercise 16 in Section 4.3.1 of TAOCP
|
||||
if rhsWords.count == 1 || (rhsWords.count == 2 && rhsWords[1] == 0) {
|
||||
let v = rhsWords[0]
|
||||
let u = lhsWords
|
||||
var r: UInt = 0
|
||||
var quot = Words(repeating: 0, count: u.count)
|
||||
for j in (0...(u.count - 1)).reversed() {
|
||||
let uj = u[j]
|
||||
(quot[j], r) = v.dividingFullWidth((r, uj))
|
||||
}
|
||||
|
||||
if quot[u.count - 1] > UInt(Int.max) {
|
||||
quot.append(0)
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: ")
|
||||
return (quotient: BigUInt(_uncheckedWords: quot), remainder: BigUInt(r))
|
||||
}
|
||||
|
||||
while rhsWords[rhsWords.endIndex - 1] == 0 {
|
||||
rhsWords.removeLast()
|
||||
}
|
||||
|
||||
if rhsWords.count > lhsWords.count { return (0, lhs) }
|
||||
|
||||
if lhsWords.count <= rhsWords.count {
|
||||
for _ in 0 ... (rhsWords.count - lhsWords.count) {
|
||||
lhsWords.append(0)
|
||||
}
|
||||
}
|
||||
|
||||
let m = lhsWords.count - rhsWords.count
|
||||
let n = rhsWords.count
|
||||
|
||||
let bitWidth = UInt(UInt.bitWidth)
|
||||
|
||||
let s = UInt(rhsWords[n - 1].leadingZeroBitCount)
|
||||
let rn = UnsafeMutablePointer<UInt>.allocate(capacity: n)
|
||||
rn.initialize(repeating: 0, count: n)
|
||||
defer { rn.deallocate() }
|
||||
for i in (1 ... (n - 1)).reversed() {
|
||||
rn[i] = (rhsWords[i] << s) | (rhsWords[i - 1] >> (bitWidth - s))
|
||||
}
|
||||
rn[0] = rhsWords[0] << s
|
||||
|
||||
let ln = UnsafeMutablePointer<UInt>.allocate(capacity: m + n + 1)
|
||||
ln.initialize(repeating: 0, count: m + n + 1)
|
||||
defer { ln.deallocate() }
|
||||
ln[m + n] = lhsWords[m + n - 1] >> (bitWidth - s)
|
||||
for i in (1 ... (m + n - 1)).reversed() {
|
||||
ln[i] = (lhsWords[i] << s) | (lhsWords[i - 1] >> (bitWidth - s))
|
||||
}
|
||||
ln[0] = lhsWords[0] << s
|
||||
|
||||
let resultSize = m + 1
|
||||
var quot = Words(repeating: 0, count: resultSize)
|
||||
|
||||
for j in (0 ... m).reversed() {
|
||||
let qhat = _findQhat(
|
||||
high: ln[j + n],
|
||||
low: UInt.Magnitude(ln[j + n - 1]),
|
||||
divisor: rn[n - 1],
|
||||
nextVdigit: rn[n - 2],
|
||||
nextUdigit: ln[j + n - 2])
|
||||
|
||||
var carry: UInt = 0
|
||||
var isOverflow = false
|
||||
var borrow: UInt = 0
|
||||
var underflow = false
|
||||
for i in 0 ..< n {
|
||||
if borrow > 0 {
|
||||
(ln[i + j], underflow) = ln[i + j].subtractingReportingOverflow(borrow)
|
||||
borrow = underflow ? 1 : 0
|
||||
}
|
||||
|
||||
var (pHigh, pLow) = qhat.multipliedFullWidth(by: rn[i])
|
||||
(pLow, isOverflow) = pLow.addingReportingOverflow(carry)
|
||||
if isOverflow {
|
||||
pHigh += 1
|
||||
}
|
||||
|
||||
(ln[i + j], underflow) = ln[i + j].subtractingReportingOverflow(pLow)
|
||||
if underflow {
|
||||
borrow += 1
|
||||
}
|
||||
|
||||
carry = pHigh
|
||||
}
|
||||
|
||||
(ln[j + n], underflow) = ln[j + n].subtractingReportingOverflow(carry + borrow)
|
||||
|
||||
if underflow {
|
||||
let newQhat = qhat - 1
|
||||
|
||||
carry = 0
|
||||
var total: UInt = 0
|
||||
for i in 0 ..< n {
|
||||
(total, isOverflow) = ln[i + j].addingReportingOverflow(carry)
|
||||
carry = isOverflow ? 1 : 0
|
||||
(ln[i + j], isOverflow) = total.addingReportingOverflow(rn[i])
|
||||
if carry == 0 { carry = isOverflow ? 1 : 0 }
|
||||
}
|
||||
(ln[j + n], _) = ln[j + n].addingReportingOverflow(carry)
|
||||
|
||||
quot[j] = newQhat
|
||||
} else {
|
||||
quot[j] = qhat
|
||||
}
|
||||
}
|
||||
|
||||
var rem = Words(repeating: 0, count: n)
|
||||
|
||||
for i in 0 ..< (n - 1) {
|
||||
rem[i] = (ln[i] >> s) | ln[i + 1] << (bitWidth - s)
|
||||
}
|
||||
rem[n - 1] = ln[n - 1] >> s
|
||||
|
||||
if rem[n - 1] > UInt(Int.max) {
|
||||
rem.append(0)
|
||||
}
|
||||
|
||||
BigUInt._dropExcessWords(words: ")
|
||||
BigUInt._dropExcessWords(words: &rem)
|
||||
|
||||
return (BigUInt(_uncheckedWords: quot), BigUInt(_uncheckedWords: rem))
|
||||
}
|
||||
|
||||
private static func _zeroExtend(lhsWords: inout Words, rhsWords: inout Words) {
|
||||
if lhsWords.count > rhsWords.count {
|
||||
for _ in 0 ..< (lhsWords.count - rhsWords.count) {
|
||||
rhsWords.append(0)
|
||||
}
|
||||
} else if rhsWords.count > lhsWords.count {
|
||||
for _ in 0 ..< (rhsWords.count - lhsWords.count) {
|
||||
lhsWords.append(0)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@usableFromInline
|
||||
internal static func _dropExcessWords(words: inout Words) {
|
||||
while words.count > 1, words[words.endIndex - 1] == 0 {
|
||||
if words[words.endIndex - 2] <= Int.max {
|
||||
words.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
while words.count > 1, words[words.endIndex - 1] == UInt.max {
|
||||
if words[words.endIndex - 2] > Int.max {
|
||||
words.removeLast()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
#[[
|
||||
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
|
||||
#]]
|
||||
|
||||
add_library(BigIntModule
|
||||
BigInt.swift)
|
||||
set_target_properties(BigIntModule PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
|
||||
|
||||
_install_target(BigIntModule)
|
||||
set_property(GLOBAL APPEND PROPERTY SWIFT_NUMERICS_EXPORTS BigIntModule)
|
||||
@@ -1,3 +0,0 @@
|
||||
# Arbitrary-precision integers
|
||||
|
||||
This module provides a `BigInt` type.
|
||||
@@ -9,7 +9,6 @@ See https://swift.org/LICENSE.txt for license information
|
||||
|
||||
add_subdirectory(_NumericsShims)
|
||||
add_subdirectory(ComplexModule)
|
||||
add_subdirectory(IntegerUtilities)
|
||||
add_subdirectory(Numerics)
|
||||
add_subdirectory(RealModule)
|
||||
if(BUILD_TESTING)
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -14,7 +14,7 @@ import RealModule
|
||||
extension Complex: AdditiveArithmetic {
|
||||
/// The additive identity, with real and imaginary parts both zero.
|
||||
///
|
||||
/// See also: `one`, `i`, `infinity`
|
||||
/// See also: ``one``, ``i``, ``infinity``
|
||||
@_transparent
|
||||
public static var zero: Complex {
|
||||
Complex(0, 0)
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -13,6 +13,8 @@ import RealModule
|
||||
|
||||
extension Complex: AlgebraicField {
|
||||
/// The multiplicative identity `1 + 0i`.
|
||||
///
|
||||
/// See also: ``zero``, ``i``, ``infinity``
|
||||
@_transparent
|
||||
public static var one: Complex {
|
||||
Complex(1, 0)
|
||||
@@ -27,52 +29,93 @@ extension Complex: AlgebraicField {
|
||||
}
|
||||
|
||||
@_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))
|
||||
public static func /=(z: inout Complex, w: Complex) {
|
||||
z = z / w
|
||||
}
|
||||
|
||||
@_transparent
|
||||
public static func /=(z: inout Complex, w: Complex) {
|
||||
z = z / w
|
||||
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 (see below).
|
||||
let lenSq = w.lengthSquared
|
||||
guard lenSq.isNormal else { return rescaledDivide(z, w) }
|
||||
return z * w.conjugate.divided(by: lenSq)
|
||||
}
|
||||
|
||||
@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)
|
||||
if !w.isFinite { return .zero }
|
||||
// Scaling algorithm adapted from Doug Priest's "Efficient Scaling for
|
||||
// Complex Division":
|
||||
if w.magnitude < .leastNormalMagnitude {
|
||||
// A difference from Priest's algorithm is that he didn't have to worry
|
||||
// about types like Float16, where the significand width is comparable
|
||||
// to the exponent range, such that |leastNormalMagnitude|^(-¾) isn't
|
||||
// representable (e.g. for Float16 it would want to be 2¹⁸, but the
|
||||
// largest allowed exponent is 15). Note that it's critical to use zʹ/wʹ
|
||||
// after rescaling to avoid this, rather than falling through into the
|
||||
// normal rescaling, because otherwise we might end up back in the
|
||||
// situation where |w| ~ 1.
|
||||
let s = 1/(RealType(RealType.radix) * .leastNormalMagnitude)
|
||||
let wʹ = w.multiplied(by: s)
|
||||
let zʹ = z.multiplied(by: s)
|
||||
return zʹ / wʹ
|
||||
}
|
||||
// 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)
|
||||
// Having handled that case, we proceed pretty similarly to Priest:
|
||||
//
|
||||
// 1. Choose real scale s ~ |w|^(-¾), an exact power of the radix.
|
||||
// 2. wʹ ← sw
|
||||
// 3. zʹ ← sz
|
||||
// 4. return zʹ * (wʹ.conjugate / wʹ.lengthSquared) (i.e. zʹ/wʹ).
|
||||
//
|
||||
// Why is this safe and accurate? First, observe that wʹ and zʹ are both
|
||||
// computed exactly because:
|
||||
//
|
||||
// - s is an exact power of radix.
|
||||
// - wʹ ~ |w|^(¼), and hence cannot overflow or underflow.
|
||||
// - zʹ might overflow or underflow, but only if the final result also
|
||||
// overflows or underflows. (This is more subtle than I make it
|
||||
// sound. In particular, most of the fast ways one might try to
|
||||
// compute s give rise to a situation where when |w| is close to
|
||||
// one, multiplication by s is a dilation even though the actual
|
||||
// division is a contraction or vice-versa, and thus intermediate
|
||||
// computations might incorrectly overflow or underflow. Priest
|
||||
// had to take some care to avoid this situation, but we do not,
|
||||
// because we have already ruled out |w| ~ 1 before we call this
|
||||
// function.)
|
||||
//
|
||||
// Next observe that |wʹ.lengthSquared| ~ |w|^(½), so again this cannot
|
||||
// overflow or underflow, and neither can (wʹ.conjugate/wʹ.lengthSquared),
|
||||
// which has magnitude like |w|^(-¼).
|
||||
//
|
||||
// Note that because the scale factor is always a power of the radix,
|
||||
// the rescaling does not affect rounding, and so this algorithm is scale-
|
||||
// invariant compared to the mainline `/` implementation, up to the
|
||||
// underflow boundary.
|
||||
//
|
||||
// Note that our final assembly of the result is different from Priest;
|
||||
// he applies s to w twice, instead of once to w and once to z, and
|
||||
// does the product as (zw̅ʺ)*(1/|wʹ|²), while we do zʹ(w̅ʹ/|wʹ|²). We
|
||||
// prefer our version for three reasons:
|
||||
//
|
||||
// 1. it extracts a little more ILP
|
||||
// 2. it makes it so that we get exactly the same roundings on the
|
||||
// rescaled divide path as on the fast path, so that z/w = tz/tw
|
||||
// when tz and tw are computed exactly.
|
||||
// 3. it unlocks a future optimization where we hoist s and
|
||||
// (w̅ʹ/|wʹ|²) and make divisions all fast-path without perturbing
|
||||
// rounding.
|
||||
let s = RealType(
|
||||
sign: .plus,
|
||||
exponent: -3*w.magnitude.exponent/4,
|
||||
significand: 1
|
||||
)
|
||||
let wʹ = w.multiplied(by: s)
|
||||
let zʹ = z.multiplied(by: s)
|
||||
return zʹ * wʹ.conjugate.divided(by: wʹ.lengthSquared)
|
||||
}
|
||||
|
||||
/// A normalized complex number with the same phase as this value.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -12,6 +12,9 @@
|
||||
import RealModule
|
||||
|
||||
// FloatingPoint does not refine Codable, so this is a conditional conformance.
|
||||
#if compiler(>=6.0)
|
||||
@_unavailableInEmbedded
|
||||
#endif
|
||||
extension Complex: Decodable where RealType: Decodable {
|
||||
public init(from decoder: Decoder) throws {
|
||||
var unkeyedContainer = try decoder.unkeyedContainer()
|
||||
@@ -21,6 +24,9 @@ extension Complex: Decodable where RealType: Decodable {
|
||||
}
|
||||
}
|
||||
|
||||
#if compiler(>=6.0)
|
||||
@_unavailableInEmbedded
|
||||
#endif
|
||||
extension Complex: Encodable where RealType: Encodable {
|
||||
public func encode(to encoder: Encoder) throws {
|
||||
var unkeyedContainer = encoder.unkeyedContainer()
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- Complex+ElementaryFunctions.swift --------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -37,17 +37,20 @@ extension Complex: Numeric {
|
||||
self.init(real, 0)
|
||||
}
|
||||
|
||||
/// The ∞-norm of the value (`max(abs(real), abs(imaginary))`).
|
||||
/// The infinity-norm of the value (a.k.a. "maximum norm" or "Чебышёв
|
||||
/// [Chebyshev] norm").
|
||||
///
|
||||
/// If you need the Euclidean norm (a.k.a. 2-norm) use the `length` or
|
||||
/// `lengthSquared` properties instead.
|
||||
/// Equal to `max(abs(real), abs(imaginary))`.
|
||||
///
|
||||
/// Edge cases:
|
||||
/// - If `z` is not finite, `z.magnitude` is `.infinity`.
|
||||
/// - If `z` is zero, `z.magnitude` is `0`.
|
||||
/// If you need to work with the Euclidean norm (a.k.a. 2-norm) instead,
|
||||
/// use the ``length`` or ``lengthSquared`` properties. If you just need
|
||||
/// to know "how big" a number is, use this property.
|
||||
///
|
||||
/// **Edge cases:**
|
||||
///
|
||||
/// - If `z` is not finite, `z.magnitude` is infinity.
|
||||
/// - If `z` is zero, `z.magnitude` is zero.
|
||||
/// - Otherwise, `z.magnitude` is finite and non-zero.
|
||||
///
|
||||
/// See also `.length` and `.lengthSquared`.
|
||||
@_transparent
|
||||
public var magnitude: RealType {
|
||||
guard isFinite else { return .infinity }
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -16,6 +16,9 @@ extension Complex: CustomStringConvertible {
|
||||
}
|
||||
}
|
||||
|
||||
#if compiler(>=6.0)
|
||||
@_unavailableInEmbedded
|
||||
#endif
|
||||
extension Complex: CustomDebugStringConvertible {
|
||||
public var debugDescription: String {
|
||||
"Complex<\(RealType.self)>(\(String(reflecting: x)), \(String(reflecting: y)))"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -11,39 +11,8 @@
|
||||
|
||||
import RealModule
|
||||
|
||||
/// A complex number represented by real and imaginary parts.
|
||||
///
|
||||
/// TODO: introductory text on complex numbers
|
||||
///
|
||||
/// Implementation notes:
|
||||
///
|
||||
/// This type does not provide heterogeneous real/complex arithmetic,
|
||||
/// not even the natural vector-space operations like real * complex.
|
||||
/// There are two reasons for this choice: first, Swift broadly avoids
|
||||
/// mixed-type arithmetic when the operation can be adequately expressed
|
||||
/// by a conversion and homogeneous arithmetic. Second, with the current
|
||||
/// typechecker rules, it would lead to undesirable ambiguity in common
|
||||
/// expressions (see README.md for more details).
|
||||
///
|
||||
/// Unlike C's `_Complex` and C++'s `std::complex<>` types, we do not
|
||||
/// attempt to make meaningful semantic distinctions between different
|
||||
/// representations of infinity or NaN. Any Complex value with at least
|
||||
/// one non-finite component is simply "non-finite". In as much as
|
||||
/// possible, we use the semantics of the point at infinity on the
|
||||
/// Riemann sphere for such values. This approach simplifies the number of
|
||||
/// edge cases that need to be considered for multiplication, division, and
|
||||
/// the elementary functions considerably.
|
||||
///
|
||||
/// `.magnitude` does not return the Euclidean norm; it uses the "infinity
|
||||
/// norm" (`max(|real|,|imaginary|)`) instead. There are two reasons for this
|
||||
/// choice: first, it's simply faster to compute on most hardware. Second,
|
||||
/// there exist values for which the Euclidean norm cannot be represented
|
||||
/// (consider a number with `.real` and `.imaginary` both equal to
|
||||
/// `RealType.greatestFiniteMagnitude`; the Euclidean norm would be
|
||||
/// `.sqrt(2) * .greatestFiniteMagnitude`, which overflows). Using
|
||||
/// the infinity norm avoids this problem entirely without significant
|
||||
/// downsides. You can access the Euclidean norm using the `length`
|
||||
/// property.
|
||||
// A [complex number](https://en.wikipedia.org/wiki/Complex_number).
|
||||
// See Documentation.docc/Complex.md for more details.
|
||||
@frozen
|
||||
public struct Complex<RealType> where RealType: Real {
|
||||
// A note on the `x` and `y` properties
|
||||
@@ -53,11 +22,11 @@ public struct Complex<RealType> where RealType: Real {
|
||||
// `.real` and `.imaginary` properties, which wrap this storage and
|
||||
// fixup the semantics for non-finite values.
|
||||
|
||||
/// The real component of the value.
|
||||
/// The storage for the real component of the value.
|
||||
@usableFromInline @inline(__always)
|
||||
internal var x: RealType
|
||||
|
||||
/// The imaginary part of the value.
|
||||
/// The storage for the imaginary part of the value.
|
||||
@usableFromInline @inline(__always)
|
||||
internal var y: RealType
|
||||
|
||||
@@ -95,11 +64,24 @@ extension Complex {
|
||||
set { y = newValue }
|
||||
}
|
||||
|
||||
/// The raw representation of the value.
|
||||
///
|
||||
/// Use this when you need the underlying RealType values,
|
||||
/// without fixup for NaN or infinity.
|
||||
public var rawStorage: (x: RealType, y: RealType) {
|
||||
@_transparent
|
||||
get { (x, y) }
|
||||
@_transparent
|
||||
set { (x, y) = newValue }
|
||||
}
|
||||
|
||||
/// The raw representation of the real part of this value.
|
||||
@available(*, deprecated, message: "Use rawStorage")
|
||||
@_transparent
|
||||
public var _rawX: RealType { x }
|
||||
|
||||
/// The raw representation of the imaginary part of this value.
|
||||
@available(*, deprecated, message: "Use rawStorage")
|
||||
@_transparent
|
||||
public var _rawY: RealType { y }
|
||||
}
|
||||
@@ -107,7 +89,7 @@ extension Complex {
|
||||
extension Complex {
|
||||
/// The imaginary unit.
|
||||
///
|
||||
/// See also `.zero`, `.one` and `.infinity`.
|
||||
/// See also ``zero``, ``one`` and ``infinity``.
|
||||
@_transparent
|
||||
public static var i: Complex {
|
||||
Complex(0, 1)
|
||||
@@ -115,7 +97,7 @@ extension Complex {
|
||||
|
||||
/// The point at infinity.
|
||||
///
|
||||
/// See also `.zero`, `.one` and `.i`.
|
||||
/// See also ``zero``, ``one`` and ``i``.
|
||||
@_transparent
|
||||
public static var infinity: Complex {
|
||||
Complex(.infinity, 0)
|
||||
@@ -125,7 +107,7 @@ extension Complex {
|
||||
///
|
||||
/// A complex value is finite if neither component is an infinity or nan.
|
||||
///
|
||||
/// See also `.isNormal`, `.isSubnormal` and `.isZero`.
|
||||
/// See also ``isNormal``, ``isSubnormal`` and ``isZero``.
|
||||
@_transparent
|
||||
public var isFinite: Bool {
|
||||
x.isFinite && y.isFinite
|
||||
@@ -138,7 +120,7 @@ extension Complex {
|
||||
/// one of the components is normal if its exponent allows a full-precision
|
||||
/// representation.
|
||||
///
|
||||
/// See also `.isFinite`, `.isSubnormal` and `.isZero`.
|
||||
/// See also ``isFinite``, ``isSubnormal`` and ``isZero``.
|
||||
@_transparent
|
||||
public var isNormal: Bool {
|
||||
isFinite && (x.isNormal || y.isNormal)
|
||||
@@ -150,7 +132,7 @@ extension Complex {
|
||||
/// When the result of a computation is subnormal, underflow has occurred and
|
||||
/// the result generally does not have full precision.
|
||||
///
|
||||
/// See also `.isFinite`, `.isNormal` and `.isZero`.
|
||||
/// See also ``isFinite``, ``isNormal`` and ``isZero``.
|
||||
@_transparent
|
||||
public var isSubnormal: Bool {
|
||||
isFinite && !isNormal && !isZero
|
||||
@@ -161,7 +143,7 @@ extension Complex {
|
||||
/// A complex number is zero if *both* the real and imaginary components
|
||||
/// are zero.
|
||||
///
|
||||
/// See also `.isFinite`, `.isNormal` and `isSubnormal`.
|
||||
/// See also ``isFinite``, ``isNormal`` and ``isSubnormal``.
|
||||
@_transparent
|
||||
public var isZero: Bool {
|
||||
x == 0 && y == 0
|
||||
@@ -200,7 +182,7 @@ extension Complex {
|
||||
self.init(real, 0)
|
||||
}
|
||||
|
||||
/// The complex number with specified imaginary part and zero real part.
|
||||
/// The complex number with zero real part and specified imaginary part.
|
||||
///
|
||||
/// Equivalent to `Complex(0, imaginary)`.
|
||||
@inlinable
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
# ``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.
|
||||
|
||||
```swift
|
||||
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.
|
||||
|
||||
```swift
|
||||
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
|
||||
|
||||
- ``real``
|
||||
- ``imaginary``
|
||||
- ``rawStorage``
|
||||
- ``init(_:_:)``
|
||||
- ``init(_:)-5aesj``
|
||||
- ``init(imaginary:)``
|
||||
|
||||
### Phase, length and magnitude
|
||||
|
||||
- ``magnitude``
|
||||
- ``length``
|
||||
- ``lengthSquared``
|
||||
- ``normalized``
|
||||
- ``phase``
|
||||
- ``polar``
|
||||
- ``init(length:phase:)``
|
||||
|
||||
### Scaling by real numbers
|
||||
- ``multiplied(by:)``
|
||||
- ``divided(by:)``
|
||||
|
||||
### Complex-specific operations
|
||||
- ``conjugate``
|
||||
|
||||
### Classification
|
||||
- ``isZero``
|
||||
- ``isSubnormal``
|
||||
- ``isNormal``
|
||||
- ``isFinite``
|
||||
@@ -0,0 +1,88 @@
|
||||
# ``ComplexModule``
|
||||
|
||||
Types and operations for working with complex numbers.
|
||||
|
||||
## Overview
|
||||
|
||||
### Representation
|
||||
|
||||
The `Complex` type is generic over an associated `RealType`; complex numbers
|
||||
are represented as two `RealType` values, the real and imaginary parts of the
|
||||
number.
|
||||
|
||||
```
|
||||
let z = Complex<Double>(1, 2)
|
||||
let re = z.real
|
||||
let im = z.imaginary
|
||||
```
|
||||
|
||||
### Memory layout
|
||||
|
||||
A `Complex` value is stored as two `RealType` values arranged consecutively
|
||||
in memory. Thus it has the same memory layout as:
|
||||
- A Fortran complex value built on the corresponding real type (as used
|
||||
by BLAS and LAPACK).
|
||||
- A C struct with real and imaginary parts and nothing else (as used by
|
||||
computational libraries predating C99).
|
||||
- A C99 `_Complex` value built on the corresponding real type.
|
||||
- A C++ `std::complex` value built on the corresponding real type.
|
||||
Functions taking complex arguments in these other languages are not
|
||||
automatically converted on import, but you can safely write shims that
|
||||
map them into Swift types by converting pointers.
|
||||
|
||||
### Real-Complex arithmetic
|
||||
|
||||
Because the real numbers are a subset of the complex numbers, many
|
||||
languages support arithmetic with mixed real and complex operands.
|
||||
For example, C allows the following:
|
||||
|
||||
```c
|
||||
#include <complex.h>
|
||||
double r = 1;
|
||||
double complex z = CMPLX(0, 2); // 2i
|
||||
double complex w = r + z; // 1 + 2i
|
||||
```
|
||||
|
||||
The `Complex` type does not provide such mixed operators:
|
||||
|
||||
```swift
|
||||
let r = 1.0
|
||||
let z = Complex(imaginary: 2.0)
|
||||
let w = r + z // error: binary operator '+' cannot be applied to operands of type 'Double' and 'Complex<Double>'
|
||||
```
|
||||
|
||||
In order to write the example from C above in Swift, you have to perform an
|
||||
explicit conversion:
|
||||
|
||||
```swift
|
||||
let r = 1.0
|
||||
let z = Complex(imaginary: 2.0)
|
||||
let w = Complex(r) + z // OK
|
||||
```
|
||||
|
||||
There are two reasons for this choice. Most importantly, Swift generally avoids
|
||||
mixed-type arithmetic. Second, if we _did_ provide such heterogeneous operators,
|
||||
it would lead to undesirable behavior in common expressions when combined with
|
||||
literal type inference. Consider the following example:
|
||||
|
||||
```swift
|
||||
let a: Double = 1
|
||||
let b = 2*a
|
||||
```
|
||||
|
||||
`b` ought to have type `Double`, but if we did have a Complex-by-Real `*`
|
||||
operation, `2*a` would either be ambiguous (if there were no type context),
|
||||
or be inferred to have type `Complex<Double>` (if the expression appeared
|
||||
in the context of an extension defined on `Complex`).
|
||||
|
||||
Note that we _do_ provide heterogeneous multiplication and division by a real
|
||||
value, spelled as ``Complex/divided(by:)`` and ``Complex/multiplied(by:)``
|
||||
to avoid ambiguity.
|
||||
|
||||
```swift
|
||||
let z = Complex<Double>(1,3)
|
||||
let w = z.multiplied(by: 2)
|
||||
```
|
||||
|
||||
These operations are generally more efficient than converting the scale to
|
||||
a complex number and then using `*` or `/`.
|
||||
@@ -0,0 +1,55 @@
|
||||
# Zero and infinity
|
||||
|
||||
Semantics of `Complex` zero and infinity values, and important considerations
|
||||
when porting code from other languages.
|
||||
|
||||
## Overview
|
||||
|
||||
Unlike C and C++'s complex types, `Complex` does not attempt to make a
|
||||
semantic distinction between different infinity and NaN values. Any `Complex`
|
||||
datum with a non-finite component is treated as the "point at infinity" on
|
||||
the Riemann sphere--a value with infinite magnitude and unspecified phase.
|
||||
|
||||
As a consequence, all values with either component infinite or NaN compare
|
||||
equal, and hash the same. Similarly, all zero values compare equal and hash
|
||||
the same.
|
||||
|
||||
### Rationale
|
||||
|
||||
This choice has some drawbacks,¹ but also some significant advantages.
|
||||
In particular, complex multiplication is the most common operation performed
|
||||
with a complex type, and one would like to be able to use the usual naive
|
||||
arithmetic implementation, consisting of four real multiplications and two
|
||||
real additions:
|
||||
|
||||
```
|
||||
(a + bi) * (c + di) = (ac - bd) + (ad + bc)i
|
||||
```
|
||||
|
||||
`Complex` can use this implementation, because we do not differentiate between
|
||||
infinities and NaN values. C and C++, by contrast, cannot use this
|
||||
implementation by default, because, for example:
|
||||
|
||||
```
|
||||
(1 + ∞i) * (0 - 2i) = (1*0 - ∞*(-2)) + (1*(-2) + ∞*0)i
|
||||
= (0 - ∞) + (-2 + nan)i
|
||||
= -∞ + nan i
|
||||
```
|
||||
|
||||
`Complex` treats this as "infinity", which is the correct result. C and C++
|
||||
treat it as a nan value, however, which is incorrect; infinity multiplied
|
||||
by a non-zero number should be infinity. Thus, C and C++ (by default) must
|
||||
detect these special cases and fix them up, which makes multiplication a
|
||||
more computationally expensive operation.²
|
||||
|
||||
### Footnotes:
|
||||
¹ W. Kahan, Branch Cuts for Complex Elementary Functions, or Much Ado
|
||||
About Nothing's Sign Bit. In A. Iserles and M.J.D. Powell, editors,
|
||||
_Proceedings The State of Art in Numerical Analysis_, pages 165–211, 1987.
|
||||
|
||||
² This can be addressed in C programs by use of the `STDC CX_LIMITED_RANGE`
|
||||
pragma, which instructs the compiler to simply not care about these cases.
|
||||
Unfortunately, this pragma is not often used in real C or C++ programs
|
||||
(though it does see some use in _libraries_). Programmers tend to specify
|
||||
`-ffast-math` or maybe `-ffinite-math-only` instead, which has other
|
||||
undesirable consequences.
|
||||
@@ -0,0 +1,144 @@
|
||||
# Magnitude and norms
|
||||
|
||||
Introduction to the concept of norm and discussion of the `Complex` type's
|
||||
`.magnitude` property.
|
||||
|
||||
## Overview
|
||||
|
||||
In mathematics, a *norm* is a function that gives each element of a vector
|
||||
space a non-negative length.¹
|
||||
|
||||
Many different norms can be defined on the complex numbers, viewed as a
|
||||
vector space over the reals. All of these norms have some basic
|
||||
properties. If we use *‖z‖* to represent any norm of *z*, it must:
|
||||
- be *subadditive* (a.k.a. satisfy the triangle inequalty):
|
||||
‖z + w‖ ≤ ‖z‖ + ‖w‖ for any two complex numbers z and w.
|
||||
- be *homogeneous*
|
||||
‖az‖ = |a|‖z‖ for any real number a and complex number z.
|
||||
- and be *positive definite*
|
||||
‖z‖ is zero if and only if z is zero.
|
||||
|
||||
The three most commonly-used norms are:
|
||||
- 1-norm ("taxicab norm"):
|
||||
‖x + iy‖₁ = |x| + |y|
|
||||
- 2-norm ("Euclidean norm"):
|
||||
‖x + iy‖₂ = √(x² + y²)
|
||||
- ∞-norm ("maximum norm" or "Чебышёв [Chebyshev] norm")²:
|
||||
‖x + iy‖ = max(|x|,|y|)
|
||||
|
||||
> Exercise:
|
||||
> 1. Check that these properties hold for one of the three norms
|
||||
that we just defined. (Hint: write z = a+bi and w = c+di,
|
||||
and use the fact that the absolute value is a norm on the
|
||||
real numbers, and therefore has the same property).
|
||||
|
||||
The `Complex` type gives special names to two of these norms; `length`
|
||||
for the 2-norm, and `magnitude` for the ∞-norm.
|
||||
|
||||
### Magnitude:
|
||||
|
||||
The `Numeric` protocol requires us to choose a norm to call `magnitude`,
|
||||
but does not give guidance as to which one we should pick. The easiest choice
|
||||
might have been the Euclidean norm; it's the one with which people are most
|
||||
likely to be familiar.
|
||||
|
||||
However, there are good reasons to make a different choice:
|
||||
- Computing the Euclidean norm requires special care to avoid spurious
|
||||
overflow/underflow (see implementation notes for `length` below). The
|
||||
naive expressions for the taxicab and maximum norm always give the best
|
||||
answer possible.
|
||||
- Even when special care is used, the Euclidean and taxicab norms are
|
||||
not necessarily representable. Both can be infinite even for finite
|
||||
numbers.
|
||||
|
||||
```swift
|
||||
let big = Double.greatestFiniteMagnitude
|
||||
let z = Complex(big, big)
|
||||
```
|
||||
|
||||
The taxicab norm of `z` would be `big + big`, which overflows; the
|
||||
Euclidean norm would be `sqrt(2) * big`, which also overflows.
|
||||
But the maximum norm is always equal to the magnitude of either `real`
|
||||
or `imaginary`, so it is necessarily representable.
|
||||
- The ∞-norm is the choice of established computational libraries, like
|
||||
BLAS and LAPACK.
|
||||
|
||||
For these reasons, the `magnitude` property of `Complex` binds the
|
||||
maximum norm:
|
||||
|
||||
```swift
|
||||
Complex(2, 3).magnitude // 3
|
||||
Complex(-1, 0.5).magnitude // 1
|
||||
```
|
||||
|
||||
### Length:
|
||||
|
||||
The `length` property of a `Complex` value is its Euclidean norm.
|
||||
|
||||
```swift
|
||||
Complex(2, 3).length // 3.605551275463989
|
||||
Complex(-1, 0.5).length // 1.118033988749895
|
||||
```
|
||||
|
||||
Aside from familiarity, the Euclidean norm has one important property
|
||||
that the maximum norm lacks:
|
||||
- it is *multiplicative*:
|
||||
‖zw‖₂ = ‖z‖₂‖w‖₂ for any two complex numbers z and w.
|
||||
|
||||
> Exercises:
|
||||
> 1. Find z and w that show that the maximum norm is not multiplicative.
|
||||
(i.e. exhibit z and w such that ‖zw‖ ≠ ‖z‖‖w‖.)
|
||||
> 2. Is the 1-norm multiplicative?
|
||||
|
||||
### Implementation notes:
|
||||
|
||||
The `length` property takes special care to produce an accurate answer,
|
||||
even when the value is poorly-scaled. The naive expression for `length`
|
||||
would be `sqrt(x*x + y*y)`, but this can overflow or underflow even when
|
||||
the final result should be a finite number.
|
||||
|
||||
```swift
|
||||
// Suppose that length were implemented like this:
|
||||
extension Complex {
|
||||
var naiveLength: RealType {
|
||||
.sqrt(real*real + imaginary*imaginary)
|
||||
}
|
||||
}
|
||||
|
||||
// Then taking the length of even a modestly large number:
|
||||
let z = Complex<Float>(1e20, 1e20)
|
||||
// or small number:
|
||||
let w = Complex<Float>(1e-24, 1e-24)
|
||||
// would overflow:
|
||||
z.naiveLength // Inf
|
||||
// or underflow:
|
||||
w.naiveLength // 0
|
||||
```
|
||||
|
||||
Instead, `length` is implemented using a two-step algorithm. First we
|
||||
compute `lengthSquared`, which is `x*x + y*y`. If this is a normal
|
||||
number (meaning that no overflow or underflow has occured), we can safely
|
||||
return its square root. Otherwise, we redo the computation with a more
|
||||
careful computation, which avoids spurious under- or overflow:
|
||||
|
||||
```swift
|
||||
let z = Complex<Float>(1e20, 1e20)
|
||||
let w = Complex<Float>(1e-24, 1e-24)
|
||||
z.length // 1.41421358E+20
|
||||
w.length // 1.41421362E-24
|
||||
```
|
||||
|
||||
### Footnotes:
|
||||
|
||||
¹ Throughout this documentation, "norm" refers to a
|
||||
[vector norm](https://en.wikipedia.org/wiki/Norm_(mathematics)).
|
||||
To confuse the matter, there are several similar things also called
|
||||
"norm" in mathematics. The other one you are most likely to run into
|
||||
is the [field norm](https://en.wikipedia.org/wiki/Field_norm).
|
||||
|
||||
Field norms are much less common than vector norms, but the C++
|
||||
`std::norm` operation implements a field norm. To get the (Euclidean)
|
||||
vector norm in C++, use `std::abs`.
|
||||
|
||||
² There's no subscript-∞ in unicode, so I write the infinity norm
|
||||
without the usual subscript.
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -12,7 +12,7 @@
|
||||
import RealModule
|
||||
|
||||
extension Complex {
|
||||
/// The Euclidean norm (a.k.a. 2-norm, `sqrt(real*real + imaginary*imaginary)`).
|
||||
/// The Euclidean norm (a.k.a. 2-norm).
|
||||
///
|
||||
/// This property takes care to avoid spurious over- or underflow in
|
||||
/// this computation. For example:
|
||||
@@ -26,15 +26,15 @@ extension Complex {
|
||||
/// because the length can be as much as sqrt(2) times larger than
|
||||
/// either component, and thus may not be representable in the real type.
|
||||
///
|
||||
/// For most use cases, you can use the cheaper `.magnitude`
|
||||
/// For most use cases, you can use the cheaper ``magnitude``
|
||||
/// property (which computes the ∞-norm) instead, which always produces
|
||||
/// a representable result.
|
||||
/// a representable result. See <doc:Magnitude> for more details.
|
||||
///
|
||||
/// Edge cases:
|
||||
/// - If a complex value is not finite, its `.length` is `infinity`.
|
||||
/// - If a complex value is not finite, its `length` is `infinity`.
|
||||
///
|
||||
/// See also `.magnitude`, `.lengthSquared`, `.phase`, `.polar`
|
||||
/// and `init(r:θ:)`.
|
||||
/// See also ``lengthSquared``, ``phase``, ``polar``
|
||||
/// and ``init(length:phase:)``.
|
||||
@_transparent
|
||||
public var length: RealType {
|
||||
let naive = lengthSquared
|
||||
@@ -42,7 +42,7 @@ extension Complex {
|
||||
return .sqrt(naive)
|
||||
}
|
||||
|
||||
// Internal implementation detail of `length`, moving slow path off
|
||||
// Internal implementation detail of ``length``, moving slow path off
|
||||
// of the inline function. Note that even `carefulLength` can overflow
|
||||
// for finite inputs, but only when the result is outside the range
|
||||
// of representable values.
|
||||
@@ -54,34 +54,31 @@ extension Complex {
|
||||
|
||||
/// The squared length `(real*real + imaginary*imaginary)`.
|
||||
///
|
||||
/// This property is more efficient to compute than `length`, but is
|
||||
/// This property is more efficient to compute than ``length``, but is
|
||||
/// highly prone to overflow or underflow; for finite values that are
|
||||
/// not well-scaled, `lengthSquared` is often either zero or
|
||||
/// infinity, even when `length` is a finite number. Use this property
|
||||
/// only when you are certain that this value is well-scaled.
|
||||
///
|
||||
/// For many cases, `.magnitude` can be used instead, which is similarly
|
||||
/// For many cases, ``magnitude`` can be used instead, which is similarly
|
||||
/// cheap to compute and always returns a representable value.
|
||||
///
|
||||
/// See also `.length` and `.magnitude`.
|
||||
/// Note that because of how `lengthSquared` is used, it is a primary
|
||||
/// design goal that it be as fast as possible. Therefore, it does not
|
||||
/// normalize infinities, and may return either `.infinity` or `.nan`
|
||||
/// for non-finite values.
|
||||
@_transparent
|
||||
public var lengthSquared: RealType {
|
||||
x*x + y*y
|
||||
}
|
||||
|
||||
@available(*, unavailable, renamed: "lengthSquared")
|
||||
public var unsafeLengthSquared: RealType { lengthSquared }
|
||||
|
||||
/// The phase (angle, or "argument").
|
||||
///
|
||||
/// Returns the angle (measured above the real axis) in radians. If
|
||||
/// - Returns: The angle (measured above the real axis) in radians. If
|
||||
/// the complex value is zero or infinity, the phase is not defined,
|
||||
/// and `nan` is returned.
|
||||
///
|
||||
/// Edge cases:
|
||||
/// - If the complex value is zero or non-finite, phase is `nan`.
|
||||
///
|
||||
/// See also `.length`, `.polar` and `init(r:θ:)`.
|
||||
/// See also ``length``, ``polar`` and ``init(length:phase:)``.
|
||||
@inlinable
|
||||
public var phase: RealType {
|
||||
guard isFinite && !isZero else { return .nan }
|
||||
@@ -94,7 +91,7 @@ extension Complex {
|
||||
/// - If the complex value is zero or non-finite, phase is `.nan`.
|
||||
/// - If the complex value is non-finite, length is `.infinity`.
|
||||
///
|
||||
/// See also: `.length`, `.phase` and `init(r:θ:)`.
|
||||
/// See also: ``length``, ``phase`` and ``init(length:phase:)``.
|
||||
public var polar: (length: RealType, phase: RealType) {
|
||||
(length, phase)
|
||||
}
|
||||
@@ -117,7 +114,7 @@ extension Complex {
|
||||
/// ```
|
||||
/// - Otherwise, `θ` must be finite, or a precondition failure occurs.
|
||||
///
|
||||
/// See also `.length`, `.phase` and `.polar`.
|
||||
/// See also ``length``, ``phase`` and ``polar``.
|
||||
@inlinable
|
||||
public init(length: RealType, phase: RealType) {
|
||||
if phase.isFinite {
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -20,36 +20,22 @@
|
||||
// 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.
|
||||
/// The result of multiplying this value by the real number `a`.
|
||||
///
|
||||
/// Equivalent to `self * Complex(a)`, but may be computed more efficiently.
|
||||
@inlinable @inline(__always)
|
||||
public func multiplied(by a: RealType) -> Complex {
|
||||
Complex(x*a, y*a)
|
||||
}
|
||||
|
||||
/// `self` unscaled by `a`.
|
||||
@usableFromInline @_transparent
|
||||
internal func divided(by a: RealType) -> Complex {
|
||||
// See implementation notes for `multiplied` above.
|
||||
/// The result of dividing this value by the real number `a`.
|
||||
///
|
||||
/// More efficient than `self / Complex(a)`. May not produce exactly the
|
||||
/// same result, but will always be more accurate if they differ.
|
||||
@inlinable @inline(__always)
|
||||
public func divided(by a: RealType) -> Complex {
|
||||
Complex(x/a, y/a)
|
||||
}
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
#[[
|
||||
This source file is part of the Swift Numerics open source project
|
||||
|
||||
Copyright (c) 2019-2021 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
|
||||
#]]
|
||||
|
||||
add_library(IntegerUtilities
|
||||
DivideWithRounding.swift
|
||||
GCD.swift
|
||||
Rotate.swift
|
||||
RoundingRule.swift
|
||||
SaturatingArithmetic.swift
|
||||
ShiftWithRounding.swift)
|
||||
set_target_properties(IntegerUtilities PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
|
||||
|
||||
_install_target(IntegerUtilities)
|
||||
set_property(GLOBAL APPEND PROPERTY SWIFT_NUMERICS_EXPORTS IntegerUtilities)
|
||||
@@ -1,315 +0,0 @@
|
||||
//===--- DivideWithRounding.swift -----------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
extension BinaryInteger {
|
||||
/// `self` divided by `other`, rounding the result according to `rule`.
|
||||
///
|
||||
/// The default rounding rule is `.down`, which _is not the same_ as the
|
||||
/// behavior of the `/` operator from the Swift standard library, but is
|
||||
/// chosen because it generally produces a more useful remainder. In
|
||||
/// particular, when `b` is positive, the remainder is always positive.
|
||||
/// To match the behavior of `/`, use the `.towardZero` rounding mode.
|
||||
///
|
||||
/// Note that the remainder of division is not always representable in an
|
||||
/// unsigned type if a rounding rule other than `.down`, `.towardZero`, or
|
||||
/// `.requireExact` is used. For example:
|
||||
///
|
||||
/// let a: UInt = 5
|
||||
/// let b: UInt = 3
|
||||
/// let q = a.divided(by: b, rounding: .up) // 2
|
||||
/// let r = a - b*q // 5 - 3*2 overflows UInt.
|
||||
///
|
||||
/// For this reason, there is no `remainder(dividingBy:rounding:)`
|
||||
/// operation defined on `BinaryInteger`. Signed integers do not have
|
||||
/// this problem, so it is defined on the `SignedInteger` protocol
|
||||
/// instead, as is an overload of `divided(by:rounding:)` that returns
|
||||
/// both quotient and remainder.
|
||||
@inlinable
|
||||
public func divided(
|
||||
by other: Self,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
// "Normal divsion" rounds toward zero, so we get self = q*other + r
|
||||
// with |r| < |other| and r matching the sign of self.
|
||||
let q = self / other
|
||||
let r = self - q*other
|
||||
// In every rounding mode, the result is the same when the result is
|
||||
// exact.
|
||||
if r == 0 { return q }
|
||||
// From this point forward, we can assume r != 0.
|
||||
//
|
||||
// To get the quotient and remainder rounded as directed by rule, we
|
||||
// will adjust q and r. Note that the quotient is either q-1 or q (if
|
||||
// q is negative) or q or q+1 (if q is positive), because q has been
|
||||
// rounded toward zero.
|
||||
//
|
||||
// If we subtract 1 from q, we add other to r to compensate, because:
|
||||
//
|
||||
// self = q*other + r
|
||||
// = (q-1)*other + (r+other)
|
||||
//
|
||||
// Similarly, if we add 1 to q, we subtract other from r to compensate.
|
||||
switch rule {
|
||||
case .down:
|
||||
// For rounding down, we want to have r match the sign of other
|
||||
// rather than self; this means that if the signs of r and other
|
||||
// disagree, we have to adjust q downward and r to match.
|
||||
if other.signum() != r.signum() { return q-1 }
|
||||
return q
|
||||
case .up:
|
||||
// For rounding up, we want to have r have the opposite sign of
|
||||
// other; if not, we adjust q upward and r to match.
|
||||
if other.signum() == r.signum() { return q+1 }
|
||||
return q
|
||||
case .towardZero:
|
||||
// This is exactly what the `/` operator did for us.
|
||||
return q
|
||||
case .toOdd:
|
||||
// If q is already odd, we're done.
|
||||
if q._lowWord & 1 == 1 { return q }
|
||||
// Otherwise, q is even but inexact; it was originally rounded toward
|
||||
// zero, so rounding away from zero instead will make it odd.
|
||||
fallthrough
|
||||
case .awayFromZero:
|
||||
// To round away from zero, we apply the adjustments for both down
|
||||
// and up.
|
||||
if other.signum() != r.signum() { return q-1 }
|
||||
return q+1
|
||||
case .toNearestOrAwayFromZero:
|
||||
// For round to nearest or away, the condition we want to satisfy is
|
||||
// |r| <= |other/2|, with sign(q) != sign(r) when equality holds.
|
||||
if r.magnitude < other.magnitude.shifted(rightBy: 1, rounding: .up) {
|
||||
return q
|
||||
}
|
||||
// The (q,r) we have does not satisfy the to nearest or away condition;
|
||||
// round away from zero to choose the other representative of (q, r).
|
||||
if other.signum() != r.signum() { return q-1 }
|
||||
return q+1
|
||||
case .toNearestOrEven:
|
||||
// For round to nearest or away, the condition we want to satisfy is
|
||||
// |r| <= |other/2|, with q even when equality holds.
|
||||
if r.magnitude > other.magnitude.shifted(rightBy: 1, rounding: .down) ||
|
||||
2*r.magnitude == other.magnitude && q._lowWord & 1 == 1 {
|
||||
if (other > 0) != (r > 0) { return q-1 }
|
||||
return q+1
|
||||
}
|
||||
return q
|
||||
case .stochastically:
|
||||
var qhi: UInt64
|
||||
var rhi: UInt64
|
||||
if other.magnitude <= UInt64.max {
|
||||
qhi = UInt64(other.magnitude)
|
||||
rhi = UInt64(r.magnitude)
|
||||
} else {
|
||||
// TODO: this is untested currently.
|
||||
let qmag = other.magnitude
|
||||
let shift = qmag._msb - 1
|
||||
qhi = UInt64(truncatingIfNeeded: qmag >> shift)
|
||||
rhi = UInt64(truncatingIfNeeded: r.magnitude >> shift)
|
||||
}
|
||||
let (sum, car) = rhi.addingReportingOverflow(.random(in: 0 ..< qhi))
|
||||
if car || sum >= qhi {
|
||||
if (other > 0) != (r > 0) { return q-1 }
|
||||
return q+1
|
||||
}
|
||||
return q
|
||||
case .requireExact:
|
||||
preconditionFailure("Division was not exact.")
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: make this API and make it possible to implement more efficiently.
|
||||
// Customization point on new/revised integer protocol? Shouldn't have to
|
||||
// go through .words.
|
||||
|
||||
/// The index of the most-significant set bit.
|
||||
///
|
||||
/// - Precondition: self is assumed to be non-zero (should be changed
|
||||
/// if/when this becomes API).
|
||||
@usableFromInline
|
||||
internal var _msb: Int {
|
||||
// a == 0 is never used for division, because this is called
|
||||
// on the divisor which cannot be zero as a precondition; if
|
||||
// this becomes API, the behavior for this case will have to
|
||||
// be defined.
|
||||
assert(self != 0)
|
||||
// Because self is non-zero, mswIndex is guaranteed to exist,
|
||||
// hence force-unwrap is appropriate.
|
||||
let mswIndex = words.lastIndex { $0 != 0 }!
|
||||
let mswBits = UInt.bitWidth * words.distance(from: words.startIndex, to: mswIndex)
|
||||
return mswBits + (UInt.bitWidth - words[mswIndex].leadingZeroBitCount - 1)
|
||||
}
|
||||
}
|
||||
|
||||
extension SignedInteger {
|
||||
/// Divides `self` by `other`, rounding the quotient according to `rule`,
|
||||
/// and returns the remainder.
|
||||
///
|
||||
/// The default rounding rule is `.down`, which _is not the same_ as the
|
||||
/// behavior of the `%` operator from the Swift standard library, but is
|
||||
/// chosen because it generally produces a more useful remainder. To
|
||||
/// match the behavior of `%`, use the `.towardZero` rounding mode.
|
||||
///
|
||||
/// - Precondition: `other` cannot be zero.
|
||||
@inlinable
|
||||
public func remainder(
|
||||
dividingBy other: Self,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
// Produce correct remainder for the .min/-1 case, rather than trapping.
|
||||
if other == -1 { return 0 }
|
||||
return self.divided(by: other, rounding: rule).remainder
|
||||
}
|
||||
|
||||
/// Divides `self` by `other`, rounding the quotient according to `rule`,
|
||||
/// and returns both the quotient and remainder.
|
||||
///
|
||||
/// The default rounding rule is `.down`, which _is not the same_ as the
|
||||
/// behavior of the `/` operator from the Swift standard library, but is
|
||||
/// chosen because it generally produces a more useful remainder. To
|
||||
/// match the behavior of `/`, use the `.towardZero` rounding mode.
|
||||
///
|
||||
/// Because the default rounding mode does not match Swift's standard
|
||||
/// library, this function is a disfavored overload of `divided(by:)`
|
||||
/// instead of using the name `quotientAndRemainder(dividingBy:)`, which
|
||||
/// would shadow the standard library operation and change the behavior
|
||||
/// of any existing use sites. To call this method, you must explicitly
|
||||
/// bind the result to a tuple:
|
||||
///
|
||||
/// // This calls BinaryInteger's method, which returns only
|
||||
/// // the quotient.
|
||||
/// let result = 5.divided(by: 3, rounding: .up) // 2
|
||||
///
|
||||
/// // This calls SignedInteger's method, which returns both
|
||||
/// // the quotient and remainder.
|
||||
/// let (q, r) = 5.divided(by: 3, rounding: .up) // (q = 2, r = -1)
|
||||
@inlinable @inline(__always) @_disfavoredOverload
|
||||
public func divided(
|
||||
by other: Self,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> (quotient: Self, remainder: Self) {
|
||||
// "Normal divsion" rounds toward zero, so we get self = q*other + r
|
||||
// with |r| < |other| and r matching the sign of self.
|
||||
let q = self / other
|
||||
let r = self - q*other
|
||||
// In every rounding mode, the result is the same when the result is
|
||||
// exact.
|
||||
if r == 0 { return (q, r) }
|
||||
// From this point forward, we can assume r != 0.
|
||||
//
|
||||
// To get the quotient and remainder rounded as directed by rule, we
|
||||
// will adjust q and r. Note that the quotient is either q-1 or q (if
|
||||
// q is negative) or q or q+1 (if q is positive), because q has been
|
||||
// rounded toward zero.
|
||||
//
|
||||
// If we subtract 1 from q, we add other to r to compensate, because:
|
||||
//
|
||||
// self = q*other + r
|
||||
// = (q-1)*other + (r+other)
|
||||
//
|
||||
// Similarly, if we add 1 to q, we subtract other from r to compensate.
|
||||
switch rule {
|
||||
case .down:
|
||||
// For rounding down, we want to have r match the sign of other
|
||||
// rather than self; this means that if the signs of r and other
|
||||
// disagree, we have to adjust q downward and r to match.
|
||||
if other.signum() != r.signum() { return (q-1, r+other) }
|
||||
return (q, r)
|
||||
case .up:
|
||||
// For rounding up, we want to have r have the opposite sign of
|
||||
// other; if not, we adjust q upward and r to match.
|
||||
if other.signum() == r.signum() { return (q+1, r-other) }
|
||||
return (q, r)
|
||||
case .towardZero:
|
||||
// This is exactly what the `/` operator did for us.
|
||||
return (q, r)
|
||||
case .toOdd:
|
||||
// If q is already odd, we're done.
|
||||
if q._lowWord & 1 == 1 { return (q, r) }
|
||||
// Otherwise, q is even but inexact; it was originally rounded toward
|
||||
// zero, so rounding away from zero instead will make it odd.
|
||||
fallthrough
|
||||
case .awayFromZero:
|
||||
// To round away from zero, we apply the adjustments for both down
|
||||
// and up.
|
||||
if other.signum() != r.signum() { return (q-1, r+other) }
|
||||
return (q+1, r-other)
|
||||
case .toNearestOrAwayFromZero:
|
||||
// For round to nearest or away, the condition we want to satisfy is
|
||||
// |r| <= |other/2|, with sign(q) != sign(r) when equality holds.
|
||||
if r.magnitude < other.magnitude.shifted(rightBy: 1, rounding: .up) {
|
||||
return (q, r)
|
||||
}
|
||||
// The (q,r) we have does not satisfy the to nearest or away condition;
|
||||
// round away from zero to choose the other representative of (q, r).
|
||||
if other.signum() != r.signum() { return (q-1, r+other) }
|
||||
return (q+1, r-other)
|
||||
case .toNearestOrEven:
|
||||
// For round to nearest or away, the condition we want to satisfy is
|
||||
// |r| <= |other/2|, with q even when equality holds.
|
||||
if r.magnitude > other.magnitude.shifted(rightBy: 1, rounding: .down) ||
|
||||
2*r.magnitude == other.magnitude && q._lowWord & 1 == 1 {
|
||||
if (other > 0) != (r > 0) { return (q-1, r+other) }
|
||||
return (q+1, r-other)
|
||||
}
|
||||
return (q, r)
|
||||
case .stochastically:
|
||||
var qhi: UInt64
|
||||
var rhi: UInt64
|
||||
if other.magnitude <= UInt64.max {
|
||||
qhi = UInt64(other.magnitude)
|
||||
rhi = UInt64(r.magnitude)
|
||||
} else {
|
||||
// TODO: this is untested currently.
|
||||
let qmag = other.magnitude
|
||||
let shift = qmag._msb - 1
|
||||
qhi = UInt64(truncatingIfNeeded: qmag >> shift)
|
||||
rhi = UInt64(truncatingIfNeeded: r.magnitude >> shift)
|
||||
}
|
||||
let (sum, car) = rhi.addingReportingOverflow(.random(in: 0 ..< qhi))
|
||||
if car || sum >= qhi {
|
||||
if (other > 0) != (r > 0) { return (q-1, r+other) }
|
||||
return (q+1, r-other)
|
||||
}
|
||||
return (q, r)
|
||||
case .requireExact:
|
||||
preconditionFailure("Division was not exact.")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `a = quotient*b + remainder`, with `remainder >= 0`.
|
||||
///
|
||||
/// When `a` and `b` are both positive, `quotient` is `a/b` and `remainder`
|
||||
/// is `a%b`.
|
||||
///
|
||||
/// Rounding the quotient so that the remainder is non-negative is called
|
||||
/// "Euclidean division". This is not a _rounding rule_, as `quotient`
|
||||
/// cannot be determined from the unrounded value `a/b`; we need to also
|
||||
/// know the sign of `a` or `b` or `r` to know which way to round. Because
|
||||
/// of this, is not present in the `RoundingRule` enum and uses a separate
|
||||
/// API from the other division operations.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - a: The dividend
|
||||
/// - b: The divisor
|
||||
///
|
||||
/// - Precondition: `b` must be non-zero, and the quotient `a/b` must be
|
||||
/// representable. In particular, if `T` is a signed fixed-width integer
|
||||
/// type, then `euclideanDivision(T.min, -1)` will trap, because `-T.min`
|
||||
/// is not representable.
|
||||
///
|
||||
/// - Returns: `(quotient, remainder)`, with `0 <= remainder < b.magnitude`.
|
||||
func euclideanDivision<T>(_ a: T, _ b: T) -> (quotient: T, remainder: T)
|
||||
where T: SignedInteger
|
||||
{
|
||||
a.divided(by: b, rounding: a >= 0 ? .towardZero : .awayFromZero)
|
||||
}
|
||||
@@ -1,53 +0,0 @@
|
||||
//===--- GCD.swift --------------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
/// The greatest common divisor of `a` and `b`.
|
||||
///
|
||||
/// If both inputs are zero, the result is zero. If one input is zero, the
|
||||
/// result is the absolute value of the other input.
|
||||
///
|
||||
/// The result must be representable within its type. In particular, the gcd
|
||||
/// of a signed, fixed-width integer type's minimum with itself (or zero)
|
||||
/// cannot be represented, and results in a trap.
|
||||
///
|
||||
/// gcd(Int.min, Int.min) // Overflow error
|
||||
/// gcd(Int.min, 0) // Overflow error
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Greatest_common_divisor
|
||||
@inlinable
|
||||
public func gcd<T: BinaryInteger>(_ a: T, _ b: T) -> T {
|
||||
var x = a.magnitude
|
||||
var y = b.magnitude
|
||||
|
||||
if x == 0 { return T(y) }
|
||||
if y == 0 { return T(x) }
|
||||
|
||||
let xtz = x.trailingZeroBitCount
|
||||
let ytz = y.trailingZeroBitCount
|
||||
|
||||
y >>= ytz
|
||||
|
||||
// The binary GCD algorithm
|
||||
//
|
||||
// After the right-shift in the loop, both x and y are odd. Each pass removes
|
||||
// at least one low-order bit from the larger of the two, so the number of
|
||||
// iterations is bounded by the sum of the bit-widths of the inputs.
|
||||
//
|
||||
// A tighter bound is the maximum bit-width of the inputs, which is achieved
|
||||
// by odd numbers that sum to a power of 2, though the proof is more involved.
|
||||
repeat {
|
||||
x >>= x.trailingZeroBitCount
|
||||
if x < y { swap(&x, &y) }
|
||||
x -= y
|
||||
} while x != 0
|
||||
|
||||
return T(y << min(xtz, ytz))
|
||||
}
|
||||
@@ -1,68 +0,0 @@
|
||||
# Integer Utilities
|
||||
|
||||
_Note: This module is only present on `main`, and has not yet been stabilized and released in a tag._
|
||||
|
||||
## Utilities defined for `BinaryInteger`
|
||||
|
||||
The following API are defined for all integer types:
|
||||
|
||||
- The `gcd(_:_:)` free function implements the _Greatest Common Divisor_ operation.
|
||||
|
||||
- The `shifted(rightBy:rounding:)` method implements _bitwise shift with rounding_.
|
||||
|
||||
- The `divided(by:rounding:)` method implements division with specified rounding.
|
||||
(See also `SignedInteger.divided(by:rounding:)`, `remainder(dividingBy:rounding:)`, and `euclideanDivision(_:_:)` below).
|
||||
|
||||
## Utilities defined for `SignedInteger`
|
||||
|
||||
The following API are defined for signed integer types:
|
||||
|
||||
- The `divided(by:rounding:)` method implementing division with specified rounding, returning both quotient and remainder.
|
||||
This requires a signed type because the remainder is not generally representable for unsigned types.
|
||||
This is a disfavored overload; by default, you will get only the quotient as the result:
|
||||
```
|
||||
let p = 5.divided(by: 3, rounding: .up) // p = 2
|
||||
let (q, r) = 5.divided(by: 3, rounding: .up) // q = 2, r = -1
|
||||
```
|
||||
|
||||
- The `remainder(dividingBy:rounding:)` method implementing the remainder operation; the `rounding` argument describes how to round the _quotient_, which is not returned.
|
||||
(The remainder is always exact, and hence is not rounded).
|
||||
|
||||
- The `euclideanDivision(_:_:)` free function implements _Euclidean division_.
|
||||
In this operation, the remainder is chosen to always be non-negative.
|
||||
This does not correspond to any rounding rule on the quotient, which is why it uses a distinct API.
|
||||
|
||||
## Utilities defined for `FixedWidthInteger`
|
||||
|
||||
- The `rotated(right:)` and `rotated(left:)` methods implement _bitwise rotation_ for signed and unsigned integer types.
|
||||
The count parameter may be any `BinaryInteger` type.
|
||||
|
||||
### [Saturating Arithmetic][saturating]
|
||||
|
||||
The following saturating operations are defined as methods on `FixedWidthInteger`:
|
||||
|
||||
- `addingWithSaturation(_:)`
|
||||
- `subtractingWithSaturation(_:)`
|
||||
- `negatedWithSaturation(_:)`
|
||||
- `multipliedWithSaturation(by:)`
|
||||
- `shiftedWithSaturation(leftBy:rounding:)`
|
||||
|
||||
These implement _saturating arithmetic_.
|
||||
They are an alternative to the usual `+`, `-`, and `*` operators, which trap if the result cannot be represented in the argument type, and `&+`, `&-`, `&*`, and `<<`, which wrap out-of-range results modulo 2ⁿ for some n.
|
||||
Instead these methods clamp the result to the representable range of the type:
|
||||
```
|
||||
let x: Int8 = 84
|
||||
let y: Int8 = 100
|
||||
let a = x + y // traps due to overflow
|
||||
let b = x &+ y // wraps to -72
|
||||
let c = x.addingWithSaturation(y) // saturates to 127
|
||||
```
|
||||
|
||||
If you are using saturating arithmetic, you may also want to perform saturating conversions between integer types; this functionality is provided by the standard library via the [`init(clamping:)` API][clamping].
|
||||
|
||||
## Types
|
||||
|
||||
The `RoundingRule` enum is used with shift, division, and round operations to specify how to round their results to a representable value.
|
||||
|
||||
[saturating]: https://en.wikipedia.org/wiki/Saturation_arithmetic
|
||||
[clamping]: https://developer.apple.com/documentation/swift/binaryinteger/init(clamping:)
|
||||
@@ -1,43 +0,0 @@
|
||||
//===--- Rotate.swift -----------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
extension FixedWidthInteger {
|
||||
@_transparent @usableFromInline
|
||||
internal func rotateImplementation(right count: Int) -> Self {
|
||||
// We don't have an unsigned right shift operation for signed values, so
|
||||
// we need to convert to an unsigned type. The only unsigned type that's
|
||||
// guaranteed to be able to represent the bit pattern of any Self value
|
||||
// is Magnitude. It would be possible to have Magnitude be _wider_ than
|
||||
// Self, but that's OK as long as we're careful to complement the shift
|
||||
// count using Self.bitWidth and not Magnitude.bitWidth or zero.
|
||||
let bitPattern = Magnitude(truncatingIfNeeded: self)
|
||||
let countComplement = Self.bitWidth &- count
|
||||
return Self(truncatingIfNeeded:
|
||||
bitPattern &>> count | bitPattern &<< countComplement
|
||||
)
|
||||
}
|
||||
|
||||
/// `self` rotated bitwise right by `count` bits.
|
||||
///
|
||||
/// Equivalent to `rotated(left: 0 &- count)`.
|
||||
@inlinable
|
||||
public func rotated<Count: BinaryInteger>(right count: Count) -> Self {
|
||||
rotateImplementation(right: Int(truncatingIfNeeded: count))
|
||||
}
|
||||
|
||||
/// `self` rotated bitwise left by `count` bits.
|
||||
///
|
||||
/// Equivalent to `rotated(right: 0 &- count)`.
|
||||
@inlinable
|
||||
public func rotated<Count: BinaryInteger>(left count: Count) -> Self {
|
||||
rotateImplementation(right: 0 &- Int(truncatingIfNeeded: count))
|
||||
}
|
||||
}
|
||||
@@ -1,187 +0,0 @@
|
||||
//===--- RoundingRule.swift -----------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
/// A rule that defines how to select one of the two representable results
|
||||
/// closest to a given value.
|
||||
///
|
||||
/// [Wikipedia](https://en.wikipedia.org/wiki/Rounding#Rounding_to_integer)
|
||||
/// provides a good overview of different rounding rules.
|
||||
///
|
||||
/// Examples using rounding to integer to illustrate the various options:
|
||||
/// ```
|
||||
/// value | down | up | towardZero | awayFromZero |
|
||||
/// =======+==============+==============+==============+==============+
|
||||
/// 1.5 | 1 | 2 | 1 | 2 |
|
||||
/// -------+--------------+--------------+--------------+--------------+
|
||||
/// -0.5 | -1 | 0 | 0 | -1 |
|
||||
/// -------+--------------+--------------+--------------+--------------+
|
||||
/// 0.3 | 0 | 1 | 0 | 1 |
|
||||
/// -------+--------------+--------------+--------------+--------------+
|
||||
/// 2 | 2 | 2 | 2 | 2 |
|
||||
/// -------+--------------+--------------+--------------+--------------+
|
||||
///
|
||||
/// value | toOdd | toNearestOrAwayFromZero | toNearestOrEven |
|
||||
/// =======+==============+=========================+==================+
|
||||
/// 1.5 | 1 | 2 | 2 |
|
||||
/// -------+--------------+-------------------------+------------------+
|
||||
/// -0.5 | -1 | -1 | 0 |
|
||||
/// -------+--------------+-------------------------+------------------+
|
||||
/// 0.3 | 1 | 0 | 0 |
|
||||
/// -------+--------------+-------------------------+------------------+
|
||||
/// 2 | 2 | 2 | 2 |
|
||||
/// -------+--------------+-------------------------+------------------+
|
||||
///
|
||||
/// value | stochastically | requireExact |
|
||||
/// =======+=======================+================+
|
||||
/// 1.5 | 50% 1, 50% 2 | trap |
|
||||
/// -------+-----------------------+----------------+
|
||||
/// -0.5 | 50% -1, 50% 0 | trap |
|
||||
/// -------+-----------------------+----------------+
|
||||
/// 0.3 | 70% 0, 30% 1 | trap |
|
||||
/// -------+-----------------------+----------------+
|
||||
/// 2 | 2 | 2 |
|
||||
/// -------+-----------------------+----------------+
|
||||
/// ```
|
||||
public enum RoundingRule {
|
||||
/// Produces the closest representable value that is less than or equal
|
||||
/// to the value being rounded.
|
||||
///
|
||||
/// This is the default rounding mode for integer shifts, including the
|
||||
/// shift operators defined in the standard library.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .down)` is `-2`, because –2 is the
|
||||
/// largest integer less than –4/3 = –1.3̅
|
||||
/// - `5.shifted(rightBy: 1, rounding: .down)` is `2`, because 2 is the
|
||||
/// largest integer less than 5/2 = 2.5.
|
||||
case down
|
||||
|
||||
/// Produces the closest representable value that is greater than or equal
|
||||
/// to the value being rounded.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .up)` is `-1`, because –1 is the
|
||||
/// smallest integer greater than –4/3 = –1.3̅
|
||||
/// - `5.shifted(rightBy: 1, rounding: .up)` is `3`, because 3 is the
|
||||
/// smallest integer greater than 5/2 = 2.5.
|
||||
case up
|
||||
|
||||
/// Produces the closest representable value whose magnitude is less than
|
||||
/// or equal to that of the value being rounded.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .towardZero)` is `-1`, because –1
|
||||
/// is the closest integer to –4/3 = –1.3̅ with smaller magnitude.
|
||||
/// - `5.shifted(rightBy: 1, rounding: .towardZero)` is `2`, because 2
|
||||
/// is the closest integer to 5/2 = 2.5 with smaller magnitude.
|
||||
case towardZero
|
||||
|
||||
/// Produces the closest representable value whose magnitude is greater
|
||||
/// than or equal to that of the value being rounded.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .awayFromZero)` is `-2`, because –2
|
||||
/// is the closest integer to –4/3 = –1.3̅ with greater magnitude.
|
||||
/// - `5.shifted(rightBy: 1, rounding: .awayFromZero)` is `3`, because 3
|
||||
/// is the closest integer to 5/2 = 2.5 with greater magnitude.
|
||||
case awayFromZero
|
||||
|
||||
/// If the value being rounded is representable, that value is returned.
|
||||
/// Otherwise, whichever of the two closest representable values has its
|
||||
/// least significant bit set is returned.
|
||||
///
|
||||
/// This is also called _sticky rounding_, and it is useful as an
|
||||
/// implementation detail because it has the property that if we do
|
||||
/// rounding in two steps, first to intermediate precision p₁ with .toOdd,
|
||||
/// then to the final precision p₂ with any other rounding mode, the result
|
||||
/// we get is the same as if we rounded directly to p₂ in the desired mode
|
||||
/// so long as p₂ + 1 < p₁. Other rounding modes do not have this property,
|
||||
/// and admit _double roundings_ when interoperating with some modes.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .toOdd)` is `-1`, because –4/3 = –1.3̅
|
||||
/// is not an exact integer, and –1 is the closest odd integer.
|
||||
/// - `4.shifted(rightBy: 1, rounding: .toOdd)` is `2`,
|
||||
/// even though 2 is even, because 4/2 is exactly 2 and no rounding occurs.
|
||||
case toOdd
|
||||
|
||||
/// Produces the representable value that is closest to the value being
|
||||
/// rounded. If two values are equally close, the one that has greater
|
||||
/// magnitude is returned.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .toNearestOrAwayFromZero)`
|
||||
/// is `-1`, because –4/3 = –1.3̅ is closer to –1 than it is to –2.
|
||||
///
|
||||
/// - `5.shifted(rightBy: 1, rounding: .toNearestOrAwayFromZero)` is `3`,
|
||||
/// because 5/2 = 2.5 is equally close to 2 and 3, and 3 is further away
|
||||
/// from zero.
|
||||
case toNearestOrAwayFromZero
|
||||
|
||||
/// Produces the representable value that is closest to the value being
|
||||
/// rounded. If two values are equally close, the one whose least
|
||||
/// significant bit is not set is returned.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .toNearestOrEven)`
|
||||
/// is `-1`, because –4/3 = –1.3̅ is closer to –1 than it is to –2.
|
||||
///
|
||||
/// - `5.shifted(rightBy: 1, rounding: .toNearestOrEven)` is `2`,
|
||||
/// because 5/2 = 2.5 is equally close to 2 and 3, and 2 is even.
|
||||
case toNearestOrEven
|
||||
|
||||
/// Adds a uniform random value from [0, d) to the value being rounded,
|
||||
/// where d is the distance between the two closest representable values,
|
||||
/// then rounds the sum downwards.
|
||||
///
|
||||
/// Unlike all the other rounding modes, this mode is _not deterministic_;
|
||||
/// repeated calls to rounding operations with this mode will generally
|
||||
/// produce different results. There is a tradeoff implicit in using this
|
||||
/// mode: you can sacrifice _reproducible_ results to get _more accurate_
|
||||
/// results in aggregate. For a contrived but illustrative example, consider
|
||||
/// the following:
|
||||
/// ```
|
||||
/// let data = Array(repeating: 1, count: 100)
|
||||
/// let result = data.reduce(0) {
|
||||
/// $0 + $1.divided(by: 3, rounding: rule)
|
||||
/// }
|
||||
/// ```
|
||||
/// because 1/3 is always the same value between 0 and 1, any
|
||||
/// deterministic rounding rule must produce either 0 or 100 for
|
||||
/// this computation. But rounding `stochastically` will
|
||||
/// produce a value close to 33. The _error_ of the computation
|
||||
/// is smaller, but the result will now change between runs of the
|
||||
/// program.
|
||||
///
|
||||
/// For this simple case a better solution would be to add the
|
||||
/// values first, and then divide. This gives a result that is both
|
||||
/// reproducible _and_ accurate:
|
||||
/// ```
|
||||
/// let result = data.reduce(0, +)/3
|
||||
/// ```
|
||||
/// but this isn't always possible in more sophisticated scenarios,
|
||||
/// and in those cases this rounding rule may be useful.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .stochastically)`
|
||||
/// will be –1 with probability 2/3 and –2 with probability 1/3.
|
||||
/// - `5.shifted(rightBy: 1, rounding: .stochastically)`
|
||||
/// will be 2 with probability 1/2 and 3 with probability 1/2.
|
||||
case stochastically
|
||||
|
||||
/// If the value being rounded is representable, that value is returned.
|
||||
/// Otherwise, a precondition failure occurs.
|
||||
///
|
||||
/// Examples:
|
||||
/// - `(-4).divided(by: 3, rounding: .requireExact)` will trap,
|
||||
/// because –4/3 = –1.3̅ is not an integer.
|
||||
case requireExact
|
||||
}
|
||||
@@ -1,167 +0,0 @@
|
||||
//===--- SaturatingArithmetic.swift ---------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2023 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
extension FixedWidthInteger {
|
||||
/// `~0` (all-ones) if this value is negative, otherwise `0`.
|
||||
///
|
||||
/// Note that if `Self` is unsigned, this always returns `0`,
|
||||
/// but it is useful for writing algorithms that are generic over
|
||||
/// signed and unsigned integers.
|
||||
@inline(__always) @usableFromInline
|
||||
var signbit: Self {
|
||||
return self < .zero ? ~.zero : .zero
|
||||
}
|
||||
|
||||
/// Saturating integer addition
|
||||
///
|
||||
/// `self + other` clamped to the representable range of the type. e.g.:
|
||||
/// ```
|
||||
/// let a: Int8 = 84
|
||||
/// let b: Int8 = 100
|
||||
/// // 84 + 100 = 184 is not representable as
|
||||
/// // Int8, so `c` is clamped to Int8.max (127).
|
||||
/// let c = a.addingWithSaturation(b)
|
||||
/// ```
|
||||
///
|
||||
/// Anytime the "normal addition" `self + other` does not trap,
|
||||
/// `addingWithSaturation` produces the same result.
|
||||
@inlinable
|
||||
public func addingWithSaturation(_ other: Self) -> Self {
|
||||
let (wrapped, overflow) = addingReportingOverflow(other)
|
||||
return overflow ? Self.max &- signbit : wrapped
|
||||
}
|
||||
|
||||
/// Saturating integer subtraction
|
||||
///
|
||||
/// `self - other` clamped to the representable range of the type. e.g.:
|
||||
/// ```
|
||||
/// let a: UInt = 37
|
||||
/// let b: UInt = 42
|
||||
/// // 37 - 42 = -5, which is not representable as
|
||||
/// // UInt, so `c` is clamped to UInt.min (zero).
|
||||
/// let c = a.subtractingWithSaturation(b)
|
||||
/// ```
|
||||
///
|
||||
/// Note that `a.addingWithSaturation(-b)` is not always equivalent to
|
||||
/// `a.subtractingWithSaturation(b)`, because `-b` is not representable
|
||||
/// if `b` is the minimum value of a signed type.
|
||||
///
|
||||
/// Anytime the "normal subtraction" `self - other` does not trap,
|
||||
/// `subtractingWithSaturation` produces the same result.
|
||||
@inlinable
|
||||
public func subtractingWithSaturation(_ other: Self) -> Self {
|
||||
let (wrapped, overflow) = subtractingReportingOverflow(other)
|
||||
if !overflow { return wrapped }
|
||||
return Self.isSigned ? Self.max &- signbit : 0
|
||||
}
|
||||
|
||||
/// Saturating integer negation
|
||||
///
|
||||
/// For unsigned types, the result is always zero. This is not very
|
||||
/// interesting, but may occasionally be useful in generic contexts.
|
||||
/// For signed types, the result is `-self` unless `self` is `.min`,
|
||||
/// in which case the result is `.max`.
|
||||
@inlinable
|
||||
public func negatedWithSaturation() -> Self {
|
||||
Self.zero.subtractingWithSaturation(self)
|
||||
}
|
||||
|
||||
/// Saturating integer multiplication
|
||||
///
|
||||
/// `self * other` clamped to the representable range of the type. e.g.:
|
||||
/// ```
|
||||
/// let a: Int8 = -16
|
||||
/// let b: Int8 = -8
|
||||
/// // -16 * -8 = 128 is not representable as
|
||||
/// // Int8, so `c` is clamped to Int8.max (127).
|
||||
/// let c = a.multipliedWithSaturation(by: b)
|
||||
/// ```
|
||||
///
|
||||
/// Anytime the "normal multiplication" `self * other` does not trap,
|
||||
/// `multipliedWithSaturation` produces the same result.
|
||||
@inlinable
|
||||
public func multipliedWithSaturation(by other: Self) -> Self {
|
||||
let (high, low) = multipliedFullWidth(by: other)
|
||||
let wrapped = Self(truncatingIfNeeded: low)
|
||||
if high == wrapped.signbit { return wrapped }
|
||||
return Self.max &- high.signbit
|
||||
}
|
||||
|
||||
/// Bitwise left with rounding and saturation.
|
||||
///
|
||||
/// `self` multiplied by the rational number 2^(`count`), saturated to the
|
||||
/// range `Self.min ... Self.max`, and rounded according to `rule`.
|
||||
///
|
||||
/// See `shifted(rightBy:rounding:)` for more discussion of rounding
|
||||
/// shifts with examples.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - leftBy count: the number of bits to shift by. If positive, this is a left-shift,
|
||||
/// and if negative a right shift.
|
||||
/// - rounding rule: the direction in which to round if `count` is negative.
|
||||
@inlinable
|
||||
public func shiftedWithSaturation(
|
||||
leftBy count: Int,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
if count == 0 { return self }
|
||||
// If count is negative, negate it and do a right shift without
|
||||
// saturation instead, since we already have that implemented.
|
||||
guard count > 0 else {
|
||||
return shifted(
|
||||
rightBy: count.negatedWithSaturation(),
|
||||
rounding: rule
|
||||
)
|
||||
}
|
||||
let clamped = Self.max &- signbit
|
||||
guard count < Self.bitWidth else {
|
||||
// If count is bitWidth or greater, we always overflow
|
||||
// unless self is zero.
|
||||
return self == 0 ? 0 : clamped
|
||||
}
|
||||
// Now we have 0 < count < bitWidth, so we can use a nice
|
||||
// straightforward implementation; a shift overflows if
|
||||
// the complementary shift doesn't match sign-or-zero
|
||||
// extension. E.g.:
|
||||
//
|
||||
// - signed 0b0010_1111 << 2 overflows, because
|
||||
// 0b0010_1111 >> 5 is 0b0000_0001, which does not
|
||||
// equal 0b0000_0000
|
||||
//
|
||||
// - unsigned 0b0010_1111 << 2 does not overflow,
|
||||
// because 0b0010_0000 >> 6 is 0b0000_0000, which
|
||||
// does equal 0b0000_0000.
|
||||
let valueBits = Self.bitWidth &- (Self.isSigned ? 1 : 0)
|
||||
let wrapped = self &<< count
|
||||
let complement = valueBits &- count
|
||||
return self &>> complement == signbit ? wrapped : clamped
|
||||
}
|
||||
|
||||
/// Bitwise left with rounding and saturation.
|
||||
///
|
||||
/// `self` multiplied by the rational number 2^(`count`), saturated to the
|
||||
/// range `Self.min ... Self.max`, and rounded according to `rule`.
|
||||
///
|
||||
/// See `shifted(rightBy:rounding:)` for more discussion of rounding
|
||||
/// shifts with examples.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - leftBy count: the number of bits to shift by. If positive, this is a left-shift,
|
||||
/// and if negative a right shift.
|
||||
/// - rounding rule: the direction in which to round if `count` is negative.
|
||||
@_transparent
|
||||
public func shiftedWithSaturation<Count: BinaryInteger>(
|
||||
leftBy count: Count,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
self.shiftedWithSaturation(leftBy: Int(clamping: count), rounding: rule)
|
||||
}
|
||||
}
|
||||
@@ -1,197 +0,0 @@
|
||||
//===--- ShiftWithRounding.swift ------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
extension BinaryInteger {
|
||||
/// `self` divided by 2^(`count`), rounding the result according to `rule`.
|
||||
///
|
||||
/// The default rounding rule is `.down`, which matches the behavior of
|
||||
/// the `>>` operator from the standard library.
|
||||
///
|
||||
/// Some examples of different rounding rules:
|
||||
///
|
||||
/// // 3/2 is 1.5, which rounds (down by default) to 1.
|
||||
/// 3.shifted(rightBy: 1)
|
||||
///
|
||||
/// // 1.5 rounds up to 2.
|
||||
/// 3.shifted(rightBy: 1, rounding: .up)
|
||||
///
|
||||
/// // The two closest values are 1 and 2, 1 is returned because it
|
||||
/// // is odd.
|
||||
/// 3.shifted(rightBy: 1, rounding: .toOdd)
|
||||
///
|
||||
/// // 7/4 = 1.75, so the result is 1 with probability 1/4, or 2
|
||||
/// // with probability 3/4.
|
||||
/// 7.shifted(rightBy: 2, rounding: .stochastically)
|
||||
///
|
||||
/// // 4/4 is exactly 1, so this does not trap.
|
||||
/// 4.shifted(rightBy: 2, rounding: .requireExact)
|
||||
///
|
||||
/// // 5/2 is 2.5, which is not an integer, so this traps.
|
||||
/// 5.shifted(rightBy: 1, rounding: .requireExact)
|
||||
///
|
||||
/// When `Self(1) << count` is positive, the following are equivalent:
|
||||
///
|
||||
/// a.shifted(rightBy: count, rounding: rule)
|
||||
/// a.divided(by: 1 << count, rounding: rule)
|
||||
@inlinable
|
||||
public func shifted(
|
||||
rightBy count: Int,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
// Easiest case: count is zero or negative, so shift is always exact;
|
||||
// delegate to the normal >> operator.
|
||||
if count <= 0 { return self >> count }
|
||||
if count >= bitWidth {
|
||||
// Note: what follows would cause an infinite loop if bitWidth <= 1.
|
||||
// This will essentially never happen, but in the highly unlikely event
|
||||
// that we encounter such a case, we promote to Int8, do the shift, and
|
||||
// then convert back to the appropriate result type.
|
||||
if bitWidth <= 1 {
|
||||
return Self(Int8(self).shifted(rightBy: count, rounding: rule))
|
||||
}
|
||||
// That pathological case taken care of, we can now handle over-wide
|
||||
// shifts by first shifting all but bitWidth - 1 bits with sticky
|
||||
// rounding, and then shifting the remaining bitWidth - 1 bits with
|
||||
// the desired rounding mode.
|
||||
let count = count - (bitWidth - 1)
|
||||
let floor = self >> count
|
||||
let lost = self - (floor << count)
|
||||
let sticky = floor | (lost == 0 ? 0 : 1)
|
||||
return sticky.shifted(rightBy: bitWidth - 1, rounding: rule)
|
||||
}
|
||||
// Now we are in the happy case: 0 < count < bitWidth, which makes all
|
||||
// the math to handle rounding simpler.
|
||||
//
|
||||
// TODO: If we were really, really careful about overflow, some of these
|
||||
// could be made simpler. E.g. mathematically round up is implemented here
|
||||
// via:
|
||||
//
|
||||
// floor = self >> count
|
||||
// mask = 1 << count - 1
|
||||
// lost = self & mask
|
||||
// return floor + (lost == 0 ? 0 : 1)
|
||||
//
|
||||
// _if_ we didn't have to worry about intermediate overflow (either because
|
||||
// self is bounded away from .max or because we don't have a fixed-width
|
||||
// type), then we could use the following instead:
|
||||
//
|
||||
// mask = 1 << count - 1
|
||||
// return (self + mask) >> count
|
||||
//
|
||||
// However, self + mask can overflow, e.g. if we're shifting .max by 1:
|
||||
//
|
||||
// mask = 1 << 1 - 1 = 1
|
||||
// self + mask = .max + 1 // uh-oh
|
||||
//
|
||||
// This cannot occur for arbitrary-precision numbers, so we could use
|
||||
// the simpler expressions for those (but those are precisely the cases
|
||||
// where performance of rounding does not matter much, because shifts
|
||||
// get swamped by even basic arithmetic). More interesting, we could
|
||||
// promote fixed-width numbers to a wider type, preventing this
|
||||
// intermediate overflow and allowing us to use the simpler expressions
|
||||
// much of the time. We could also explicitly _detect_ the overflow if
|
||||
// it happens and patch up the result, though this is a little bit tricky
|
||||
// because addingReportingOverflow and friends do not exist on
|
||||
// BinaryInteger. Hence, this is a TODO for the future.
|
||||
let mask = Magnitude(1) << count - 1
|
||||
let lost = Magnitude(truncatingIfNeeded: self) & mask
|
||||
let floor = self >> count
|
||||
let ceiling = floor + (lost == 0 ? 0 : 1)
|
||||
switch rule {
|
||||
case .down:
|
||||
return floor
|
||||
case .up:
|
||||
return ceiling
|
||||
case .towardZero:
|
||||
return self > 0 ? floor : ceiling
|
||||
case .awayFromZero:
|
||||
return self < 0 ? floor : ceiling
|
||||
case .toOdd:
|
||||
return floor | (lost == 0 ? 0 : 1)
|
||||
case .toNearestOrAwayFromZero:
|
||||
let round = mask >> 1 + (self > 0 ? 1 : 0)
|
||||
return floor + Self((round + lost) >> count)
|
||||
case .toNearestOrEven:
|
||||
let round = mask >> 1 + Magnitude(floor & 1)
|
||||
return floor + Self((round + lost) >> count)
|
||||
case .stochastically:
|
||||
// TODO: it's unfortunate that we can't specify a custom random source
|
||||
// for the stochastically rounding rule, but I don't see a nice way to
|
||||
// have that share the API with the other rounding rules, because we'd
|
||||
// then have to take the RNG in-out. The same problem applies to
|
||||
// rounding with dithering. We should consider adding a stateful
|
||||
// rounding API down the road to support those use cases.
|
||||
//
|
||||
// In theory, u01 should be Self.random(in: 0 ..< onesBit), but the
|
||||
// random(in:) method does not exist on BinaryInteger. This is
|
||||
// (arguably) good, though, because there's actually no reason to
|
||||
// generate large amounts of randomness just to implement stochastic
|
||||
// rounding; 32b suffices for almost all purposes, and 64b is more
|
||||
// than enough.
|
||||
var g = SystemRandomNumberGenerator()
|
||||
let u01 = g.next()
|
||||
if count < 64 {
|
||||
// count is small, so mask and lost are representable as both
|
||||
// UInt64 and Self, regardless of what type Self actually is.
|
||||
return floor + Self(((u01 & UInt64(mask)) + UInt64(lost)) >> count)
|
||||
} else {
|
||||
// count is large, so lost may not be representable as UInt64; pre-
|
||||
// shift by count-64 to isolate the high 64b of the fraction, then
|
||||
// add u01 and carry-out to round.
|
||||
let highWord = UInt64(truncatingIfNeeded: lost >> (Int(count) - 64))
|
||||
let (_, carry) = highWord.addingReportingOverflow(u01)
|
||||
return floor + (carry ? 1 : 0)
|
||||
}
|
||||
case .requireExact:
|
||||
precondition(lost == 0, "shift was not exact.")
|
||||
return floor
|
||||
}
|
||||
}
|
||||
|
||||
/// `self` divided by 2^(`count`), rounding the result according to `rule`.
|
||||
///
|
||||
/// The default rounding rule is `.down`, which matches the behavior of
|
||||
/// the `>>` operator from the standard library.
|
||||
///
|
||||
/// Some examples of different rounding rules:
|
||||
///
|
||||
/// // 3/2 is 1.5, which rounds (down by default) to 1.
|
||||
/// 3.shifted(rightBy: 1)
|
||||
///
|
||||
/// // 1.5 rounds up to 2.
|
||||
/// 3.shifted(rightBy: 1, rounding: .up)
|
||||
///
|
||||
/// // The two closest values are 1 and 2, 1 is returned because it
|
||||
/// // is odd.
|
||||
/// 3.shifted(rightBy: 1, rounding: .toOdd)
|
||||
///
|
||||
/// // 7/4 = 1.75, so the result is 1 with probability 1/4, or 2
|
||||
/// // with probability 3/4.
|
||||
/// 7.shifted(rightBy: 2, rounding: .stochastically)
|
||||
///
|
||||
/// // 4/4 is exactly 1, so this does not trap.
|
||||
/// 4.shifted(rightBy: 2, rounding: .requireExact)
|
||||
///
|
||||
/// // 5/2 is 2.5, which is not an integer, so this traps.
|
||||
/// 5.shifted(rightBy: 1, rounding: .requireExact)
|
||||
///
|
||||
/// When `Self(1) << count` is positive, the following are equivalent:
|
||||
///
|
||||
/// a.shifted(rightBy: count, rounding: rule)
|
||||
/// a.divided(by: 1 << count, rounding: rule)
|
||||
@_transparent
|
||||
public func shifted<Count: BinaryInteger>(
|
||||
rightBy count: Count,
|
||||
rounding rule: RoundingRule = .down
|
||||
) -> Self {
|
||||
self.shifted(rightBy: Int(clamping: count), rounding: rule)
|
||||
}
|
||||
}
|
||||
@@ -19,9 +19,7 @@ target_compile_options(Numerics PUBLIC
|
||||
# load symbol when validating the TBD
|
||||
-Xfrontend -validate-tbd-against-ir=none)
|
||||
target_link_libraries(Numerics PUBLIC
|
||||
BigIntModule
|
||||
ComplexModule
|
||||
IntegerUtilities
|
||||
RealModule)
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,5 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
// A module that re-exports the complete Swift Numerics public API.
|
||||
@_exported import BigIntModule
|
||||
@_exported import ComplexModule
|
||||
@_exported import IntegerUtilities
|
||||
@_exported import RealModule
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -32,15 +32,16 @@
|
||||
/// Because integer multiplication does not form a group; it's commutative and
|
||||
/// associative, but integers do not have multiplicative inverses.
|
||||
/// I.e. if a is any integer other than 1 or -1, there is no integer b such
|
||||
/// that a*b = 1. The existence of inverses is requried to form a field.
|
||||
/// that `a*b = 1`. The existence of inverses is requried to form a field.
|
||||
///
|
||||
/// If a type `T` conforms to the `Real` protocol, then `T` and `Complex<T>`
|
||||
/// If a type `T` conforms to the ``Real`` protocol, then `T` and `Complex<T>`
|
||||
/// both conform to `AlgebraicField`.
|
||||
///
|
||||
/// See also `Real`, `SignedNumeric`, `Numeric` and `AdditiveArithmetic`.
|
||||
/// See also Swift's `SignedNumeric`, `Numeric` and `AdditiveArithmetic`
|
||||
/// protocols.
|
||||
///
|
||||
/// [field]: https://en.wikipedia.org/wiki/Field_(mathematics)
|
||||
public protocol AlgebraicField: SignedNumeric {
|
||||
public protocol AlgebraicField: SignedNumeric where Magnitude: AlgebraicField {
|
||||
|
||||
/// Replaces a with the (approximate) quotient `a/b`.
|
||||
static func /=(a: inout Self, b: Self)
|
||||
@@ -90,10 +91,10 @@ public protocol AlgebraicField: SignedNumeric {
|
||||
/// ```
|
||||
var reciprocal: Self? { get }
|
||||
|
||||
/// a + b, with the optimizer licensed to reassociate and form FMAs.
|
||||
/// `a + b`, with the optimizer licensed to reassociate and form FMAs.
|
||||
static func _relaxedAdd(_ a: Self, _ b: Self) -> Self
|
||||
|
||||
/// a * b, with the optimizer licensed to reassociate and form FMAs.
|
||||
/// `a * b`, with the optimizer licensed to reassociate and form FMAs.
|
||||
static func _relaxedMul(_ a: Self, _ b: Self) -> Self
|
||||
}
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2020-2025 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
|
||||
@@ -47,7 +47,7 @@ extension Numeric where Magnitude: FloatingPoint {
|
||||
/// property implements a valid norm.)
|
||||
///
|
||||
/// - `isApproximatelyEqual(to:relativeTolerance:norm:)` is _scale invariant_,
|
||||
/// so long as no underflow or overflow has occured, and no exceptional
|
||||
/// so long as no underflow or overflow has occurred, and no exceptional
|
||||
/// value is produced by the scaling.
|
||||
///
|
||||
/// See also `isApproximatelyEqual(to:absoluteTolerance:[relativeTolerance:norm:])`.
|
||||
@@ -218,7 +218,7 @@ extension AdditiveArithmetic {
|
||||
/// norm: \.length
|
||||
/// )
|
||||
/// ```
|
||||
/// (if we used the default norm, `.magnitude`, we would be testing if
|
||||
/// (if we used the default norm, `\.magnitude`, we would be testing if
|
||||
/// `z` were inside a square region instead.)
|
||||
@inlinable
|
||||
public func isApproximatelyEqual<Magnitude>(
|
||||
@@ -227,12 +227,6 @@ extension AdditiveArithmetic {
|
||||
relativeTolerance: Magnitude = 0,
|
||||
norm: (Self) -> Magnitude
|
||||
) -> Bool
|
||||
// TODO: constraint should really be weaker than FloatingPoint,
|
||||
// but we need to have `isFinite` for it to work correctly with
|
||||
// floating-point magnitudes in generic contexts, which is the
|
||||
// most common case. The fix for this is to lift the isFinite
|
||||
// requirement to Numeric in the standard library, but that's
|
||||
// source-breaking, so requires an ABI rumspringa.
|
||||
where Magnitude: FloatingPoint {
|
||||
assert(
|
||||
absoluteTolerance >= 0 && absoluteTolerance.isFinite,
|
||||
|
||||
@@ -2,19 +2,13 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2020-2025 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
/// A namespace for "augmented arithmetic" operations for types conforming to
|
||||
/// `Real`.
|
||||
///
|
||||
/// Augmented arithmetic refers to a family of algorithms that represent
|
||||
/// the results of floating-point computations using multiple values such that
|
||||
/// either the error is minimized or the result is exact.
|
||||
public enum Augmented { }
|
||||
|
||||
extension Augmented {
|
||||
@@ -45,7 +39,9 @@ extension Augmented {
|
||||
/// - If both `head` and `tail` are normal, then `a * b` is exactly
|
||||
/// equal to `head + tail` when computed as real numbers.
|
||||
@_transparent
|
||||
public static func product<T:Real>(_ a: T, _ b: T) -> (head: T, tail: T) {
|
||||
public static func product<T:FloatingPoint>(
|
||||
_ a: T, _ b: T
|
||||
) -> (head: T, tail: T) {
|
||||
let head = a*b
|
||||
// TODO: consider providing an FMA-less implementation for use when
|
||||
// targeting platforms without hardware FMA support. This works everywhere,
|
||||
@@ -56,24 +52,30 @@ extension Augmented {
|
||||
|
||||
/// The sum `a + b` represented as an implicit sum `head + tail`.
|
||||
///
|
||||
/// `head` is the correctly rounded value of `a + b`. `tail` is the
|
||||
/// error from that computation rounded to the closest representable
|
||||
/// value.
|
||||
///
|
||||
/// Unlike `Augmented.product(a, b)`, the rounding error of a sum can
|
||||
/// never underflow.
|
||||
///
|
||||
/// This operation is sometimes called ["fastTwoSum"].
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - a: The summand with larger magnitude.
|
||||
/// - b: The summand with smaller magnitude.
|
||||
///
|
||||
/// Preconditions:
|
||||
/// `head` is the correctly rounded value of `a + b`. `tail` is the
|
||||
/// error from that computation rounded to the closest representable
|
||||
/// value.
|
||||
///
|
||||
/// - `large.magnitude` must not be smaller than `small.magnitude`.
|
||||
/// They may be equal, or one or both may be `NaN`.
|
||||
/// This precondition is only enforced in debug builds.
|
||||
/// > Note:
|
||||
/// > `tail` is guaranteed to be the best approximation to the error of
|
||||
/// the sum only if `large.magnitude` >= `small.magnitude`. If this is
|
||||
/// not the case, then `head` is the correctly rounded sum, but `tail`
|
||||
/// is not guaranteed to be the exact error. If you do not know a priori
|
||||
/// how the magnitudes of `a` and `b` compare, you likely want to use
|
||||
/// ``sum(_:_:)`` instead.
|
||||
///
|
||||
/// Unlike ``product(_:_:)``, the rounding error of `sum` never underflows.
|
||||
///
|
||||
/// This operation is sometimes called ["fastTwoSum"].
|
||||
///
|
||||
/// > Note:
|
||||
/// > Classical fastTwoSum does not work when `radix` is 10. This function
|
||||
/// will fall back on another algorithm for decimal floating-point types
|
||||
/// to ensure correct results.
|
||||
///
|
||||
/// Edge Cases:
|
||||
///
|
||||
@@ -88,35 +90,36 @@ extension Augmented {
|
||||
///
|
||||
/// ["fastTwoSum"]: https://en.wikipedia.org/wiki/2Sum
|
||||
@_transparent
|
||||
public static func sum<T:Real>(large a: T, small b: T) -> (head: T, tail: T) {
|
||||
assert(!(b.magnitude > a.magnitude))
|
||||
public static func sum<T: FloatingPoint>(
|
||||
large a: T, small b: T
|
||||
) -> (head: T, tail: T) {
|
||||
// Fall back on 2Sum if radix != 2. Future implementations might use an
|
||||
// cheaper algorithm specialized for decimal FP, but must deliver a
|
||||
// correct result if the preconditions are satisfied.
|
||||
guard T.radix == 2 else { return sum(a, b) }
|
||||
// Fast2Sum:
|
||||
let head = a + b
|
||||
let tail = a - head + b
|
||||
return (head, tail)
|
||||
}
|
||||
|
||||
|
||||
/// The sum `a + b` represented as an implicit sum `head + tail`.
|
||||
///
|
||||
/// `head` is the correctly rounded value of `a + b`. `tail` is the
|
||||
/// error from that computation rounded to the closest representable
|
||||
/// value.
|
||||
///
|
||||
/// Unlike `Augmented.sum(large: a, small: b)`, the magnitude of the summands
|
||||
/// does not matter and `a.magnitude` might as well be strictly less than
|
||||
/// `b.magnitude`. However, it is recommended to only use this function over
|
||||
/// `Augmented.sum(large: a, small: b)` in cases where the ordering of the
|
||||
/// summands magnitude is unknown at compile time. In cases where either of
|
||||
/// the summands magnitude is guaranteed to be greater than or equal the
|
||||
/// magnitude of the other summand, use `Augmented.sum(large: a, small: b)`
|
||||
/// over this function; as it faster to calculate.
|
||||
/// Unlike ``sum(large:small:)``, the magnitude of the summands does not
|
||||
/// matter. If you know statically that `a.magnitude >= b.magnitude`, you
|
||||
/// should use ``sum(large:small:)``. If you do not have such a static
|
||||
/// bound, you should use this function instead.
|
||||
///
|
||||
/// Unlike `Augmented.product(a, b)`, the rounding error of a sum can
|
||||
/// never underflow.
|
||||
/// Unlike ``product(_:_:)``, the rounding error of `sum` never underflows.
|
||||
///
|
||||
/// This operation is sometimes called ["twoSum"].
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - a: One of the summand
|
||||
/// - a: One of the summands
|
||||
/// - b: The other summand
|
||||
///
|
||||
/// Edge Cases:
|
||||
@@ -126,13 +129,15 @@ extension Augmented {
|
||||
/// interpreted as having any meaning (it may be `NaN` or `infinity`).
|
||||
///
|
||||
/// Postconditions:
|
||||
///
|
||||
///
|
||||
/// - If `head` is normal, then `abs(tail) < head.ulp`.
|
||||
/// Assuming IEEE 754 default rounding, `abs(tail) <= head.ulp/2`.
|
||||
///
|
||||
/// ["twoSum"]: https://en.wikipedia.org/wiki/2Sum
|
||||
@_transparent
|
||||
public static func sum<T: Real>(_ a: T, _ b: T) -> (head: T, tail: T) {
|
||||
public static func sum<T: FloatingPoint>(
|
||||
_ a: T, _ b: T
|
||||
) -> (head: T, tail: T) {
|
||||
let head = a + b
|
||||
let x = head - b
|
||||
let y = head - x
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# ``Augmented``
|
||||
|
||||
A namespace for a family of algorithms that compute the results of floating-
|
||||
point arithmetic using multiple values such that either the error is minimized
|
||||
or the result is exact.
|
||||
|
||||
## Overview
|
||||
|
||||
Consider multiplying two Doubles. A Double has 53 significand bits, so their
|
||||
product could be up to 106 bits wide before it is rounded to a Double result.
|
||||
So up to 53 of those 106 bits will be "lost" in that process:
|
||||
|
||||
```swift
|
||||
let a = 1.0 + .ulpOfOne // 1 + 2⁻⁵²
|
||||
let b = 1.0 - .ulpOfOne // 1 - 2⁻⁵²
|
||||
let c = a * b // 1 - 2⁻¹⁰⁴ before rounding, rounds to 1.0
|
||||
```
|
||||
|
||||
Sometimes it is necessary to preserve some or all of those low-order bits;
|
||||
maybe a subsequent subtraction cancels most of the high-order bits, and so
|
||||
the low-order part of the product suddenly becomes significant:
|
||||
|
||||
```swift
|
||||
let result = 1 - c // exactly zero, but "should be" 2⁻¹⁰⁴
|
||||
```
|
||||
|
||||
Augmented arithmetic is a building-block that library writers can use to
|
||||
handle cases like this more carefully. For the example above, one might
|
||||
compute:
|
||||
|
||||
```swift
|
||||
let (head, tail) = Augmented.product(a,b)
|
||||
```
|
||||
|
||||
`head` is then 1.0 and `tail` is -2⁻¹⁰⁴, so no information has been lost.
|
||||
Of course, the result is now split across two Doubles instead of one, but the
|
||||
information in `tail` can be carried forward into future computations.
|
||||
@@ -0,0 +1,68 @@
|
||||
# ``ElementaryFunctions``
|
||||
|
||||
A type that has elementary functions (`sin`, `cos`, etc.) available.
|
||||
|
||||
## Overview
|
||||
|
||||
An ["elementary function"][elfn] is a function built up from powers, roots,
|
||||
exponentials, logarithms, trigonometric functions (sin, cos, tan) and
|
||||
their inverses, and the hyperbolic functions (sinh, cosh, tanh) and their
|
||||
inverses.
|
||||
|
||||
Conformance to this protocol means that all of these building blocks are
|
||||
available as static functions on the type.
|
||||
|
||||
```swift
|
||||
let x: Float = 1
|
||||
let y = Float.sin(x) // 0.84147096
|
||||
```
|
||||
|
||||
`ElementaryFunctions` conformance implies `AdditiveArithmetic`, so addition
|
||||
and subtraction and the `zero` property are also available.
|
||||
|
||||
``RealFunctions`` refines this protocol and adds additional functions that
|
||||
are primarily used with real numbers, such as ``RealFunctions/atan2(y:x:)``
|
||||
and ``RealFunctions/exp10(_:)``.
|
||||
|
||||
``Real`` conforms to `RealFunctions` and `FloatingPoint`, and is the
|
||||
protocol that you will use most often for generic code.
|
||||
|
||||
## Topics
|
||||
|
||||
There are a few families of functions defined by `ElementaryFunctions`:
|
||||
|
||||
### Exponential functions
|
||||
- ``exp(_:)``
|
||||
- ``expMinusOne(_:)``
|
||||
|
||||
### Logarithmetic functions
|
||||
- ``log(_:)``
|
||||
- ``log(onePlus:)``
|
||||
|
||||
### Power and root functions:
|
||||
- ``pow(_:_:)-9imp6``
|
||||
- ``pow(_:_:)-2qmul``
|
||||
- ``sqrt(_:)``
|
||||
- ``root(_:_:)``
|
||||
|
||||
### Trigonometric functions
|
||||
- ``cos(_:)``
|
||||
- ``sin(_:)``
|
||||
- ``tan(_:)``
|
||||
|
||||
### Inverse trigonometric functions
|
||||
- ``acos(_:)``
|
||||
- ``asin(_:)``
|
||||
- ``atan(_:)``
|
||||
|
||||
### Hyperbolic functions
|
||||
- ``cosh(_:)``
|
||||
- ``sinh(_:)``
|
||||
- ``tanh(_:)``
|
||||
|
||||
### Inverse hyperbolic functions
|
||||
- ``acosh(_:)``
|
||||
- ``asinh(_:)``
|
||||
- ``atanh(_:)``
|
||||
|
||||
[elfn]: http://en.wikipedia.org/wiki/Elementary_function
|
||||
@@ -0,0 +1,27 @@
|
||||
# ``RealFunctions``
|
||||
|
||||
A type that extends ``ElementaryFunctions`` with additional operations that
|
||||
are primarily used with real numbers.
|
||||
|
||||
## Topics
|
||||
|
||||
### Exponential functions
|
||||
- ``exp2(_:)``
|
||||
- ``exp10(_:)``
|
||||
|
||||
### Logarithmetic functions
|
||||
- ``log2(_:)``
|
||||
- ``log10(_:)``
|
||||
|
||||
### Plane geometry
|
||||
- ``atan2(y:x:)``
|
||||
- ``hypot(_:_:)``
|
||||
|
||||
### Gamma function
|
||||
- ``gamma(_:)``
|
||||
- ``logGamma(_:)``
|
||||
- ``signGamma(_:)``
|
||||
|
||||
### Error function
|
||||
- ``erf(_:)``
|
||||
- ``erfc(_:)``
|
||||
@@ -0,0 +1,28 @@
|
||||
# ``RealModule``
|
||||
|
||||
Extensions on the Swift standard library that provide functionality for
|
||||
floating-point types.
|
||||
|
||||
## Overview
|
||||
|
||||
``RealModule`` provides four protocols that extend the standard library's
|
||||
numeric protocol hierarchy: AlgebraicField, ElementaryFunctions,
|
||||
RealFunctions, and Real.
|
||||
|
||||
Types conforming to AlgebraicField represent
|
||||
[fields](https://en.wikipedia.org/wiki/Field_(mathematics)). These are the
|
||||
mathematical structures that typically form the elements of vectors and
|
||||
matrices, so this protocol is appropriate for writing generic code to do
|
||||
linear-algebra-type operations.
|
||||
|
||||
ElementaryFunctions provides bindings for the "math functions": the logarithm
|
||||
and exponential functions, sine, cosine and tangent as well as their inverses,
|
||||
and other functions that you may be familiar with from trigonometry and
|
||||
calculus. RealFunctions refines ElementaryFunctions and provides functions that
|
||||
are primarily used with the real numbers, such as atan2, erf and gamma, and
|
||||
the base-2 and -10 logarithm and exponential funtions.
|
||||
|
||||
The Real protocol is a convenient name for the intersection of `FloatingPoint`,
|
||||
`RealFunctions`, and `AlgebraicField`; this is the protocol that you are most
|
||||
likely to want to constrain to when writing generic "math" code that works
|
||||
with floating-point types.
|
||||
@@ -0,0 +1,53 @@
|
||||
# ``Relaxed``
|
||||
|
||||
A namespace for a family of operations that "relax" the usual rules for
|
||||
floating-point to allow reassociation of arithmetic and FMA formation.
|
||||
|
||||
## Overview
|
||||
|
||||
Because of rounding, and the arithmetic rules for infinity and NaN values,
|
||||
floating-point addition and multiplication are not associative:
|
||||
|
||||
```swift
|
||||
let ε = Double.leastNormalMagnitude
|
||||
let sumLeft = (-1 + 1) + ε // 0 + ε = ε
|
||||
let sumRight = -1 + (1 + ε) // -1 + 1 = 0
|
||||
|
||||
let ∞ = Double.infinity
|
||||
let productLeft = (ε * ε) * ∞ // 0 * ∞ = .nan
|
||||
let productRight = ε * (ε * ∞) // ε * ∞ = ∞
|
||||
```
|
||||
|
||||
For some algorithms, the distinction between these results is incidental; for
|
||||
some others it is critical to their correct function. Because of this,
|
||||
compilers cannot freely change the order of reductions, which prevents some
|
||||
important optimizations: extraction of instruction-level parallelism and
|
||||
vectorization.
|
||||
|
||||
If you know that you are in a case where the order of elements being summed
|
||||
or multiplied is incidental, the Relaxed operations give you a mechanism
|
||||
to communicate that to the compiler and unlock these optimizations. For
|
||||
example, consider the following two functions:
|
||||
|
||||
```swift
|
||||
func sum(array: [Float]) -> Float {
|
||||
array.reduce(0, +)
|
||||
}
|
||||
|
||||
func relaxedSum(array: [Float]) -> Float {
|
||||
array.reduce(0, Relaxed.sum)
|
||||
}
|
||||
```
|
||||
|
||||
when called on an array with 1000 elements in a Release build, `relaxedSum`
|
||||
is about 8x faster than `sum` on Apple M2, with a similar speedup on Intel
|
||||
processors, without the need for any unsafe code or flags.
|
||||
|
||||
### multiplyAdd
|
||||
|
||||
In addition to `sum` and `product`, `Relaxed` provides the
|
||||
``multiplyAdd(_:_:_:)`` operation, which communciates to the compiler that
|
||||
it is allowed to replace separate multiply and add operations with a single
|
||||
_fused multiply-add_ instruction if its cost model indicates that it would
|
||||
be advantageous to do so. When targeting processors that support this
|
||||
instruction, this may be a significant performance advantage.
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
|
||||
@@ -2,62 +2,19 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
/// A type that has elementary functions available.
|
||||
///
|
||||
/// An ["elementary function"][elfn] is a function built up from powers, roots,
|
||||
/// exponentials, logarithms, trigonometric functions (sin, cos, tan) and
|
||||
/// their inverses, and the hyperbolic functions (sinh, cosh, tanh) and their
|
||||
/// inverses.
|
||||
///
|
||||
/// Conformance to this protocol means that all of these building blocks are
|
||||
/// available as static functions on the type.
|
||||
///
|
||||
/// ```swift
|
||||
/// let x: Float = 1
|
||||
/// let y = Float.sin(x) // 0.84147096
|
||||
/// ```
|
||||
///
|
||||
/// There are three broad families of functions defined by
|
||||
/// `ElementaryFunctions`:
|
||||
/// - Exponential, trigonometric, and hyperbolic functions:
|
||||
/// `exp`, `expMinusOne`, `cos`, `sin`, `tan`, `cosh`, `sinh`, and `tanh`.
|
||||
/// - Logarithmic, inverse trigonometric, and inverse hyperbolic functions:
|
||||
/// `log`, `log(onePlus:)`, `acos`, `asin`, `atan`, `acosh`, `asinh`, and
|
||||
/// `atanh`.
|
||||
/// - Power and root functions:
|
||||
/// `pow`, `sqrt`, and `root`.
|
||||
///
|
||||
/// `ElementaryFunctions` conformance implies `AdditiveArithmetic`, so addition
|
||||
/// and subtraction and the `.zero` property are also available.
|
||||
///
|
||||
/// There are two other protocols that you are more likely to want to use
|
||||
/// directly:
|
||||
///
|
||||
/// `RealFunctions` refines `ElementaryFunctions` and includes
|
||||
/// additional functions specific to real number types.
|
||||
///
|
||||
/// `Real` conforms to `RealFunctions` and `FloatingPoint`, and is the
|
||||
/// protocol that you will want to use most often for generic code.
|
||||
///
|
||||
/// See Also:
|
||||
///
|
||||
/// - `RealFunctions`
|
||||
/// - `Real`
|
||||
///
|
||||
/// [elfn]: http://en.wikipedia.org/wiki/Elementary_function
|
||||
public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// The [exponential function][wiki] e^x whose base `e` is the base of the
|
||||
/// natural logarithm.
|
||||
///
|
||||
/// See also `expMinusOne()`, as well as `exp2()` and `exp10()`
|
||||
/// defined for types conforming to `RealFunctions`.
|
||||
/// For types that conform to ``RealFunctions`` see
|
||||
/// ``RealFunctions/exp2(_:)`` and ``RealFunctions/exp10(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Exponential_function
|
||||
static func exp(_ x: Self) -> Self
|
||||
@@ -68,7 +25,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// catastrophic cancellation and the result will not have full accuracy.
|
||||
/// The `.expMinusOne(x)` function gives you a means to address this problem.
|
||||
///
|
||||
/// As an example, consider the expression `(x + 1)*exp(x) - 1`. When `x`
|
||||
/// As an example, consider the expression `(x + 1) * .exp(x) - 1`. When `x`
|
||||
/// is smaller than `.ulpOfOne`, this expression evaluates to `0.0`, when it
|
||||
/// should actually round to `2*x`. We can get a full-accuracy result by
|
||||
/// using the following instead:
|
||||
@@ -79,8 +36,8 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// This re-written expression delivers an accurate result for all values
|
||||
/// of `x`, not just for small values.
|
||||
///
|
||||
/// See also `exp()`, as well as `exp2()` and `exp10()` defined for types
|
||||
/// conforming to `RealFunctions`.
|
||||
/// For types that conform to ``RealFunctions`` see
|
||||
/// ``RealFunctions/exp2(_:)`` and ``RealFunctions/exp10(_:)``.
|
||||
static func expMinusOne(_ x: Self) -> Self
|
||||
|
||||
/// The [hyperbolic cosine][wiki] of `x`.
|
||||
@@ -90,7 +47,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// 2
|
||||
/// ```
|
||||
///
|
||||
/// See also `sinh()`, `tanh()` and `acosh()`.
|
||||
/// See also ``acosh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Hyperbolic_function
|
||||
static func cosh(_ x: Self) -> Self
|
||||
@@ -102,7 +59,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// 2
|
||||
/// ```
|
||||
///
|
||||
/// See also `cosh()`, `tanh()` and `asinh()`.
|
||||
/// See also ``asinh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Hyperbolic_function
|
||||
static func sinh(_ x: Self) -> Self
|
||||
@@ -114,7 +71,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// cosh(x)
|
||||
/// ```
|
||||
///
|
||||
/// See also `cosh()`, `sinh()` and `atanh()`.
|
||||
/// See also ``atanh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Hyperbolic_function
|
||||
static func tanh(_ x: Self) -> Self
|
||||
@@ -123,7 +80,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, `x` may be interpreted as an angle measured in radians.
|
||||
///
|
||||
/// See also `sin()`, `tan()` and `acos()`.
|
||||
/// See also ``acos(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Cosine
|
||||
static func cos(_ x: Self) -> Self
|
||||
@@ -133,7 +90,7 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, `x` may be interpreted as an angle measured in radians.
|
||||
///
|
||||
/// See also `cos()`, `tan()` and `asin()`.
|
||||
/// See also ``asin(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Sine
|
||||
static func sin(_ x: Self) -> Self
|
||||
@@ -142,49 +99,54 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, `x` may be interpreted as an angle measured in radians.
|
||||
///
|
||||
/// See also `cos()`, `sin()` and `atan()`, as well as `atan2(y:x:)` for
|
||||
/// types that conform to `RealFunctions`.
|
||||
/// See also ``atan(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Tangent
|
||||
static func tan(_ x: Self) -> Self
|
||||
|
||||
/// The [natural logarithm][wiki] of `x`.
|
||||
///
|
||||
/// See also `log(onePlus:)`, as well as `log2()` and `log10()` for types
|
||||
/// that conform to `RealFunctions`.
|
||||
/// For types that conform to ``RealFunctions`` see also
|
||||
/// ``RealFunctions/log2(_:)`` and ``RealFunctions/log10(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Logarithm
|
||||
static func log(_ x: Self) -> Self
|
||||
|
||||
/// log(1 + x), computed in such a way as to maintain accuracy for small x.
|
||||
///
|
||||
/// See also `log()`, as well as `log2()` and `log10()` for types
|
||||
/// that conform to `RealFunctions`.
|
||||
/// For types that conform to ``RealFunctions`` see also
|
||||
/// ``RealFunctions/log2(_:)`` and ``RealFunctions/log10(_:)``.
|
||||
static func log(onePlus x: Self) -> Self
|
||||
|
||||
/// The [inverse hyperbolic cosine][wiki] of `x`.
|
||||
///
|
||||
/// ```
|
||||
/// cosh(acosh(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `asinh()`, `atanh()` and `cosh()`.
|
||||
///
|
||||
/// See also ``cosh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_hyperbolic_function
|
||||
static func acosh(_ x: Self) -> Self
|
||||
|
||||
/// The [inverse hyperbolic sine][wiki] of `x`.
|
||||
///
|
||||
/// ```
|
||||
/// sinh(asinh(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `acosh()`, `atanh()` and `sinh()`.
|
||||
///
|
||||
/// See also ``sinh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_hyperbolic_function
|
||||
static func asinh(_ x: Self) -> Self
|
||||
|
||||
/// The [inverse hyperbolic tangent][wiki] of `x`.
|
||||
///
|
||||
/// ```
|
||||
/// tanh(atanh(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `acosh()`, `asinh()` and `tanh()`.
|
||||
///
|
||||
/// See also ``tanh(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_hyperbolic_function
|
||||
static func atanh(_ x: Self) -> Self
|
||||
@@ -193,10 +155,12 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, the result may be interpreted as an angle measured in
|
||||
/// radians.
|
||||
///
|
||||
/// ```
|
||||
/// cos(acos(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `asin()`, `atan()` and `cos()`.
|
||||
///
|
||||
/// See also ``cos(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
|
||||
static func acos(_ x: Self) -> Self
|
||||
@@ -205,10 +169,12 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, the result may be interpreted as an angle measured in
|
||||
/// radians.
|
||||
///
|
||||
/// ```
|
||||
/// sin(asin(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `acos()`, `atan()` and `sin()`.
|
||||
///
|
||||
/// See also ``sin(_:)``.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
|
||||
static func asin(_ x: Self) -> Self
|
||||
@@ -217,11 +183,14 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
///
|
||||
/// For real types, the result may be interpreted as an angle measured in
|
||||
/// radians.
|
||||
///
|
||||
/// ```
|
||||
/// tan(atan(x)) ≅ x
|
||||
/// ```
|
||||
/// See also `acos()`, `asin()` and `tan()`, as well as `atan2(y:x:)` for
|
||||
/// types that conform to `RealArithmetic`.
|
||||
///
|
||||
/// See also ``tan(_:)``.
|
||||
/// For types that conform to ``RealFunctions``, you will sometimes want
|
||||
/// to use ``RealFunctions/atan2(y:x:)`` instead.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
|
||||
static func atan(_ x: Self) -> Self
|
||||
@@ -233,10 +202,9 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// In particular, this means that if `x` and `y` are both zero, `pow(x,y)`
|
||||
/// is `nan` for real types and `infinity` for complex types, rather than 1.
|
||||
///
|
||||
/// There is also a `pow(_:Self,_:Int)` overload, whose behavior is defined
|
||||
/// in terms of repeated multiplication, and hence returns 1 for this case.
|
||||
///
|
||||
/// See also `sqrt()` and `root()`.
|
||||
/// There is also
|
||||
/// <doc:/documentation/RealModule/ElementaryFunctions/pow(_:_:)-9imp6>,
|
||||
/// whose behavior is defined in terms of repeated multiplication.
|
||||
static func pow(_ x: Self, _ y: Self) -> Self
|
||||
|
||||
/// `x` raised to the nth power.
|
||||
@@ -244,19 +212,13 @@ public protocol ElementaryFunctions: AdditiveArithmetic {
|
||||
/// The edge-cases of this function are defined in terms of repeated
|
||||
/// multiplication or division, rather than exp(n log x). In particular,
|
||||
/// `Float.pow(0, 0)` is 1.
|
||||
///
|
||||
/// See also `sqrt()` and `root()`.
|
||||
static func pow(_ x: Self, _ n: Int) -> Self
|
||||
|
||||
/// The [square root][wiki] of `x`.
|
||||
///
|
||||
/// See also `pow()` and `root()`.
|
||||
///
|
||||
/// [wiki]: https://en.wikipedia.org/wiki/Square_root
|
||||
static func sqrt(_ x: Self) -> Self
|
||||
|
||||
/// The nth root of `x`.
|
||||
///
|
||||
/// See also `pow()` and `sqrt()`.
|
||||
static func root(_ x: Self, _ n: Int) -> Self
|
||||
}
|
||||
@@ -173,9 +173,10 @@ extension Float16: Real {
|
||||
}
|
||||
#endif
|
||||
|
||||
// TODO: once clang stabilizes the calling conventions for _Float16 on Intel,
|
||||
// we can re-enable these; presently the type is disabled on the target.
|
||||
#if !(arch(i386) || arch(x86_64))
|
||||
#if !arch(wasm32)
|
||||
// WASM doesn't have _Float16 on the C side, so we can't define the C hooks
|
||||
// that these use. TODO: implement these as Swift builtins instead.
|
||||
|
||||
@_transparent
|
||||
public static func _relaxedAdd(_ a: Float16, _ b: Float16) -> Float16 {
|
||||
_numerics_relaxed_addf16(a, b)
|
||||
|
||||
@@ -73,5 +73,5 @@ Not having this protocol is a significant missing feature for numerical computin
|
||||
|
||||
[ErrorFunction]: https://en.wikipedia.org/wiki/Error_function
|
||||
[GammaFunction]: https://en.wikipedia.org/wiki/Gamma_function
|
||||
[SE-0246]: https://github.com/apple/swift-evolution/blob/master/proposals/0246-mathable.md
|
||||
[SE-0246]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0246-mathable.md
|
||||
[Sigmoid]: https://en.wikipedia.org/wiki/Sigmoid_function
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -24,23 +24,24 @@
|
||||
/// }
|
||||
/// ```
|
||||
/// See also `ElementaryFunctions`, `RealFunctions` and `AlgebraicField`.
|
||||
public protocol Real: FloatingPoint, RealFunctions, AlgebraicField {
|
||||
}
|
||||
public protocol Real: FloatingPoint, RealFunctions, AlgebraicField { }
|
||||
|
||||
// While `Real` does not provide any additional customization points,
|
||||
// it does allow us to default the implementation of a few operations,
|
||||
// and also provides `signGamma`.
|
||||
extension Real {
|
||||
// Most math libraries do not provide exp10, so we need a default
|
||||
// implementation.
|
||||
// implementation. This is not a great one (if the underlying math
|
||||
// library does not have a sub-ulp accurate pow, this will not get
|
||||
// exact powers of ten right), but suffices in the short term.
|
||||
@_transparent
|
||||
public static func exp10(_ x: Self) -> Self {
|
||||
return pow(10, x)
|
||||
pow(10, x)
|
||||
}
|
||||
|
||||
/// cos(x) - 1, computed in such a way as to maintain accuracy for small x.
|
||||
///
|
||||
/// See also `ElementaryFunctions.expMinusOne()`.
|
||||
/// See also ``ElementaryFunctions/expMinusOne(_:)``.
|
||||
@_transparent
|
||||
public static func cosMinusOne(_ x: Self) -> Self {
|
||||
let sinxOver2 = sin(x/2)
|
||||
@@ -90,7 +91,7 @@ extension Real {
|
||||
|
||||
@_transparent
|
||||
public static func sqrt(_ x: Self) -> Self {
|
||||
return x.squareRoot()
|
||||
x.squareRoot()
|
||||
}
|
||||
|
||||
/// The (approximate) reciprocal (multiplicative inverse) of this number,
|
||||
@@ -128,13 +129,13 @@ extension Real {
|
||||
/// the real reciprocal (when it exists) as follows (I will use circle
|
||||
/// operators to denote real-number arithmetic, and normal operators
|
||||
/// for floating-point arithmetic):
|
||||
///
|
||||
/// a * b.reciprocal! = a * (1/b)
|
||||
/// = a * (1 ⊘ b)(1 + δ₁)
|
||||
/// = (a ⊘ b)(1 + δ₁)(1 + δ₂)
|
||||
/// = (a ⊘ b)(1 + δ₁ + δ₂ + δ₁δ₂)
|
||||
///
|
||||
/// where 0 < δᵢ <= ulpOfOne/2. This gives a roughly 1-ulp error,
|
||||
/// ```
|
||||
/// a * b.reciprocal! = a * (1/b)
|
||||
/// = a * (1 ⊘ b)(1 + δ₁)
|
||||
/// = (a ⊘ b)(1 + δ₁)(1 + δ₂)
|
||||
/// = (a ⊘ b)(1 + δ₁ + δ₂ + δ₁δ₂)
|
||||
/// ```
|
||||
/// where `0 < δᵢ <= ulpOfOne/2`. This gives a roughly 1-ulp error,
|
||||
/// about twice the error bound we get using division. For most
|
||||
/// purposes this is an acceptable error, but if you need to match
|
||||
/// results obtained using division, you should not use this.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2025 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
|
||||
@@ -10,70 +10,89 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
public protocol RealFunctions: ElementaryFunctions {
|
||||
/// `atan(y/x)`, with sign selected according to the quadrant of `(x, y)`.
|
||||
/// The signed angle formed in the plane between the vector `(x,y)` and the
|
||||
/// positive real axis, measured in radians.
|
||||
///
|
||||
/// See also `atan()`.
|
||||
/// The result is in the interval `[-π, π]`.
|
||||
///
|
||||
/// The argument order to `atan2` may be surprising to new programmers.
|
||||
/// The convention of `y` being the first argument goes back at least to
|
||||
/// Fortran IV in 1961 and is generally followed in computing with a few
|
||||
/// notable exceptions (e.g. Mathematica and Excel). This convention was
|
||||
/// originally chosen because of the mathematical definition of the
|
||||
/// function:
|
||||
///
|
||||
/// ```
|
||||
/// atan2(y,x) = atan(y/x) if x > 0
|
||||
/// ```
|
||||
///
|
||||
/// See also ``ElementaryFunctions/atan(_:)``, as well as the `phase` and
|
||||
/// `polar` properties defined on the `Complex` type.
|
||||
static func atan2(y: Self, x: Self) -> Self
|
||||
|
||||
/// The error function evaluated at `x`.
|
||||
///
|
||||
/// See also `erfc()`.
|
||||
/// The [error function](https://en.wikipedia.org/wiki/Error_function)
|
||||
/// evaluated at `x`.
|
||||
static func erf(_ x: Self) -> Self
|
||||
|
||||
/// The complimentary error function evaluated at `x`.
|
||||
///
|
||||
/// See also `erf()`.
|
||||
/// The complimentary [error function](https://en.wikipedia.org/wiki/Error_function)
|
||||
/// evaluated at `x`.
|
||||
static func erfc(_ x: Self) -> Self
|
||||
|
||||
/// 2^x
|
||||
/// 2 raised to the power x.
|
||||
///
|
||||
/// See also `exp()`, `expMinusOne()`, `exp10()`, `log2()` and `pow()`.
|
||||
/// See also ``log2(_:)``, ``ElementaryFunctions/exp(_:)``,
|
||||
/// ``ElementaryFunctions/expMinusOne(_:)``
|
||||
/// and ``ElementaryFunctions/pow(_:_:)-2qmul``.
|
||||
static func exp2(_ x: Self) -> Self
|
||||
|
||||
/// 10^x
|
||||
/// 10 raised to the power x.
|
||||
///
|
||||
/// See also `exp()`, `expMinusOne()`, `exp2()`, `log10()` and `pow()`.
|
||||
/// See also ``log10(_:)``, ``ElementaryFunctions/exp(_:)``,
|
||||
/// ``ElementaryFunctions/expMinusOne(_:)``
|
||||
/// and ``ElementaryFunctions/pow(_:_:)-2qmul``.
|
||||
static func exp10(_ x: Self) -> Self
|
||||
|
||||
/// `sqrt(x*x + y*y)`, computed in a manner that avoids spurious overflow or
|
||||
/// underflow.
|
||||
/// The length of the vector `(x,y)`, computed in a manner that avoids
|
||||
/// spurious overflow or underflow.
|
||||
///
|
||||
/// See also the `length` and `polar` properties defined on the `Complex`
|
||||
/// type.
|
||||
static func hypot(_ x: Self, _ y: Self) -> Self
|
||||
|
||||
/// The gamma function Γ(x).
|
||||
///
|
||||
/// See also `logGamma()` and `signGamma()`.
|
||||
/// The [gamma function](https://en.wikipedia.org/wiki/Gamma_function) Γ(x).
|
||||
static func gamma(_ x: Self) -> Self
|
||||
|
||||
/// The base-2 logarithm of `x`.
|
||||
///
|
||||
/// See also `exp2()`, `log()`, `log(onePlus:)` and `log10()`.
|
||||
/// See also ``exp2(_:)``, ``ElementaryFunctions/log(_:)``,
|
||||
/// and ``ElementaryFunctions/log(onePlus:)``.
|
||||
static func log2(_ x: Self) -> Self
|
||||
|
||||
/// The base-10 logarithm of `x`.
|
||||
///
|
||||
/// See also: `exp10()`, `log()`, `log(onePlus:)` and `log2()`.
|
||||
/// See also ``exp10(_:)``, ``ElementaryFunctions/log(_:)``,
|
||||
/// and ``ElementaryFunctions/log(onePlus:)``.
|
||||
static func log10(_ x: Self) -> Self
|
||||
|
||||
#if !os(Windows)
|
||||
/// The logarithm of the absolute value of the gamma function, log(|Γ(x)|).
|
||||
/// The logarithm of the absolute value of the
|
||||
/// [gamma function](https://en.wikipedia.org/wiki/Gamma_function),
|
||||
/// log(|Γ(x)|).
|
||||
///
|
||||
/// Not available on Windows targets.
|
||||
///
|
||||
/// See also `gamma()` and `signGamma()`.
|
||||
static func logGamma(_ x: Self) -> Self
|
||||
|
||||
/// The sign of the gamma function, Γ(x).
|
||||
/// The sign of the
|
||||
/// [gamma function](https://en.wikipedia.org/wiki/Gamma_function), Γ(x).
|
||||
///
|
||||
/// For `x >= 0`, `signGamma(x)` is `.plus`. For negative `x`, `signGamma(x)`
|
||||
/// is `.plus` when `x` is an integer, and otherwise it is `.minus` whenever
|
||||
/// `trunc(x)` is even, and `.plus` when `trunc(x)` is odd.
|
||||
///
|
||||
/// This function is used together with `logGamma`, which computes the
|
||||
/// This function is used together with ``logGamma(_:)``, which computes the
|
||||
/// logarithm of the absolute value of Γ(x), to recover the sign information.
|
||||
///
|
||||
/// Not available on Windows targets.
|
||||
///
|
||||
/// See also `gamma()` and `logGamma()`.
|
||||
static func signGamma(_ x: Self) -> FloatingPointSign
|
||||
#endif
|
||||
}
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2021-2025 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
|
||||
@@ -11,12 +11,11 @@
|
||||
|
||||
import _NumericsShims
|
||||
|
||||
/// A namespace for "relaxed arithmetic" operations for types conforming to
|
||||
/// `AlgebraicField`.
|
||||
public enum Relaxed { }
|
||||
|
||||
extension Relaxed {
|
||||
/// a+b with the optimizer licensed to reassociate expressions and form FMAs.
|
||||
/// a+b, but grants the optimizer permission to reassociate expressions
|
||||
/// and form FMAs.
|
||||
///
|
||||
/// Floating-point addition is not an associative operation, so the Swift
|
||||
/// compiler does not have any flexibility in how it evaluates an expression
|
||||
@@ -45,7 +44,8 @@ extension Relaxed {
|
||||
T._relaxedAdd(a, b)
|
||||
}
|
||||
|
||||
/// a*b with the optimizer licensed to reassociate expressions and form FMAs.
|
||||
/// a*b, but grants the optimizer permission to reassociate expressions
|
||||
/// and form FMAs.
|
||||
///
|
||||
/// Floating-point addition and multiplication are not associative operations,
|
||||
/// so the Swift compiler does not have any flexibility in how it evaluates
|
||||
|
||||
@@ -9,6 +9,10 @@
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#define HEADER_SHIM static inline __attribute__((__always_inline__))
|
||||
|
||||
// This header uses most of the libm functions, but we don't want to end up
|
||||
@@ -385,7 +389,7 @@ HEADER_SHIM long double libm_lgammal(long double x, int *signp) {
|
||||
// MARK: - math inlines with relaxed semantics to support optimization.
|
||||
#define CLANG_RELAX_FP _Pragma("clang fp reassociate(on) contract(fast)")
|
||||
|
||||
#if !(__i386__ || __x86_64__)
|
||||
#if !defined __wasm__ // No _Float16 on wasm
|
||||
/// a + b with the "allow reassociation" and "allow FMA formation" flags
|
||||
/// set in the IR.
|
||||
HEADER_SHIM _Float16 _numerics_relaxed_addf16(_Float16 a, _Float16 b) {
|
||||
@@ -450,3 +454,7 @@ HEADER_SHIM void _numerics_optimization_barrier(const void *pointer) {
|
||||
}
|
||||
|
||||
#undef CLANG_RELAX_FP
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2017-2021 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2017-2024 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
|
||||
@@ -281,17 +281,11 @@ extension DoubleWidth : FixedWidthInteger {
|
||||
by rhs: DoubleWidth
|
||||
) -> (partialValue: DoubleWidth, overflow: Bool) {
|
||||
let (carry, product) = multipliedFullWidth(by: rhs)
|
||||
let result = DoubleWidth(truncatingIfNeeded: product)
|
||||
|
||||
let isNegative = DoubleWidth.isSigned &&
|
||||
(self < (0 as DoubleWidth)) != (rhs < (0 as DoubleWidth))
|
||||
let didCarry = isNegative
|
||||
? carry != ~(0 as DoubleWidth)
|
||||
: carry != (0 as DoubleWidth)
|
||||
let hadPositiveOverflow =
|
||||
DoubleWidth.isSigned && !isNegative && product.leadingZeroBitCount == 0
|
||||
|
||||
return (result, didCarry || hadPositiveOverflow)
|
||||
let partialValue = DoubleWidth(truncatingIfNeeded: product)
|
||||
// Overflow has occured if carry is not just the sign-extension of
|
||||
// partialValue (which is zero when Base is unsigned).
|
||||
let overflow = carry != (partialValue >> DoubleWidth.bitWidth)
|
||||
return (partialValue, overflow)
|
||||
}
|
||||
|
||||
public func quotientAndRemainder(
|
||||
@@ -331,7 +325,11 @@ extension DoubleWidth : FixedWidthInteger {
|
||||
if DoubleWidth.isSigned && other == -1 && self == .min { return (0, true) }
|
||||
return (quotientAndRemainder(dividingBy: other).remainder, false)
|
||||
}
|
||||
|
||||
|
||||
// When using a pre-Swift 6.0 runtime, `&*` is not a protocol requirement of
|
||||
// FixedWidthInteger, which results in the default implementation of this
|
||||
// operation ending up recursively calling itself forever. In order to avoid
|
||||
// this, we keep the concrete implementation around.
|
||||
public func multipliedFullWidth(
|
||||
by other: DoubleWidth
|
||||
) -> (high: DoubleWidth, low: DoubleWidth.Magnitude) {
|
||||
@@ -453,18 +451,21 @@ extension DoubleWidth : FixedWidthInteger {
|
||||
|
||||
/// Returns this value "masked" by its bit width.
|
||||
///
|
||||
/// "Masking" notionally involves repeatedly incrementing or decrementing this
|
||||
/// value by `self.bitWidth` until the result is contained in the range
|
||||
/// `0..<self.bitWidth`.
|
||||
/// "Masking" notionally involves repeatedly incrementing or decrementing
|
||||
/// this value by `self.bitWidth` until the result is contained in the
|
||||
/// range `0..<self.bitWidth`.
|
||||
internal func _masked() -> DoubleWidth {
|
||||
// FIXME(integers): test types with bit widths that aren't powers of 2
|
||||
let bits = DoubleWidth(DoubleWidth.bitWidth)
|
||||
if DoubleWidth.bitWidth.nonzeroBitCount == 1 {
|
||||
return self & DoubleWidth(DoubleWidth.bitWidth &- 1)
|
||||
return self & (bits &- 1)
|
||||
}
|
||||
if DoubleWidth.isSigned && self._storage.high < (0 as High) {
|
||||
return self % DoubleWidth(DoubleWidth.bitWidth) + self
|
||||
}
|
||||
return self % DoubleWidth(DoubleWidth.bitWidth)
|
||||
let reduced = self % bits
|
||||
// bitWidth is always positive, but the value being reduced might have
|
||||
// been negative, in which case reduced will also be negative. We need
|
||||
// the representative in [0, bitWidth), so conditionally add the count
|
||||
// to get the positive residue.
|
||||
if Base.isSigned && reduced < 0 { return reduced &+ bits }
|
||||
return reduced
|
||||
}
|
||||
|
||||
public static func &<<=(lhs: inout DoubleWidth, rhs: DoubleWidth) {
|
||||
@@ -590,6 +591,31 @@ extension DoubleWidth : FixedWidthInteger {
|
||||
precondition(!overflow, "Overflow in %=")
|
||||
lhs = result
|
||||
}
|
||||
|
||||
public static func &+(
|
||||
lhs: DoubleWidth, rhs: DoubleWidth
|
||||
) -> DoubleWidth {
|
||||
let (low, carry) = lhs.low.addingReportingOverflow(rhs.low)
|
||||
let high = lhs.high &+ rhs.high &+ (carry ? 1 : 0)
|
||||
return DoubleWidth(high, low)
|
||||
}
|
||||
|
||||
public static func &-(
|
||||
lhs: DoubleWidth, rhs: DoubleWidth
|
||||
) -> DoubleWidth {
|
||||
let (low, borrow) = lhs.low.subtractingReportingOverflow(rhs.low)
|
||||
let high = lhs.high &- rhs.high &- (borrow ? 1 : 0)
|
||||
return DoubleWidth(high, low)
|
||||
}
|
||||
|
||||
public static func &*(
|
||||
lhs: DoubleWidth, rhs: DoubleWidth
|
||||
) -> DoubleWidth {
|
||||
let p00 = lhs.low.multipliedFullWidth(by: rhs.low)
|
||||
let p10 = lhs.high &* Base(truncatingIfNeeded: rhs.low)
|
||||
let p01 = Base(truncatingIfNeeded: lhs.low) &* rhs.high
|
||||
return DoubleWidth(p10 &+ p01 &+ Base(truncatingIfNeeded: p00.high), p00.low)
|
||||
}
|
||||
|
||||
public init(_truncatingBits bits: UInt) {
|
||||
_storage.low = Low(_truncatingBits: bits)
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- Error.swift ------------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2020 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
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- Interval.swift ---------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2020 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
|
||||
|
||||
@@ -1,460 +0,0 @@
|
||||
//===--- BigIntTests.swift ------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2020 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 BigIntModule
|
||||
import XCTest
|
||||
|
||||
extension BigInt {
|
||||
|
||||
static func fac(_ n: BigInt) -> BigInt {
|
||||
precondition(n >= 0, "Factorial of a negative integer is undefined")
|
||||
return stride(from: n, to: 1, by: -1).reduce(into: 1, { $0 *= $1 })
|
||||
}
|
||||
|
||||
// inspired by https://eli.thegreenplace.net/2009/03/21/efficient-integer-exponentiation-algorithms
|
||||
static func pow(_ lhs: BigInt, _ rhs: BigInt) -> BigInt {
|
||||
let bits_of_n = {
|
||||
(n: BigInt) -> [Int] in
|
||||
var bits: [Int] = []
|
||||
var n = n
|
||||
while n != 0 {
|
||||
bits.append(Int(n % 2))
|
||||
n /= 2
|
||||
}
|
||||
|
||||
return bits
|
||||
}
|
||||
|
||||
var r: BigInt = 1
|
||||
for bit in bits_of_n(rhs).reversed() {
|
||||
r *= r
|
||||
if bit == 1 {
|
||||
r *= lhs
|
||||
}
|
||||
}
|
||||
|
||||
return r
|
||||
}
|
||||
}
|
||||
|
||||
final class BigIntTests: XCTestCase {
|
||||
|
||||
/// Python: `bitWidth = 1024; -(2 ** (bitWidth - 1))`
|
||||
static let descriptionInt1024Min: String =
|
||||
"""
|
||||
-89884656743115795386465259539451236680898848947115328636715040578866337902\
|
||||
750481566354238661203768010560056939935696678829394884407208311246423715319\
|
||||
737062188883946712432742638151109800623047059726541476042502884419075341171\
|
||||
231440736956555270413618581675255342293149119973622969239858152417678164812\
|
||||
112068608
|
||||
"""
|
||||
|
||||
/// Python: `bitWidth = 1024; (2 ** (bitWidth - 1)) - 1`
|
||||
static let descriptionInt1024Max: String =
|
||||
"""
|
||||
89884656743115795386465259539451236680898848947115328636715040578866337902\
|
||||
750481566354238661203768010560056939935696678829394884407208311246423715319\
|
||||
737062188883946712432742638151109800623047059726541476042502884419075341171\
|
||||
231440736956555270413618581675255342293149119973622969239858152417678164812\
|
||||
112068607
|
||||
"""
|
||||
|
||||
/// Python: `numpy.base_repr(math.factorial(512), base=36)`
|
||||
static let descriptionFactorial512_radix36: String =
|
||||
"""
|
||||
7FA5Y7EHR9XHMQ519MBHGYOF8XDYMUX8OZHO9WF1KCM0SSPXV2V45UA73BAFRYM2PFB8CZLTODV\
|
||||
OS3QWA7PYFJ7WAFBI4VF371E27N6XZ4LGWHMFDS4ZH1O3DGNFG4YABUE1G90ORGRTIOGSQVZLSQ\
|
||||
4TKHKHIQ262JVQ0J6LSKAPN5I65AJD33XODVHRNWJ1VSO0Q2FBOUNCPGQG2SFQKR17XHF1OLTV2\
|
||||
MVNJVTDAIYWVJ9ZH7KXT0EPS00IGIVC7MNCU25HFWE37KNMSJQUL5ALUCE5XZVPFQCQGEVEB93B\
|
||||
GA8LKG67PVZ7Q9QMQKIVNIMPT2973MVDTD1D1A0A4QT6NBZYR0TGSZXBV1PD0CHW4SKZJSLBS4Z\
|
||||
W5WCKDY8BCQCE17KKADVLCTVSQL1BZ2PL52DDPB8S5L0ZEG2ZAZF9V4TNJJNO1D9U9JU7B264QZ\
|
||||
5GLHC3Q0Y3BTECGTI8GRENQ2FV4HSEZKPM9OG302KLSY9MBCSOO0FN229AST84TT87LYWOOS71C\
|
||||
54RPJ9RTO9875Z9DE3HPH89EW5I3SV219O04UU09A4KME7DD7IH49ABO79NR4EXFX1VLL4YOHSA\
|
||||
7AHD1LS5YKZ66F4UPG0RCBGG000000000000000000000000000000000000000000000000000\
|
||||
000000000000000000000000000000000000000000000000000000000000000000000000000
|
||||
"""
|
||||
|
||||
// MARK: - Basic arithmetic
|
||||
|
||||
func testDivision() {
|
||||
let num1 = BigInt("18446744073709551616")!
|
||||
let den1 = BigInt(123)
|
||||
let expected1 = BigInt(UInt64(149973529054549200))
|
||||
XCTAssertEqual(num1 / den1, expected1)
|
||||
|
||||
let num2 = BigInt.pow(BigInt(10), 100)
|
||||
let den2: BigInt = 3
|
||||
let expected2: BigInt = BigInt(String(repeating: "3", count: 100))!
|
||||
let actual2 = num2 / den2
|
||||
XCTAssertEqual(actual2, expected2)
|
||||
|
||||
let num3 = BigInt.pow(BigInt(10), 97)
|
||||
let den3: BigInt = BigInt("33333333333333333333")!
|
||||
let expected3: BigInt = BigInt("300000000000000000003000000000000000000030000000000000000000300000000000000000")!
|
||||
let actual3 = num3 / den3
|
||||
XCTAssertEqual(actual3, expected3)
|
||||
|
||||
let foo = BigInt("12345678901234567890123456789012345678901234567890123456789012345678901234567890")!
|
||||
let bar = BigInt("351235231535161613134135135135")!
|
||||
let baz = foo / bar
|
||||
XCTAssertEqual(baz, BigInt("35149318157164029153358504918339691272847595997760")!)
|
||||
|
||||
XCTAssertNotNil(BigInt(exactly: 2.4e39))
|
||||
XCTAssertNotNil(BigInt(exactly: 1e38))
|
||||
XCTAssertEqual(BigInt(2.4e39) / BigInt(1e38), BigInt(24))
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let expected = BigInt(Float64.random(in: 0x1p64 ... 0x1p255))
|
||||
let divisor = BigInt(Float64.random(in: 0x1p64 ... 0x1p128))
|
||||
let (quotient, remainder) = expected.quotientAndRemainder(dividingBy: divisor)
|
||||
let actual = divisor * quotient + remainder
|
||||
XCTAssertEqual(quotient, expected / divisor)
|
||||
XCTAssertEqual(remainder, expected % divisor)
|
||||
XCTAssertEqual(
|
||||
actual, expected,
|
||||
"""
|
||||
## FAILURE ##
|
||||
~~~~~~~~~~~~~
|
||||
actual: \(actual)
|
||||
!= expected: \(expected)
|
||||
~~~~~~~~~~~~~
|
||||
divisor: \(divisor)
|
||||
* quotient: \(quotient)
|
||||
+ remainder: \(remainder)
|
||||
~~~~~~~~~~~~~
|
||||
""")
|
||||
}
|
||||
}
|
||||
|
||||
func testFactorial() {
|
||||
var expectedNumber: BigInt?
|
||||
var actualNumber: BigInt!
|
||||
var actualString: String!
|
||||
|
||||
measure {
|
||||
expectedNumber = BigInt(Self.descriptionFactorial512_radix36, radix: 36)
|
||||
actualNumber = BigInt.fac(512)
|
||||
actualString = String(actualNumber, radix: 36, uppercase: true)
|
||||
}
|
||||
|
||||
XCTAssertEqual(actualNumber, expectedNumber)
|
||||
XCTAssertEqual(actualString, Self.descriptionFactorial512_radix36)
|
||||
|
||||
XCTAssertEqual(BigInt.fac(0), 1)
|
||||
XCTAssertEqual(BigInt.fac(1), 1)
|
||||
XCTAssertEqual(BigInt.fac(2), 2)
|
||||
XCTAssertEqual(BigInt.fac(3), 6)
|
||||
XCTAssertEqual(BigInt.fac(4), 24)
|
||||
XCTAssertEqual(BigInt.fac(5), 120)
|
||||
XCTAssertEqual(BigInt.fac(6), 720)
|
||||
XCTAssertEqual(BigInt.fac(7), 5040)
|
||||
XCTAssertEqual(BigInt.fac(8), 40320)
|
||||
XCTAssertEqual(BigInt.fac(9), 362880)
|
||||
}
|
||||
|
||||
func testMath() {
|
||||
let foo = BigInt.pow(10, 20)
|
||||
let bar = BigInt("1234567890123456789012345678901234567890")!
|
||||
|
||||
let baz = foo + bar
|
||||
|
||||
XCTAssertEqual(baz, BigInt("1234567890123456789112345678901234567890")!)
|
||||
|
||||
let fooz = foo >> BigInt(10)
|
||||
XCTAssertEqual(fooz, foo / 1024)
|
||||
|
||||
let barz = BigInt(1) << 64
|
||||
XCTAssertEqual(barz, BigInt(UInt64.max) + 1)
|
||||
}
|
||||
|
||||
func testNegation() {
|
||||
let foo = BigInt("1234567890123456789012345678901234567890")!
|
||||
let bar = BigInt(0) - foo
|
||||
|
||||
XCTAssertEqual(-foo, bar)
|
||||
|
||||
var baz = foo
|
||||
baz.negate()
|
||||
XCTAssertEqual(baz, bar)
|
||||
}
|
||||
|
||||
func testSignum() {
|
||||
XCTAssertEqual(BigInt(-0x1p1023).signum(), -1)
|
||||
XCTAssertEqual(BigInt(Int64.min).signum(), -1)
|
||||
XCTAssertEqual(BigInt(Int32.min).signum(), -1)
|
||||
XCTAssertEqual(BigInt(Int16.min).signum(), -1)
|
||||
XCTAssertEqual(BigInt(Int8.min).signum(), -1)
|
||||
XCTAssertEqual(BigInt(-1).signum(), -1)
|
||||
XCTAssertEqual(BigInt(0).signum(), 0)
|
||||
XCTAssertEqual(BigInt(+1).signum(), +1)
|
||||
XCTAssertEqual(BigInt(Int8.max).signum(), +1)
|
||||
XCTAssertEqual(BigInt(Int16.max).signum(), +1)
|
||||
XCTAssertEqual(BigInt(Int32.max).signum(), +1)
|
||||
XCTAssertEqual(BigInt(Int64.max).signum(), +1)
|
||||
XCTAssertEqual(BigInt(+0x1p1023).signum(), +1)
|
||||
}
|
||||
|
||||
func testTrailingZeroCount() {
|
||||
let foo = BigInt(1) << 300
|
||||
XCTAssertEqual(foo.trailingZeroBitCount, 300)
|
||||
|
||||
let bar = (BigInt(1) << 300) + 0b101000
|
||||
XCTAssertEqual(bar.trailingZeroBitCount, 3)
|
||||
}
|
||||
|
||||
// MARK: - Comparing and hashing
|
||||
|
||||
func testComparable() {
|
||||
let foo = BigInt("1234567890123456789012345678901234567890")!
|
||||
let bar = foo * foo
|
||||
|
||||
XCTAssertLessThan(foo, bar)
|
||||
XCTAssertFalse(foo < foo)
|
||||
XCTAssertFalse(bar < bar)
|
||||
XCTAssertFalse(foo > foo)
|
||||
XCTAssertFalse(bar > bar)
|
||||
XCTAssertGreaterThan(bar, foo)
|
||||
|
||||
let baz = bar * -1
|
||||
|
||||
XCTAssertLessThan(baz, foo)
|
||||
XCTAssertNotEqual(bar, baz)
|
||||
XCTAssertFalse(baz < baz)
|
||||
}
|
||||
|
||||
func testComparison() {
|
||||
let foo = BigInt(-10)
|
||||
let bar = BigInt(-20)
|
||||
|
||||
XCTAssert(foo > bar)
|
||||
XCTAssert(bar < foo)
|
||||
XCTAssert(foo == BigInt(-10))
|
||||
|
||||
let baz = BigInt.pow(foo, -bar)
|
||||
XCTAssertEqual(baz, BigInt("100000000000000000000")!)
|
||||
}
|
||||
|
||||
func testExample() {
|
||||
let bar = BigInt(exactly: -100)
|
||||
XCTAssertNotNil(bar)
|
||||
if let bar = bar {
|
||||
XCTAssertLessThan(bar, 0)
|
||||
XCTAssertGreaterThan(-bar, 0)
|
||||
XCTAssertEqual(-bar, BigInt(100))
|
||||
}
|
||||
XCTAssertEqual(-BigInt("-1234567890123456789012345678901234567890")!,
|
||||
+BigInt("+1234567890123456789012345678901234567890")!)
|
||||
}
|
||||
|
||||
func testHashable() {
|
||||
let foo = BigInt("1234567890123456789012345678901234567890")!
|
||||
let bar = BigInt("1234567890123456789112345678901234567890")!
|
||||
let baz: BigInt = 153
|
||||
|
||||
let dict = [ foo: "Hello", bar: "World", baz: "!" ]
|
||||
|
||||
let hash = foo.hashValue
|
||||
print(hash)
|
||||
|
||||
XCTAssertEqual(dict[foo]!, "Hello")
|
||||
XCTAssertEqual(dict[bar]!, "World")
|
||||
}
|
||||
|
||||
func testClampingConversion() {
|
||||
XCTAssertEqual(BigInt(clamping: UInt64.max), BigInt(UInt64(18446744073709551615)))
|
||||
}
|
||||
|
||||
func testUIntConversion() {
|
||||
let foo = BigInt(UInt.max)
|
||||
XCTAssertNotEqual(foo, BigInt(-1))
|
||||
|
||||
let bar = BigInt(bitPattern: UInt.max)
|
||||
XCTAssertEqual(bar, BigInt(-1))
|
||||
}
|
||||
|
||||
// MARK: - Converting to/from textual representations
|
||||
|
||||
func testCodable() throws {
|
||||
let lowerBound = BigInt("-1234567890123456789012345678901234567890")!
|
||||
let upperBound = BigInt("+1234567890123456789012345678901234567890")!
|
||||
let expectedRange: Range<BigInt> = lowerBound ..< upperBound
|
||||
|
||||
let encoder = JSONEncoder()
|
||||
let decoder = JSONDecoder()
|
||||
let data = try encoder.encode(expectedRange)
|
||||
let actualRange = try decoder.decode(Range<BigInt>.self, from: data)
|
||||
|
||||
XCTAssertEqual(actualRange, expectedRange)
|
||||
}
|
||||
|
||||
func testCustomStringConvertible() {
|
||||
XCTAssertEqual("\(BigInt(UInt64.min) - 2)", "-2")
|
||||
XCTAssertEqual("\(BigInt(UInt64.min) - 1)", "-1")
|
||||
XCTAssertEqual("\(BigInt(UInt64.min) + 0)", "0")
|
||||
XCTAssertEqual("\(BigInt(UInt64.min) + 1)", "1")
|
||||
XCTAssertEqual("\(BigInt(UInt64.min) + 2)", "2")
|
||||
|
||||
XCTAssertEqual("\(BigInt(UInt64.max) - 2)", "18446744073709551613")
|
||||
XCTAssertEqual("\(BigInt(UInt64.max) - 1)", "18446744073709551614")
|
||||
XCTAssertEqual("\(BigInt(UInt64.max) + 0)", "18446744073709551615")
|
||||
XCTAssertEqual("\(BigInt(UInt64.max) + 1)", "18446744073709551616")
|
||||
XCTAssertEqual("\(BigInt(UInt64.max) + 2)", "18446744073709551617")
|
||||
|
||||
XCTAssertEqual("\(BigInt(Int64.min) - 2)", "-9223372036854775810")
|
||||
XCTAssertEqual("\(BigInt(Int64.min) - 1)", "-9223372036854775809")
|
||||
XCTAssertEqual("\(BigInt(Int64.min) + 0)", "-9223372036854775808")
|
||||
XCTAssertEqual("\(BigInt(Int64.min) + 1)", "-9223372036854775807")
|
||||
XCTAssertEqual("\(BigInt(Int64.min) + 2)", "-9223372036854775806")
|
||||
|
||||
XCTAssertEqual("\(BigInt(Int64.max) - 2)", "9223372036854775805")
|
||||
XCTAssertEqual("\(BigInt(Int64.max) - 1)", "9223372036854775806")
|
||||
XCTAssertEqual("\(BigInt(Int64.max) + 0)", "9223372036854775807")
|
||||
XCTAssertEqual("\(BigInt(Int64.max) + 1)", "9223372036854775808")
|
||||
XCTAssertEqual("\(BigInt(Int64.max) + 2)", "9223372036854775809")
|
||||
|
||||
XCTAssertEqual("\(-(BigInt(1) << 1023))", Self.descriptionInt1024Min)
|
||||
XCTAssertEqual("\(+(BigInt(1) << 1023) - 1)", Self.descriptionInt1024Max)
|
||||
}
|
||||
|
||||
func testLosslessStringConvertible() {
|
||||
XCTAssertNil(BigInt(""))
|
||||
XCTAssertNil(BigInt("-"))
|
||||
XCTAssertNil(BigInt("+"))
|
||||
XCTAssertNil(BigInt("A"))
|
||||
XCTAssertNil(BigInt(" 0"))
|
||||
XCTAssertNil(BigInt("0 "))
|
||||
|
||||
XCTAssertEqual(BigInt(UInt64.min) - 2, BigInt("-2"))
|
||||
XCTAssertEqual(BigInt(UInt64.min) - 1, BigInt("-1"))
|
||||
XCTAssertEqual(BigInt(UInt64.min) + 0, BigInt("0"))
|
||||
XCTAssertEqual(BigInt(UInt64.min) + 1, BigInt("1"))
|
||||
XCTAssertEqual(BigInt(UInt64.min) + 2, BigInt("2"))
|
||||
|
||||
XCTAssertEqual(BigInt(UInt64.max) - 2, BigInt("18446744073709551613"))
|
||||
XCTAssertEqual(BigInt(UInt64.max) - 1, BigInt("18446744073709551614"))
|
||||
XCTAssertEqual(BigInt(UInt64.max) + 0, BigInt("18446744073709551615"))
|
||||
XCTAssertEqual(BigInt(UInt64.max) + 1, BigInt("18446744073709551616"))
|
||||
XCTAssertEqual(BigInt(UInt64.max) + 2, BigInt("18446744073709551617"))
|
||||
|
||||
XCTAssertEqual(BigInt(Int64.min) - 2, BigInt("-9223372036854775810"))
|
||||
XCTAssertEqual(BigInt(Int64.min) - 1, BigInt("-9223372036854775809"))
|
||||
XCTAssertEqual(BigInt(Int64.min) + 0, BigInt("-9223372036854775808"))
|
||||
XCTAssertEqual(BigInt(Int64.min) + 1, BigInt("-9223372036854775807"))
|
||||
XCTAssertEqual(BigInt(Int64.min) + 2, BigInt("-9223372036854775806"))
|
||||
|
||||
XCTAssertEqual(BigInt(Int64.max) - 2, BigInt("9223372036854775805"))
|
||||
XCTAssertEqual(BigInt(Int64.max) - 1, BigInt("9223372036854775806"))
|
||||
XCTAssertEqual(BigInt(Int64.max) + 0, BigInt("9223372036854775807"))
|
||||
XCTAssertEqual(BigInt(Int64.max) + 1, BigInt("9223372036854775808"))
|
||||
XCTAssertEqual(BigInt(Int64.max) + 2, BigInt("9223372036854775809"))
|
||||
|
||||
XCTAssertEqual(-(BigInt(1) << 1023), BigInt(Self.descriptionInt1024Min))
|
||||
XCTAssertEqual(+(BigInt(1) << 1023) - 1, BigInt(Self.descriptionInt1024Max))
|
||||
}
|
||||
|
||||
func testRadicesAndNumerals() {
|
||||
for radix in 2 ... 36 {
|
||||
for uppercase in [false, true] {
|
||||
for _ in 0 ..< 100 {
|
||||
let expectedNumber = BigInt(Int.random(in: .min ... .max))
|
||||
let expectedString = String(expectedNumber,
|
||||
radix: radix,
|
||||
uppercase: uppercase)
|
||||
let actualNumber = BigInt(expectedString, radix: radix)
|
||||
XCTAssertEqual(actualNumber, expectedNumber)
|
||||
if radix == 10 {
|
||||
let actualString = expectedNumber.description
|
||||
XCTAssertEqual(actualString, expectedString)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Converting from floating-point binary types
|
||||
|
||||
func testBinaryFloatingPoint<T>(_ type: T.Type) where T: BinaryFloatingPoint {
|
||||
var expected = BigInt(T.greatestFiniteMagnitude.significandBitPattern)
|
||||
expected |= BigInt(1) << T.significandBitCount
|
||||
expected <<= T.greatestFiniteMagnitude.exponent
|
||||
expected >>= T.significandBitCount
|
||||
|
||||
XCTAssertEqual(BigInt(exactly: -T.greatestFiniteMagnitude), -expected)
|
||||
XCTAssertEqual(BigInt(exactly: +T.greatestFiniteMagnitude), +expected)
|
||||
XCTAssertEqual(BigInt(-T.greatestFiniteMagnitude), -expected)
|
||||
XCTAssertEqual(BigInt(+T.greatestFiniteMagnitude), +expected)
|
||||
|
||||
XCTAssertNil(BigInt(exactly: -T.infinity))
|
||||
XCTAssertNil(BigInt(exactly: +T.infinity))
|
||||
|
||||
XCTAssertNil(BigInt(exactly: -T.leastNonzeroMagnitude))
|
||||
XCTAssertNil(BigInt(exactly: +T.leastNonzeroMagnitude))
|
||||
XCTAssertEqual(BigInt(-T.leastNonzeroMagnitude), 0)
|
||||
XCTAssertEqual(BigInt(+T.leastNonzeroMagnitude), 0)
|
||||
|
||||
XCTAssertNil(BigInt(exactly: -T.leastNormalMagnitude))
|
||||
XCTAssertNil(BigInt(exactly: +T.leastNormalMagnitude))
|
||||
XCTAssertEqual(BigInt(-T.leastNormalMagnitude), 0)
|
||||
XCTAssertEqual(BigInt(+T.leastNormalMagnitude), 0)
|
||||
|
||||
XCTAssertNil(BigInt(exactly: T.nan))
|
||||
XCTAssertNil(BigInt(exactly: T.signalingNaN))
|
||||
|
||||
XCTAssertNil(BigInt(exactly: -T.pi))
|
||||
XCTAssertNil(BigInt(exactly: +T.pi))
|
||||
XCTAssertEqual(BigInt(-T.pi), -3)
|
||||
XCTAssertEqual(BigInt(+T.pi), +3)
|
||||
|
||||
XCTAssertNil(BigInt(exactly: -T.ulpOfOne))
|
||||
XCTAssertNil(BigInt(exactly: +T.ulpOfOne))
|
||||
XCTAssertEqual(BigInt(-T.ulpOfOne), 0)
|
||||
XCTAssertEqual(BigInt(+T.ulpOfOne), 0)
|
||||
|
||||
XCTAssertEqual(BigInt(exactly: -T.zero), 0)
|
||||
XCTAssertEqual(BigInt(exactly: +T.zero), 0)
|
||||
XCTAssertEqual(BigInt(-T.zero), 0)
|
||||
XCTAssertEqual(BigInt(+T.zero), 0)
|
||||
}
|
||||
|
||||
func testBinaryFloatingPoint() {
|
||||
testBinaryFloatingPoint(Float32.self)
|
||||
testBinaryFloatingPoint(Float64.self)
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
testBinaryFloatingPoint(Float80.self)
|
||||
#endif
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float32.random(in: -10 ... +10)
|
||||
XCTAssertEqual(BigInt(small), BigInt(Int64(small)))
|
||||
|
||||
let large = Float32.random(in: -0x1p23 ... +0x1p23)
|
||||
XCTAssertEqual(BigInt(large), BigInt(Int64(large)))
|
||||
}
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float64.random(in: -10 ... +10)
|
||||
XCTAssertEqual(BigInt(small), BigInt(Int64(small)))
|
||||
|
||||
let large = Float64.random(in: -0x1p52 ... +0x1p52)
|
||||
XCTAssertEqual(BigInt(large), BigInt(Int64(large)))
|
||||
}
|
||||
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float80.random(in: -10 ... +10)
|
||||
XCTAssertEqual(BigInt(small), BigInt(Int64(small)))
|
||||
|
||||
let large = Float80.random(in: -0x1p63 ..< +0x1p63)
|
||||
XCTAssertEqual(BigInt(large), BigInt(Int64(large)))
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
@@ -1,360 +0,0 @@
|
||||
//===--- BigUIntTests.swift -----------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 - 2020 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 BigIntModule
|
||||
import XCTest
|
||||
|
||||
extension BigUInt {
|
||||
|
||||
static func fac(_ n: BigUInt) -> BigUInt {
|
||||
return stride(from: n, to: 1, by: -1).reduce(into: 1, { $0 *= $1 })
|
||||
}
|
||||
|
||||
// inspired by https://eli.thegreenplace.net/2009/03/21/efficient-integer-exponentiation-algorithms
|
||||
static func pow(_ lhs: BigUInt, _ rhs: BigUInt) -> BigUInt {
|
||||
let bits_of_n = { (n: BigUInt) -> [Int] in
|
||||
var bits: [Int] = []
|
||||
var n = n
|
||||
while n != 0 {
|
||||
bits.append(Int(n % 2))
|
||||
n /= 2
|
||||
}
|
||||
|
||||
return bits
|
||||
}
|
||||
|
||||
var r: BigUInt = 1
|
||||
for bit in bits_of_n(rhs).reversed() {
|
||||
r *= r
|
||||
if bit == 1 {
|
||||
r *= lhs
|
||||
}
|
||||
}
|
||||
|
||||
return r
|
||||
}
|
||||
}
|
||||
|
||||
final class BigUIntTests: XCTestCase {
|
||||
|
||||
/// Python: `bitWidth = 1024; -(2 ** (bitWidth - 1))`
|
||||
static let descriptionInt1024Min: String =
|
||||
"""
|
||||
-89884656743115795386465259539451236680898848947115328636715040578866337902\
|
||||
750481566354238661203768010560056939935696678829394884407208311246423715319\
|
||||
737062188883946712432742638151109800623047059726541476042502884419075341171\
|
||||
231440736956555270413618581675255342293149119973622969239858152417678164812\
|
||||
112068608
|
||||
"""
|
||||
|
||||
/// Python: `bitWidth = 1024; (2 ** (bitWidth - 1)) - 1`
|
||||
static let descriptionInt1024Max: String =
|
||||
"""
|
||||
89884656743115795386465259539451236680898848947115328636715040578866337902\
|
||||
750481566354238661203768010560056939935696678829394884407208311246423715319\
|
||||
737062188883946712432742638151109800623047059726541476042502884419075341171\
|
||||
231440736956555270413618581675255342293149119973622969239858152417678164812\
|
||||
112068607
|
||||
"""
|
||||
|
||||
/// Python: `numpy.base_repr(math.factorial(512), base=36)`
|
||||
static let descriptionFactorial512_radix36: String =
|
||||
"""
|
||||
7FA5Y7EHR9XHMQ519MBHGYOF8XDYMUX8OZHO9WF1KCM0SSPXV2V45UA73BAFRYM2PFB8CZLTODV\
|
||||
OS3QWA7PYFJ7WAFBI4VF371E27N6XZ4LGWHMFDS4ZH1O3DGNFG4YABUE1G90ORGRTIOGSQVZLSQ\
|
||||
4TKHKHIQ262JVQ0J6LSKAPN5I65AJD33XODVHRNWJ1VSO0Q2FBOUNCPGQG2SFQKR17XHF1OLTV2\
|
||||
MVNJVTDAIYWVJ9ZH7KXT0EPS00IGIVC7MNCU25HFWE37KNMSJQUL5ALUCE5XZVPFQCQGEVEB93B\
|
||||
GA8LKG67PVZ7Q9QMQKIVNIMPT2973MVDTD1D1A0A4QT6NBZYR0TGSZXBV1PD0CHW4SKZJSLBS4Z\
|
||||
W5WCKDY8BCQCE17KKADVLCTVSQL1BZ2PL52DDPB8S5L0ZEG2ZAZF9V4TNJJNO1D9U9JU7B264QZ\
|
||||
5GLHC3Q0Y3BTECGTI8GRENQ2FV4HSEZKPM9OG302KLSY9MBCSOO0FN229AST84TT87LYWOOS71C\
|
||||
54RPJ9RTO9875Z9DE3HPH89EW5I3SV219O04UU09A4KME7DD7IH49ABO79NR4EXFX1VLL4YOHSA\
|
||||
7AHD1LS5YKZ66F4UPG0RCBGG000000000000000000000000000000000000000000000000000\
|
||||
000000000000000000000000000000000000000000000000000000000000000000000000000
|
||||
"""
|
||||
|
||||
// MARK: - Basic arithmetic
|
||||
|
||||
func testDivision() {
|
||||
let num1 = BigUInt("18446744073709551616")!
|
||||
let den1 = BigUInt(123)
|
||||
let expected1 = BigUInt(UInt64(149973529054549200))
|
||||
XCTAssertEqual(num1 / den1, expected1)
|
||||
|
||||
let num2 = BigUInt.pow(BigUInt(10), 100)
|
||||
let den2: BigUInt = 3
|
||||
let expected2: BigUInt = BigUInt(String(repeating: "3", count: 100))!
|
||||
let actual2 = num2 / den2
|
||||
XCTAssertEqual(actual2, expected2)
|
||||
|
||||
let num3 = BigUInt.pow(BigUInt(10), 97)
|
||||
let den3: BigUInt = BigUInt("33333333333333333333")!
|
||||
let expected3: BigUInt = BigUInt("300000000000000000003000000000000000000030000000000000000000300000000000000000")!
|
||||
let actual3 = num3 / den3
|
||||
XCTAssertEqual(actual3, expected3)
|
||||
|
||||
let foo = BigUInt("12345678901234567890123456789012345678901234567890123456789012345678901234567890")!
|
||||
let bar = BigUInt("351235231535161613134135135135")!
|
||||
let baz = foo / bar
|
||||
XCTAssertEqual(baz, BigUInt("35149318157164029153358504918339691272847595997760")!)
|
||||
|
||||
XCTAssertNotNil(BigUInt(exactly: 2.4e39))
|
||||
XCTAssertNotNil(BigUInt(exactly: 1e38))
|
||||
XCTAssertEqual(BigUInt(2.4e39) / BigUInt(1e38), BigUInt(24))
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let expected = BigUInt(Float64.random(in: 0x1p64 ... 0x1p255))
|
||||
let divisor = BigUInt(Float64.random(in: 0x1p64 ... 0x1p128))
|
||||
let (quotient, remainder) = expected.quotientAndRemainder(dividingBy: divisor)
|
||||
let actual = divisor * quotient + remainder
|
||||
XCTAssertEqual(quotient, expected / divisor)
|
||||
XCTAssertEqual(remainder, expected % divisor)
|
||||
XCTAssertEqual(
|
||||
actual, expected,
|
||||
"""
|
||||
## FAILURE ##
|
||||
~~~~~~~~~~~~~
|
||||
actual: \(actual)
|
||||
!= expected: \(expected)
|
||||
~~~~~~~~~~~~~
|
||||
divisor: \(divisor)
|
||||
* quotient: \(quotient)
|
||||
+ remainder: \(remainder)
|
||||
~~~~~~~~~~~~~
|
||||
""")
|
||||
}
|
||||
}
|
||||
|
||||
func testFactorial() {
|
||||
var expectedNumber: BigUInt?
|
||||
var actualNumber: BigUInt!
|
||||
var actualString: String!
|
||||
|
||||
measure {
|
||||
expectedNumber = BigUInt(Self.descriptionFactorial512_radix36, radix: 36)
|
||||
actualNumber = BigUInt.fac(512)
|
||||
actualString = String(actualNumber, radix: 36, uppercase: true)
|
||||
}
|
||||
|
||||
XCTAssertEqual(actualNumber, expectedNumber)
|
||||
XCTAssertEqual(actualString, Self.descriptionFactorial512_radix36)
|
||||
|
||||
XCTAssertEqual(BigUInt.fac(0), 1)
|
||||
XCTAssertEqual(BigUInt.fac(1), 1)
|
||||
XCTAssertEqual(BigUInt.fac(2), 2)
|
||||
XCTAssertEqual(BigUInt.fac(3), 6)
|
||||
XCTAssertEqual(BigUInt.fac(4), 24)
|
||||
XCTAssertEqual(BigUInt.fac(5), 120)
|
||||
XCTAssertEqual(BigUInt.fac(6), 720)
|
||||
XCTAssertEqual(BigUInt.fac(7), 5040)
|
||||
XCTAssertEqual(BigUInt.fac(8), 40320)
|
||||
XCTAssertEqual(BigUInt.fac(9), 362880)
|
||||
}
|
||||
|
||||
func testMath() {
|
||||
let foo = BigUInt.pow(10, 20)
|
||||
let bar = BigUInt("1234567890123456789012345678901234567890")!
|
||||
|
||||
let baz = foo + bar
|
||||
|
||||
XCTAssertEqual(baz, BigUInt("1234567890123456789112345678901234567890")!)
|
||||
|
||||
let fooz = foo >> BigUInt(10)
|
||||
XCTAssertEqual(fooz, foo / 1024)
|
||||
|
||||
let barz = BigUInt(1) << 64
|
||||
XCTAssertEqual(barz, BigUInt(UInt64.max) + 1)
|
||||
}
|
||||
|
||||
func testTrailingZeroCount() {
|
||||
let foo = BigUInt(1) << 300
|
||||
XCTAssertEqual(foo.trailingZeroBitCount, 300)
|
||||
|
||||
let bar = (BigUInt(1) << 300) + 0b101000
|
||||
XCTAssertEqual(bar.trailingZeroBitCount, 3)
|
||||
}
|
||||
|
||||
// MARK: - Comparing and hashing
|
||||
|
||||
func testComparable() {
|
||||
let foo = BigUInt("1234567890123456789012345678901234567890")!
|
||||
let bar = foo * foo
|
||||
|
||||
XCTAssertLessThan(foo, bar)
|
||||
XCTAssertFalse(foo < foo)
|
||||
XCTAssertFalse(bar < bar)
|
||||
XCTAssertFalse(foo > foo)
|
||||
XCTAssertFalse(bar > bar)
|
||||
XCTAssertGreaterThan(bar, foo)
|
||||
}
|
||||
|
||||
func testHashable() {
|
||||
let foo = BigInt("1234567890123456789012345678901234567890")!
|
||||
let bar = BigInt("1234567890123456789112345678901234567890")!
|
||||
let baz: BigInt = 153
|
||||
|
||||
let dict = [foo: "Hello", bar: "World", baz: "!"]
|
||||
let hash = foo.hashValue
|
||||
print(hash)
|
||||
|
||||
XCTAssertEqual(dict[foo]!, "Hello")
|
||||
XCTAssertEqual(dict[bar]!, "World")
|
||||
}
|
||||
|
||||
func testClampingConversion() {
|
||||
XCTAssertEqual(BigUInt(clamping: UInt64.max), BigUInt(UInt64(18446744073709551615)))
|
||||
}
|
||||
|
||||
// MARK: - Converting to/from textual representations
|
||||
|
||||
func testCodable() throws {
|
||||
let lowerBound = BigUInt("0")!
|
||||
let upperBound = BigUInt("+1234567890123456789012345678901234567890")!
|
||||
let expectedRange: Range<BigUInt> = lowerBound ..< upperBound
|
||||
|
||||
let encoder = JSONEncoder()
|
||||
let decoder = JSONDecoder()
|
||||
let data = try encoder.encode(expectedRange)
|
||||
let actualRange = try decoder.decode(Range<BigUInt>.self, from: data)
|
||||
|
||||
XCTAssertEqual(actualRange, expectedRange)
|
||||
}
|
||||
|
||||
func testCustomStringConvertible() {
|
||||
XCTAssertEqual("\(BigUInt(UInt64.min) + 0)", "0")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.min) + 1)", "1")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.min) + 2)", "2")
|
||||
|
||||
XCTAssertEqual("\(BigUInt(UInt64.max) - 2)", "18446744073709551613")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.max) - 1)", "18446744073709551614")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.max) + 0)", "18446744073709551615")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.max) + 1)", "18446744073709551616")
|
||||
XCTAssertEqual("\(BigUInt(UInt64.max) + 2)", "18446744073709551617")
|
||||
|
||||
XCTAssertEqual("\(BigUInt(Int64.max) - 2)", "9223372036854775805")
|
||||
XCTAssertEqual("\(BigUInt(Int64.max) - 1)", "9223372036854775806")
|
||||
XCTAssertEqual("\(BigUInt(Int64.max) + 0)", "9223372036854775807")
|
||||
XCTAssertEqual("\(BigUInt(Int64.max) + 1)", "9223372036854775808")
|
||||
XCTAssertEqual("\(BigUInt(Int64.max) + 2)", "9223372036854775809")
|
||||
|
||||
XCTAssertEqual("\(+(BigUInt(1) << 1023) - 1)", Self.descriptionInt1024Max)
|
||||
}
|
||||
|
||||
func testLosslessStringConvertible() {
|
||||
XCTAssertNil(BigUInt(""))
|
||||
XCTAssertNil(BigUInt("+"))
|
||||
XCTAssertNil(BigUInt("A"))
|
||||
XCTAssertNil(BigUInt(" 0"))
|
||||
XCTAssertNil(BigUInt("0 "))
|
||||
|
||||
XCTAssertEqual(BigUInt(UInt64.min) + 0, BigUInt("0"))
|
||||
XCTAssertEqual(BigUInt(UInt64.min) + 1, BigUInt("1"))
|
||||
XCTAssertEqual(BigUInt(UInt64.min) + 2, BigUInt("2"))
|
||||
|
||||
XCTAssertEqual(BigUInt(UInt64.max) - 2, BigUInt("18446744073709551613"))
|
||||
XCTAssertEqual(BigUInt(UInt64.max) - 1, BigUInt("18446744073709551614"))
|
||||
XCTAssertEqual(BigUInt(UInt64.max) + 0, BigUInt("18446744073709551615"))
|
||||
XCTAssertEqual(BigUInt(UInt64.max) + 1, BigUInt("18446744073709551616"))
|
||||
XCTAssertEqual(BigUInt(UInt64.max) + 2, BigUInt("18446744073709551617"))
|
||||
|
||||
XCTAssertEqual(BigUInt(Int64.max) - 2, BigUInt("9223372036854775805"))
|
||||
XCTAssertEqual(BigUInt(Int64.max) - 1, BigUInt("9223372036854775806"))
|
||||
XCTAssertEqual(BigUInt(Int64.max) + 0, BigUInt("9223372036854775807"))
|
||||
XCTAssertEqual(BigUInt(Int64.max) + 1, BigUInt("9223372036854775808"))
|
||||
XCTAssertEqual(BigUInt(Int64.max) + 2, BigUInt("9223372036854775809"))
|
||||
|
||||
XCTAssertEqual(+(BigUInt(1) << 1023) - 1, BigUInt(Self.descriptionInt1024Max))
|
||||
}
|
||||
|
||||
func testRadicesAndNumerals() {
|
||||
for radix in 2 ... 36 {
|
||||
for uppercase in [false, true] {
|
||||
for _ in 0 ..< 100 {
|
||||
let expectedNumber = BigUInt(UInt.random(in: .min ... .max))
|
||||
let expectedString = String(expectedNumber,
|
||||
radix: radix,
|
||||
uppercase: uppercase)
|
||||
let actualNumber = BigUInt(expectedString, radix: radix)
|
||||
XCTAssertEqual(actualNumber, expectedNumber)
|
||||
if radix == 10 {
|
||||
let actualString = expectedNumber.description
|
||||
XCTAssertEqual(actualString, expectedString)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Converting from floating-point binary types
|
||||
|
||||
func testBinaryFloatingPoint<T>(_ type: T.Type) where T: BinaryFloatingPoint {
|
||||
var expected = BigUInt(T.greatestFiniteMagnitude.significandBitPattern)
|
||||
expected |= BigUInt(1) << T.significandBitCount
|
||||
expected <<= T.greatestFiniteMagnitude.exponent
|
||||
expected >>= T.significandBitCount
|
||||
|
||||
XCTAssertEqual(BigUInt(exactly: +T.greatestFiniteMagnitude), +expected)
|
||||
XCTAssertEqual(BigUInt(+T.greatestFiniteMagnitude), +expected)
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: +T.infinity))
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: +T.leastNonzeroMagnitude))
|
||||
XCTAssertEqual(BigUInt(+T.leastNonzeroMagnitude), 0)
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: +T.leastNormalMagnitude))
|
||||
XCTAssertEqual(BigUInt(+T.leastNormalMagnitude), 0)
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: T.nan))
|
||||
XCTAssertNil(BigUInt(exactly: T.signalingNaN))
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: +T.pi))
|
||||
XCTAssertEqual(BigUInt(+T.pi), +3)
|
||||
|
||||
XCTAssertNil(BigUInt(exactly: +T.ulpOfOne))
|
||||
XCTAssertEqual(BigUInt(+T.ulpOfOne), 0)
|
||||
|
||||
XCTAssertEqual(BigUInt(exactly: +T.zero), 0)
|
||||
XCTAssertEqual(BigUInt(+T.zero), 0)
|
||||
}
|
||||
|
||||
func testBinaryFloatingPoint() {
|
||||
testBinaryFloatingPoint(Float32.self)
|
||||
testBinaryFloatingPoint(Float64.self)
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
testBinaryFloatingPoint(Float80.self)
|
||||
#endif
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float32.random(in: 0 ... +10)
|
||||
XCTAssertEqual(BigUInt(small), BigUInt(Int64(small)))
|
||||
|
||||
let large = Float32.random(in: 0 ... +0x1p23)
|
||||
XCTAssertEqual(BigUInt(large), BigUInt(Int64(large)))
|
||||
}
|
||||
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float64.random(in: 0 ... +10)
|
||||
XCTAssertEqual(BigUInt(small), BigUInt(Int64(small)))
|
||||
|
||||
let large = Float64.random(in: -0x1p52 ... +0x1p52)
|
||||
XCTAssertEqual(BigInt(large), BigInt(Int64(large)))
|
||||
}
|
||||
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
for _ in 0 ..< 100 {
|
||||
let small = Float80.random(in: 0 ... +10)
|
||||
XCTAssertEqual(BigUInt(small), BigUInt(Int64(small)))
|
||||
|
||||
let large = Float80.random(in: 0 ..< +0x1p63)
|
||||
XCTAssertEqual(BigUInt(large), BigUInt(Int64(large)))
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
#[[
|
||||
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
|
||||
#]]
|
||||
|
||||
find_package(dispatch CONFIG QUIET)
|
||||
find_package(Foundation CONFIG QUIET)
|
||||
find_package(XCTest CONFIG QUIET)
|
||||
|
||||
add_subdirectory(ComplexTests)
|
||||
add_subdirectory(IntegerUtilitiesTests)
|
||||
add_subdirectory(RealTests)
|
||||
|
||||
add_executable(SwiftNumericsTestRunner
|
||||
WindowsMain.swift)
|
||||
target_link_libraries(SwiftNumericsTestRunner PRIVATE
|
||||
ComplexTests
|
||||
IntegerUtilitiesTests
|
||||
RealTests)
|
||||
|
||||
add_test(NAME SwiftNumericsTestRunner
|
||||
COMMAND SwiftNumericsTestRunner)
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- ApproximateEqualityTests.swift -----------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2020 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019 Apple Inc. and the Swift Numerics project authors
|
||||
// Copyright (c) 2019-2024 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
|
||||
@@ -13,11 +13,23 @@ import XCTest
|
||||
import ComplexModule
|
||||
import RealModule
|
||||
|
||||
func ulpsFromInfinity<T: Real>(_ a: T) -> T {
|
||||
(.greatestFiniteMagnitude - a) / .greatestFiniteMagnitude.ulp + 1
|
||||
}
|
||||
|
||||
// TODO: improve this to be a general-purpose complex comparison with tolerance
|
||||
func relativeError<T>(_ a: Complex<T>, _ b: Complex<T>) -> T {
|
||||
if a == b { return 0 }
|
||||
let scale = max(a.magnitude, b.magnitude, T.leastNormalMagnitude).ulp
|
||||
return (a - b).magnitude / scale
|
||||
if a.isFinite && b.isFinite {
|
||||
let scale = max(a.magnitude, b.magnitude, T.leastNormalMagnitude).ulp
|
||||
return (a - b).magnitude / scale
|
||||
} else {
|
||||
if a.isFinite {
|
||||
return ulpsFromInfinity(a.magnitude)
|
||||
} else {
|
||||
return ulpsFromInfinity(b.magnitude)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func closeEnough<T: Real>(_ a: T, _ b: T, ulps allowed: T) -> Bool {
|
||||
@@ -29,11 +41,15 @@ func checkMultiply<T>(
|
||||
_ a: Complex<T>, _ b: Complex<T>, expected: Complex<T>, ulps allowed: T
|
||||
) -> Bool {
|
||||
let observed = a*b
|
||||
if observed == expected { return false }
|
||||
// Even if the expected result is finite, we allow overflow if
|
||||
// the two-norm of the expected result overflows.
|
||||
if !observed.isFinite && !expected.length.isFinite { return false }
|
||||
let rel = relativeError(observed, expected)
|
||||
if rel > allowed {
|
||||
guard rel <= allowed else {
|
||||
print("Over-large error in \(a)*\(b)")
|
||||
print("Expected: \(expected)\nObserved: \(observed)")
|
||||
print("Relative error was \(rel) (tolerance: \(allowed).")
|
||||
print("Relative error was \(rel) (tolerance: \(allowed)).")
|
||||
return true
|
||||
}
|
||||
return false
|
||||
@@ -43,11 +59,15 @@ func checkDivide<T>(
|
||||
_ a: Complex<T>, _ b: Complex<T>, expected: Complex<T>, ulps allowed: T
|
||||
) -> Bool {
|
||||
let observed = a/b
|
||||
if observed == expected { return false }
|
||||
// Even if the expected result is finite, we allow overflow if
|
||||
// the two-norm of the expected result overflows.
|
||||
if !observed.isFinite && !expected.length.isFinite { return false }
|
||||
let rel = relativeError(observed, expected)
|
||||
if rel > allowed {
|
||||
guard rel <= allowed else {
|
||||
print("Over-large error in \(a)/\(b)")
|
||||
print("Expected: \(expected)\nObserved: \(observed)")
|
||||
print("Relative error was \(rel) (tolerance: \(allowed).")
|
||||
print("Relative error was \(rel) (tolerance: \(allowed)).")
|
||||
return true
|
||||
}
|
||||
return false
|
||||
@@ -63,7 +83,6 @@ final class ArithmeticTests: XCTestCase {
|
||||
func testPolar<T>(_ type: T.Type)
|
||||
where T: BinaryFloatingPoint, T: Real,
|
||||
T.Exponent: FixedWidthInteger, T.RawSignificand: FixedWidthInteger {
|
||||
|
||||
// In order to support round-tripping from rectangular to polar coordinate
|
||||
// systems, as a special case phase can be non-finite when length is
|
||||
// either zero or infinity.
|
||||
@@ -76,10 +95,9 @@ final class ArithmeticTests: XCTestCase {
|
||||
XCTAssertEqual(Complex<T>(length:-.infinity, phase: .infinity), .infinity)
|
||||
XCTAssertEqual(Complex<T>(length:-.infinity, phase:-.infinity), .infinity)
|
||||
XCTAssertEqual(Complex<T>(length:-.infinity, phase: .nan ), .infinity)
|
||||
|
||||
|
||||
let exponentRange =
|
||||
(T.leastNormalMagnitude.exponent + T.Exponent(T.significandBitCount)) ...
|
||||
T.greatestFiniteMagnitude.exponent
|
||||
T.leastNormalMagnitude.exponent ... T.greatestFiniteMagnitude.exponent
|
||||
let inputs = (0..<100).map { _ in
|
||||
Polar(length: T(
|
||||
sign: .plus,
|
||||
@@ -136,20 +154,29 @@ final class ArithmeticTests: XCTestCase {
|
||||
// Now test multiplication and division using the polar inputs:
|
||||
for q in inputs {
|
||||
let w = Complex(length: q.length, phase: q.phase)
|
||||
let product = Complex(length: p.length * q.length, phase: p.phase + q.phase)
|
||||
var product = Complex(length: p.length, phase: p.phase + q.phase)
|
||||
product.real *= q.length
|
||||
product.imaginary *= q.length
|
||||
if checkMultiply(z, w, expected: product, ulps: 16) { XCTFail() }
|
||||
let quotient = Complex(length: p.length / q.length, phase: p.phase - q.phase)
|
||||
var quotient = Complex(length: p.length, phase: p.phase - q.phase)
|
||||
quotient.real /= q.length
|
||||
quotient.imaginary /= q.length
|
||||
if checkDivide(z, w, expected: quotient, ulps: 16) { XCTFail() }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testPolar() {
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64)) && LONG_TESTS
|
||||
if #available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *) {
|
||||
testPolar(Float16.self)
|
||||
}
|
||||
#endif
|
||||
testPolar(Float.self)
|
||||
testPolar(Double.self)
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
#if (arch(i386) || arch(x86_64)) && !os(Windows) && !os(Android)
|
||||
testPolar(Float80.self)
|
||||
#endif
|
||||
#endif
|
||||
}
|
||||
|
||||
func testBaudinSmith() {
|
||||
@@ -191,16 +218,38 @@ final class ArithmeticTests: XCTestCase {
|
||||
Complex(1.02951151789360578e-84, 6.97145987515076231e-220)),
|
||||
]
|
||||
for test in vectors {
|
||||
if checkDivide(test.a, test.b, expected: test.c, ulps: 0.5) { XCTFail() }
|
||||
if checkDivide(test.a, test.b, expected: test.c, ulps: 1.0) { XCTFail() }
|
||||
if checkDivide(test.a, test.c, expected: test.b, ulps: 1.0) { XCTFail() }
|
||||
if checkMultiply(test.b, test.c, expected: test.a, ulps: 1.0) { XCTFail() }
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
func testDivisionByZero() {
|
||||
XCTAssertFalse((Complex(0, 0) / Complex(0, 0)).isFinite)
|
||||
XCTAssertFalse((Complex(1, 1) / Complex(0, 0)).isFinite)
|
||||
XCTAssertFalse((Complex.infinity / Complex(0, 0)).isFinite)
|
||||
XCTAssertFalse((Complex.i / Complex(0, 0)).isFinite)
|
||||
|
||||
}
|
||||
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64)) && LONG_TESTS
|
||||
@available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *)
|
||||
func testFloat16DivisionSemiExhaustive() {
|
||||
func complex(bitPattern: UInt32) -> Complex<Float16> {
|
||||
Complex(
|
||||
Float16(bitPattern: UInt16(truncatingIfNeeded: bitPattern)),
|
||||
Float16(bitPattern: UInt16(truncatingIfNeeded: bitPattern >> 16))
|
||||
)
|
||||
}
|
||||
for bits in 0 ... UInt32.max {
|
||||
let a = complex(bitPattern: bits)
|
||||
if bits & 0xfffff == 0 { print(a) }
|
||||
let b = complex(bitPattern: UInt32.random(in: 0 ... .max))
|
||||
var q = Complex<Float>(a)/Complex<Float>(b)
|
||||
if checkDivide(a, b, expected: Complex<Float16>(q), ulps: 4) { XCTFail() }
|
||||
q = Complex<Float>(b)/Complex<Float>(a)
|
||||
if checkDivide(b, a, expected: Complex<Float16>(q), ulps: 4) { XCTFail() }
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- ElementaryFunctionTests.swift ------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2020 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
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
//===--- main.swift -------------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import Numerics
|
||||
import _TestSupport
|
||||
|
||||
#if DEBUG
|
||||
fatalError("Run this test in Release configuration")
|
||||
#else
|
||||
|
||||
var componentError = Double(Float.ulpOfOne/2)
|
||||
var complexError = Double(Float.ulpOfOne/2)
|
||||
var componentMaxInput = Complex<Float>.zero
|
||||
var complexMaxInput = Complex<Float>.zero
|
||||
|
||||
func test(_ z: Complex<Float>) {
|
||||
let tst = Complex.log(z)
|
||||
// TODO: we _should_ be able to say Complex<Double>(z), but that goes through
|
||||
// the slow, generic path for BinaryFloatingPoint conversion; once we get
|
||||
// that resolved in the standard library, we can replace the conversion on
|
||||
// this and the next line. Currently it dominate testing time if we do that.
|
||||
let ref = Complex.log(Complex(Double(z.real), Double(z.imaginary)))
|
||||
if tst == Complex(Float(ref.real), Float(ref.imaginary)) { return }
|
||||
let thisError = relativeError(tst, ref)
|
||||
if thisError > complexError {
|
||||
complexMaxInput = z
|
||||
complexError = thisError
|
||||
}
|
||||
let thisComponentError = componentwiseError(tst, ref)
|
||||
if thisComponentError > componentError {
|
||||
componentMaxInput = z
|
||||
componentError = thisComponentError
|
||||
}
|
||||
}
|
||||
|
||||
func testWithSymmetries(_ x: Float, _ y: Float) {
|
||||
test(Complex( x, y))
|
||||
test(Complex( y, x))
|
||||
test(Complex(-y, x))
|
||||
test(Complex(-x, y))
|
||||
test(Complex(-x,-y))
|
||||
test(Complex(-y,-x))
|
||||
test(Complex( y,-x))
|
||||
test(Complex( x,-y))
|
||||
}
|
||||
|
||||
// The hardest to evaluate cases for log are those close to the unit circle,
|
||||
// where log(z) is nearly zero. We want to have plausibly dense test coverage
|
||||
// close to the circle.
|
||||
let radii: [Float] = [0.9,
|
||||
0.95,
|
||||
0.99,
|
||||
0.999,
|
||||
0.9999,
|
||||
1 - 10 * .ulpOfOne,
|
||||
1,
|
||||
1 + 10 * .ulpOfOne,
|
||||
1.0001,
|
||||
1.001,
|
||||
1.01,
|
||||
1.05,
|
||||
1.1]
|
||||
|
||||
for r in radii {
|
||||
for x in Interval(from: 1/Float.sqrt(2), to: r) {
|
||||
// Generate the two y values that put us closest to the circle of radius r
|
||||
let base = Double.sqrt(Double(r).addingProduct(Double(-x), Double(x)))
|
||||
let a, b: Float
|
||||
if Double(Float(base)) < base { a = Float(base); b = a.nextUp }
|
||||
else { b = Float(base); a = b.nextDown }
|
||||
testWithSymmetries(x, a)
|
||||
testWithSymmetries(x, b)
|
||||
}
|
||||
}
|
||||
|
||||
// Away from the unit circle is "easy" but we still want to get some coverage.
|
||||
// Generate 1 million uniform random points inside the circle, and then test
|
||||
// both z and 1/z.
|
||||
var g = SystemRandomNumberGenerator()
|
||||
var count = 0
|
||||
while count < 1_000_000 {
|
||||
let z = Complex<Float>(.random(in: -1 ... 1, using: &g), .random(in: -1 ... 1, using: &g))
|
||||
if z.length > 1 { continue }
|
||||
count += 1
|
||||
test(z)
|
||||
test(1/z)
|
||||
}
|
||||
|
||||
print("Worst complex norm error seen for log was \(complexError)")
|
||||
print("For input \(complexMaxInput).")
|
||||
print("Reference result: \(Complex.log(Complex<Double>(complexMaxInput)))")
|
||||
print(" Observed result: \(Complex.log(complexMaxInput))")
|
||||
|
||||
print("Worst componentwise error seen for log was \(componentError)")
|
||||
print("For input \(componentMaxInput).")
|
||||
print("Reference result: \(Complex.log(Complex<Double>(componentMaxInput)))")
|
||||
print(" Observed result: \(Complex.log(componentMaxInput))")
|
||||
|
||||
#endif
|
||||
@@ -1,108 +0,0 @@
|
||||
//===--- main.swift -------------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import Numerics
|
||||
import _TestSupport
|
||||
|
||||
#if DEBUG
|
||||
fatalError("Run this test in Release configuration")
|
||||
#else
|
||||
|
||||
var componentError = Double(Float.ulpOfOne/2)
|
||||
var complexError = Double(Float.ulpOfOne/2)
|
||||
var componentMaxInput = Complex<Float>.zero
|
||||
var complexMaxInput = Complex<Float>.zero
|
||||
|
||||
func test(_ z: Complex<Float>) {
|
||||
let tst = Complex.log(onePlus: z)
|
||||
// TODO: we _should_ be able to say Complex<Double>(z), but that goes through
|
||||
// the slow, generic path for BinaryFloatingPoint conversion; once we get
|
||||
// that resolved in the standard library, we can replace the conversion on
|
||||
// this and the next line. Currently it dominate testing time if we do that.
|
||||
let ref = Complex.log(onePlus: Complex(Double(z.real), Double(z.imaginary)))
|
||||
if tst == Complex(Float(ref.real), Float(ref.imaginary)) { return }
|
||||
let thisError = relativeError(tst, ref)
|
||||
if thisError > complexError {
|
||||
complexMaxInput = z
|
||||
complexError = thisError
|
||||
}
|
||||
let thisComponentError = componentwiseError(tst, ref)
|
||||
if thisComponentError > componentError {
|
||||
componentMaxInput = z
|
||||
componentError = thisComponentError
|
||||
}
|
||||
}
|
||||
|
||||
func testWithSymmetry(_ x: Float, _ y: Float) {
|
||||
test(Complex( x-1, y))
|
||||
test(Complex( y-1, x))
|
||||
test(Complex(-y-1, x))
|
||||
test(Complex(-x-1, y))
|
||||
test(Complex(-x-1,-y))
|
||||
test(Complex(-y-1,-x))
|
||||
test(Complex( y-1,-x))
|
||||
test(Complex( x-1,-y))
|
||||
}
|
||||
|
||||
// The hardest to evaluate cases for log are those close to the unit circle
|
||||
// centered at -1, where log(1+z) is nearly zero. We want to have plausibly
|
||||
// dense test coverage close to the circle.
|
||||
let radii: [Float] = [0.9,
|
||||
0.95,
|
||||
0.99,
|
||||
0.999,
|
||||
0.9999,
|
||||
1 - 10 * .ulpOfOne,
|
||||
1,
|
||||
1 + 10 * .ulpOfOne,
|
||||
1.0001,
|
||||
1.001,
|
||||
1.01,
|
||||
1.05,
|
||||
1.1]
|
||||
|
||||
for r in radii {
|
||||
for x in Interval(from: 1/Float.sqrt(2), to: r) {
|
||||
// Generate the two y values that put us closest to the circle of radius r
|
||||
let base = Double.sqrt(Double(r).addingProduct(Double(-x), Double(x)))
|
||||
let a, b: Float
|
||||
if Double(Float(base)) < base { a = Float(base); b = a.nextUp }
|
||||
else { b = Float(base); a = b.nextDown }
|
||||
testWithSymmetry(x, a)
|
||||
testWithSymmetry(x, b)
|
||||
}
|
||||
}
|
||||
|
||||
// Away from the unit circle is "easy" but we still want to get some coverage.
|
||||
// Generate 1 million uniform random points inside the circle, and then test
|
||||
// both z and 1/z.
|
||||
var g = SystemRandomNumberGenerator()
|
||||
var count = 0
|
||||
while count < 1_000_000 {
|
||||
let z = Complex<Float>(.random(in: -1 ... 1, using: &g), .random(in: -1 ... 1, using: &g))
|
||||
if z.length > 1 { continue }
|
||||
count += 1
|
||||
test(z - 1)
|
||||
test(1/z - 1)
|
||||
}
|
||||
|
||||
print("Worst complex norm error seen for log(onePlus:) was \(complexError)")
|
||||
print("For input \(complexMaxInput).")
|
||||
print("Reference result: \(Complex.log(onePlus: Complex<Double>(complexMaxInput)))")
|
||||
print(" Observed result: \(Complex.log(onePlus: complexMaxInput))")
|
||||
|
||||
print("Worst componentwise error seen for log(onePlus:) was \(componentError)")
|
||||
print("For input \(componentMaxInput).")
|
||||
print("Reference result: \(Complex.log(onePlus: Complex<Double>(componentMaxInput)))")
|
||||
print(" Observed result: \(Complex.log(onePlus: componentMaxInput))")
|
||||
|
||||
#endif
|
||||
@@ -1,23 +0,0 @@
|
||||
#[[
|
||||
This source file is part of the Swift Numerics open source project
|
||||
|
||||
Copyright (c) 2019-2021 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
|
||||
#]]
|
||||
|
||||
add_library(IntegerUtilitiesTests
|
||||
DivideTests.swift
|
||||
DoubleWidthTests.swift
|
||||
GCDTests.swift
|
||||
RotateTests.swift
|
||||
SaturatingArithmeticTests.swift
|
||||
ShiftTests.swift)
|
||||
target_compile_options(IntegerUtilitiesTests PRIVATE
|
||||
-enable-testing)
|
||||
target_link_libraries(IntegerUtilitiesTests PUBLIC
|
||||
$<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>
|
||||
Numerics
|
||||
_TestSupport
|
||||
XCTest)
|
||||
@@ -1,354 +0,0 @@
|
||||
//===--- DivideTests.swift ------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import IntegerUtilities
|
||||
import XCTest
|
||||
|
||||
final class IntegerUtilitiesDivideTests: XCTestCase {
|
||||
|
||||
func divisionRuleHolds<T: BinaryInteger>(_ a: T, _ b: T, _ q: T, _ r: T) -> Bool {
|
||||
// Validate division rule holds: a = qb + r (have to be careful about
|
||||
// computing qb, though, to ensure it does not overflow due to
|
||||
// rounding of q; compute it in two pieces, subtracting the first from
|
||||
// a to avoid intermediate overflow).
|
||||
let b1 = b >> 1
|
||||
let b2 = b - b1
|
||||
let ref = a - q*b1 - q*b2
|
||||
if r != ref {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .down) failed the division rule.
|
||||
a - qb was \(ref), but r is \(r).
|
||||
""")
|
||||
return false
|
||||
}
|
||||
if r.magnitude >= b.magnitude {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .down) failed check on r.
|
||||
|remainder| must be smaller than |divisor|, but was \(r).
|
||||
""")
|
||||
return false
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func testDivideDown<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .down)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now validate sign(r) == sign(b).
|
||||
guard r == 0 || r.signum() == b.signum() else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .down) failed check on r.
|
||||
remainder must match sign of divisor, but was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideUp<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .up)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now validate sign(r) != sign(b).
|
||||
guard r == 0 || r.signum() != b.signum() else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .up) failed check on r.
|
||||
remainder must oppose sign of divisor, but was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideTowardZero<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .towardZero)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now validate sign(r) == sign(a).
|
||||
guard r == 0 || r.signum() == a.signum() else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .towardZero) failed check on r.
|
||||
remainder must match sign of dividend, but was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideAwayFromZero<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .awayFromZero)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now validate sign(r) != sign(a).
|
||||
guard r == 0 || r.signum() != a.signum() else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .awayFromZero) failed check on r.
|
||||
remainder must oppose sign of dividend, but was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideToOdd<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .toOdd)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now validate q is odd if r is
|
||||
// non-zero.
|
||||
guard r == 0 || q & 1 == 1 else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .toOdd) failed check:
|
||||
quotient must be odd if remainder is non-zero, but quotient was \(q) and remainder was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideToNearestOrAway<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .toNearestOrAwayFromZero)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now check |r| <= |b|/2
|
||||
// with equality only if sign(r) != sign(a).
|
||||
if 2*r.magnitude > b.magnitude {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .toNearestOrAwayFromZero) failed check:
|
||||
|remainder| must be less than or equal to |divisor|/2, but remainder was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
if 2*r.magnitude == b.magnitude && r.signum() == a.signum() {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .toNearestOrAwayFromZero) failed check:
|
||||
If |remainder| equals |divisor|/2, remainder must oppose sign of dividend, but was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideToNearestOrEven<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .toNearestOrEven)
|
||||
if divisionRuleHolds(a, b, q, r) {
|
||||
// We know a = bq + r with |r| < |b|. Now check |r| <= |b|/2
|
||||
// with equality only if sign(r) != sign(a).
|
||||
if 2*r.magnitude > b.magnitude {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .toNearestOrEven) failed check:
|
||||
|remainder| must be less than or equal to |divisor|/2, but remainder was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
if 2*r.magnitude == b.magnitude && q & 1 == 1 {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: .toNearestOrEven) failed check:
|
||||
If |remainder| equals |divisor|/2, quotient must be even, but quotient was \(q) and remainder was \(r).
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideStochastic<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
let (q, r) = a.divided(by: b, rounding: .stochastically)
|
||||
let _ = divisionRuleHolds(a, b, q, r)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideExact<T: SignedInteger & FixedWidthInteger>(_ values: [T]) {
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
// Skip any SignedInt.min / -1 cases, because those will trap.
|
||||
if a == .min && b == -1 { continue }
|
||||
// Skip any cases with a remainder (most of them!)
|
||||
if a % b != 0 { continue }
|
||||
// Test that division rule holds ignoring r for the cases that
|
||||
// make it through.
|
||||
let (q, _) = a.divided(by: b, rounding: .requireExact)
|
||||
let _ = divisionRuleHolds(a, b, q, 0)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideInt8() {
|
||||
let values = Array<Int8>(-128 ... 127)
|
||||
testDivideDown(values)
|
||||
testDivideUp(values)
|
||||
testDivideTowardZero(values)
|
||||
testDivideAwayFromZero(values)
|
||||
testDivideToOdd(values)
|
||||
testDivideToNearestOrAway(values)
|
||||
testDivideToNearestOrEven(values)
|
||||
testDivideStochastic(values)
|
||||
testDivideExact(values)
|
||||
}
|
||||
|
||||
func testDivideInt() {
|
||||
var values = [Int](repeating: 0, count: 64)
|
||||
for i in 0 ..< values.count {
|
||||
while values[i] == 0 {
|
||||
values[i] = .random(in: .min ... .max)
|
||||
}
|
||||
}
|
||||
testDivideDown(values)
|
||||
testDivideUp(values)
|
||||
testDivideTowardZero(values)
|
||||
testDivideAwayFromZero(values)
|
||||
testDivideToOdd(values)
|
||||
testDivideToNearestOrAway(values)
|
||||
testDivideToNearestOrEven(values)
|
||||
testDivideStochastic(values)
|
||||
testDivideExact(values)
|
||||
}
|
||||
|
||||
func divideUInt8(_ a: UInt8, _ b: UInt8, rounding rule: RoundingRule) {
|
||||
let expected = UInt8(Int16(a).divided(by: Int16(b), rounding: rule).quotient)
|
||||
let observed = a.divided(by: b, rounding: rule)
|
||||
guard expected == observed else {
|
||||
XCTFail("""
|
||||
\(a).divided(by: \(b), rounding: \(rule)) did not match expected result:
|
||||
Computed with Int16: \(expected)
|
||||
Computed with UInt8: \(observed)
|
||||
""")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func testDivideUInt8() {
|
||||
let values = Array<UInt8>(0 ... 255)
|
||||
for a in values {
|
||||
for b in values where b != 0 {
|
||||
divideUInt8(a, b, rounding: .down)
|
||||
divideUInt8(a, b, rounding: .up)
|
||||
divideUInt8(a, b, rounding: .towardZero)
|
||||
divideUInt8(a, b, rounding: .awayFromZero)
|
||||
divideUInt8(a, b, rounding: .toOdd)
|
||||
divideUInt8(a, b, rounding: .toNearestOrAwayFromZero)
|
||||
divideUInt8(a, b, rounding: .toNearestOrEven)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// stochastically rounding doesn't have a deterministic "expected" answer,
|
||||
// but we know that the result must be either the floor or the ceiling.
|
||||
// The above tests ensure that, but that's not a very strong guarantee;
|
||||
// an implementation could just implement it as self / other and pass
|
||||
// that test.
|
||||
//
|
||||
// Here we round the _same_ value many times, compute the average, and
|
||||
// check that it is acceptably close to the exact expected value; simple
|
||||
// use of any deterministic rounding rule will not achieve this.
|
||||
func testStochasticDivide<T: FixedWidthInteger>(_ a: T, _ b: T) -> Bool {
|
||||
let sum = (0..<1024).reduce(into: 0.0) { sum, _ in
|
||||
let rounded = a.divided(by: b, rounding: .stochastically)
|
||||
sum += Double(rounded)
|
||||
}
|
||||
let expected = 1024 * Double(a) / Double(b)
|
||||
let difference = abs(sum - expected)
|
||||
// Waving my hands slightly instead of giving a precise explanation
|
||||
// here, the expectation is that difference should be about
|
||||
// 1/2 sqrt(1024). If we're more than a couple standard deviations
|
||||
// off, we should flag that. This isn't _necessarily_ a problem,
|
||||
// but if you see a repeated failure, that's almost surely a real bug.
|
||||
//
|
||||
// TODO: precise justification of thresholds
|
||||
XCTAssertLessThanOrEqual(difference, 64,
|
||||
"Accumulated error (\(difference)) was unexpectedly large in \(a).divided(by: \(b))"
|
||||
)
|
||||
return difference > 16
|
||||
}
|
||||
|
||||
func testDivideStochasticInt8() {
|
||||
var values = [Int8](repeating: 0, count: 32)
|
||||
for i in 0 ..< values.count {
|
||||
while values[i] == 0 {
|
||||
values[i] = .random(in: .min ... .max)
|
||||
}
|
||||
}
|
||||
var fails = 0
|
||||
for a in values {
|
||||
for b in values {
|
||||
if a == .min && b == -1 { continue }
|
||||
fails += testStochasticDivide(a, b) ? 1 : 0
|
||||
}
|
||||
}
|
||||
XCTAssertLessThanOrEqual(fails, 32*16)
|
||||
}
|
||||
|
||||
func testDivideStochasticUInt32() {
|
||||
var values = [UInt32](repeating: 0, count: 32)
|
||||
for i in 0 ..< values.count {
|
||||
while values[i] == 0 {
|
||||
values[i] = .random(in: .min ... .max)
|
||||
}
|
||||
}
|
||||
var fails = 0
|
||||
for a in values {
|
||||
for b in values {
|
||||
fails += testStochasticDivide(a, b) ? 1 : 0
|
||||
}
|
||||
}
|
||||
XCTAssertLessThanOrEqual(fails, 32*16)
|
||||
}
|
||||
|
||||
func testRemainderByMinusOne() {
|
||||
// These would trap if implemented as a - bq or similar, even though
|
||||
// the remainder is well-defined.
|
||||
XCTAssertEqual(0, Int.min.remainder(dividingBy: -1))
|
||||
XCTAssertEqual(0, Int.min.remainder(dividingBy: -1, rounding: .up))
|
||||
XCTAssertEqual(0, Int.min.remainder(dividingBy: -1, rounding: .stochastically))
|
||||
}
|
||||
}
|
||||
@@ -1,525 +0,0 @@
|
||||
//===--- DoubleWidthTests.swift -------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2017-2021 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 _TestSupport
|
||||
import XCTest
|
||||
|
||||
final class DoubleWidthTests: XCTestCase {
|
||||
|
||||
typealias _Int16 = DoubleWidth<Int8>
|
||||
typealias _Int128 = DoubleWidth<Int64>
|
||||
typealias _Int256 = DoubleWidth<_Int128>
|
||||
typealias _Int512 = DoubleWidth<_Int256>
|
||||
typealias _Int1024 = DoubleWidth<_Int512>
|
||||
|
||||
typealias _UInt16 = DoubleWidth<UInt8>
|
||||
typealias _UInt128 = DoubleWidth<UInt64>
|
||||
typealias _UInt256 = DoubleWidth<_UInt128>
|
||||
typealias _UInt512 = DoubleWidth<_UInt256>
|
||||
typealias _UInt1024 = DoubleWidth<_UInt512>
|
||||
|
||||
// <https://bugs.swift.org/browse/SR-6947>
|
||||
// Swift 4.x took over 15 minutes to compile this test code.
|
||||
// Swift 5.5 takes less than one second (`-Onone` or `-O` or `-Osize`).
|
||||
func testCompileTime_SR_6947() {
|
||||
typealias _Int32 = DoubleWidth<DoubleWidth<Int8>>
|
||||
typealias _Int64 = DoubleWidth<DoubleWidth<DoubleWidth<Int8>>>
|
||||
|
||||
var sum = 0
|
||||
let (q, r) = (_Int128(Int64.max) * 16).quotientAndRemainder(dividingBy: 16)
|
||||
sum += Int(q * r)
|
||||
XCTAssertEqual(sum, 0)
|
||||
|
||||
let x = _Int64(Int64.max / 4)
|
||||
let y = _Int32(Int32.max)
|
||||
let xx = _Int1024(x)
|
||||
let yy = _Int512(y)
|
||||
let (q3, r3) = yy.dividingFullWidth((xx.high, xx.low))
|
||||
sum -= Int(q3 - r3)
|
||||
XCTAssertEqual(sum, -1)
|
||||
}
|
||||
|
||||
func testLiterals() {
|
||||
let w: _UInt16 = 100
|
||||
XCTAssertTrue(w == 100 as Int)
|
||||
|
||||
let x: _UInt16 = 1000
|
||||
XCTAssertTrue(x == 1000 as Int)
|
||||
|
||||
let y: _Int16 = 1000
|
||||
XCTAssertTrue(y == 1000 as Int)
|
||||
|
||||
let z: _Int16 = -1000
|
||||
XCTAssertTrue(z == -1000 as Int)
|
||||
}
|
||||
|
||||
func testLiterals_Underflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = -1 as _UInt16
|
||||
}
|
||||
|
||||
#if false // TODO: _ExpressibleByBuiltinIntegerLiteral
|
||||
|
||||
func testLiterals_LargeSigned() {
|
||||
let a: _Int256 =
|
||||
0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
let b: _Int256 =
|
||||
-0x8000000000000000000000000000000000000000000000000000000000000000
|
||||
XCTAssertEqual(a, _Int256.max)
|
||||
XCTAssertEqual(b, _Int256.min)
|
||||
}
|
||||
|
||||
func testLiterals_LargeSigned_Underflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = -0x8000000000000000000000000000000000000000000000000000000000000001
|
||||
// as _Int256
|
||||
}
|
||||
|
||||
func testLiterals_LargeSigned_Overflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = 0x8000000000000000000000000000000000000000000000000000000000000000
|
||||
// as _Int256
|
||||
}
|
||||
|
||||
func testLiterals_LargeUnsigned() {
|
||||
let a: _UInt256 =
|
||||
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
let b: _UInt256 = 0
|
||||
XCTAssertEqual(a, _UInt256.max)
|
||||
XCTAssertEqual(b, _UInt256.min)
|
||||
}
|
||||
|
||||
func testLiterals_LargeUnsigned_Underflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = -1 as _UInt256
|
||||
}
|
||||
|
||||
func testLiterals_LargeUnsigned_Overflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0
|
||||
// as _UInt256
|
||||
}
|
||||
|
||||
#endif // TODO: _ExpressibleByBuiltinIntegerLiteral
|
||||
|
||||
func testArithmetic_Unsigned() {
|
||||
let x: _UInt16 = 1000
|
||||
let y: _UInt16 = 1111
|
||||
XCTAssertEqual(x + 1, 1001)
|
||||
XCTAssertEqual(x + x, 2000)
|
||||
XCTAssertEqual(x - (1 as _UInt16), 999)
|
||||
XCTAssertEqual(x - x, 0)
|
||||
XCTAssertEqual(y - x, 111)
|
||||
|
||||
XCTAssertEqual(x * 7, 7000)
|
||||
XCTAssertEqual(y * 7, 7777)
|
||||
|
||||
XCTAssertEqual(x / 3, 333)
|
||||
XCTAssertEqual(x / x, 1)
|
||||
XCTAssertEqual(x / y, 0)
|
||||
XCTAssertEqual(y / x, 1)
|
||||
|
||||
XCTAssertEqual(x % 3, 1)
|
||||
XCTAssertEqual(x % y, x)
|
||||
|
||||
do {
|
||||
let lhs = _UInt16((high: 0b0011_0000, low: 0))
|
||||
let rhs = _UInt16((high: 0b0010_0000, low: 0))
|
||||
XCTAssertEqual(lhs % rhs, 4096)
|
||||
}
|
||||
do {
|
||||
let lhs = _UInt128((high: 0xa0c7d7165cf01386, low: 0xbf3f66a93056143f))
|
||||
let rhs = _UInt128((high: 0x9ac3a19b1e7d6b83, low: 0x513929792d588736))
|
||||
XCTAssertEqual(String(lhs % rhs), "7997221894243298914179865336050715913")
|
||||
}
|
||||
do {
|
||||
let lhs = _UInt128((high: 0xea8a9116b7af33b7, low: 0x3d9d6779ddd22ca3))
|
||||
let rhs = _UInt128((high: 0xc3673efc7f1f37cc, low: 0x312f661057d0ba94))
|
||||
XCTAssertEqual(String(lhs % rhs), "52023287460685389410162512181093036559")
|
||||
}
|
||||
do {
|
||||
let lhs = _UInt256("2369676578372158364766242369061213561181961479062237766620")!
|
||||
let rhs = _UInt256("102797312405202436815976773795958969482")!
|
||||
XCTAssertEqual(String(lhs / rhs), "23051931251193218442")
|
||||
}
|
||||
do {
|
||||
let lhs = _UInt256("96467201117289166187766181030232879447148862859323917044548749804018359008044")!
|
||||
let rhs = _UInt256("4646260627574879223760172113656436161581617773435991717024")!
|
||||
XCTAssertEqual(String(lhs / rhs), "20762331011904583253")
|
||||
}
|
||||
|
||||
XCTAssertTrue((0xff01 as _UInt16).multipliedFullWidth(by: 0x101) == (high: 256, low: 1))
|
||||
}
|
||||
|
||||
func testArithmetic_Signed() {
|
||||
let x: _Int16 = 1000
|
||||
let y: _Int16 = -1111
|
||||
XCTAssertEqual(x + 1, 1001)
|
||||
XCTAssertEqual(x + x, 2000)
|
||||
XCTAssertEqual(x - (1 as _Int16), 999)
|
||||
XCTAssertEqual(x - x, 0)
|
||||
XCTAssertEqual(0 - x, -1000)
|
||||
XCTAssertEqual(x + y, -111)
|
||||
XCTAssertEqual(x - y, 2111)
|
||||
|
||||
XCTAssertEqual(x * 7, 7000)
|
||||
XCTAssertEqual(y * 7, -7777)
|
||||
XCTAssertEqual(x * -7, -7000)
|
||||
XCTAssertEqual(y * -7, 7777)
|
||||
|
||||
XCTAssertEqual(x / 3, 333)
|
||||
XCTAssertEqual(x / -3, -333)
|
||||
XCTAssertEqual(x / x, 1)
|
||||
XCTAssertEqual(x / y, 0)
|
||||
XCTAssertEqual(y / x, -1)
|
||||
XCTAssertEqual(y / y, 1)
|
||||
|
||||
XCTAssertEqual(x % 3, 1)
|
||||
XCTAssertEqual(x % -3, 1)
|
||||
XCTAssertEqual(y % 3, -1)
|
||||
XCTAssertEqual(y % -3, -1)
|
||||
|
||||
XCTAssertEqual(-y, 1111)
|
||||
XCTAssertEqual(-x, -1000)
|
||||
}
|
||||
|
||||
func testNested() {
|
||||
do {
|
||||
let x = _UInt1024.max
|
||||
let (y, o) = x.addingReportingOverflow(1)
|
||||
XCTAssertEqual(y, 0)
|
||||
XCTAssertTrue(y == (0 as Int))
|
||||
XCTAssertTrue(o)
|
||||
}
|
||||
|
||||
do {
|
||||
let x = _Int1024.max
|
||||
let (y, o) = x.addingReportingOverflow(1)
|
||||
XCTAssertEqual(y, _Int1024.min)
|
||||
XCTAssertLessThan(y, 0)
|
||||
XCTAssertTrue(y < (0 as Int))
|
||||
XCTAssertTrue(y < (0 as UInt))
|
||||
XCTAssertTrue(o)
|
||||
}
|
||||
|
||||
XCTAssertFalse(_UInt1024.isSigned)
|
||||
XCTAssertEqual(_UInt1024.bitWidth, 1024)
|
||||
XCTAssertTrue(_Int1024.isSigned)
|
||||
XCTAssertEqual(_Int1024.bitWidth, 1024)
|
||||
|
||||
XCTAssertTrue(
|
||||
_UInt1024.max.words.elementsEqual(
|
||||
repeatElement(UInt.max, count: 1024 / UInt.bitWidth)
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
func testInitialization() {
|
||||
XCTAssertTrue(_UInt16(UInt16.max) == UInt16.max)
|
||||
XCTAssertNil(_UInt16(exactly: UInt32.max))
|
||||
XCTAssertEqual(_UInt16(truncatingIfNeeded: UInt64.max), _UInt16.max)
|
||||
}
|
||||
|
||||
func testInitialization_Overflow() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = _UInt16(UInt32.max)
|
||||
}
|
||||
|
||||
func testMagnitude() {
|
||||
XCTAssertTrue(_UInt16.min.magnitude == UInt16.min.magnitude)
|
||||
XCTAssertTrue((42 as _UInt16).magnitude == (42 as UInt16).magnitude)
|
||||
XCTAssertTrue(_UInt16.max.magnitude == UInt16.max.magnitude)
|
||||
|
||||
XCTAssertTrue(_Int16.min.magnitude == Int16.min.magnitude)
|
||||
XCTAssertTrue((-42 as _Int16).magnitude == (-42 as Int16).magnitude)
|
||||
XCTAssertTrue(_Int16().magnitude == Int16(0).magnitude) // See SR-6602.
|
||||
XCTAssertTrue((42 as _Int16).magnitude == (42 as Int16).magnitude)
|
||||
XCTAssertTrue(_Int16.max.magnitude == Int16.max.magnitude)
|
||||
}
|
||||
|
||||
func testTwoWords() {
|
||||
typealias DW = DoubleWidth<Int>
|
||||
|
||||
XCTAssertEqual(-1 as DW, DW(truncatingIfNeeded: -1 as Int8))
|
||||
|
||||
XCTAssertNil(Int(exactly: DW(Int.min) - 1))
|
||||
XCTAssertNil(Int(exactly: DW(Int.max) + 1))
|
||||
|
||||
XCTAssertTrue(DW(Int.min) - 1 < Int.min)
|
||||
XCTAssertTrue(DW(Int.max) + 1 > Int.max)
|
||||
}
|
||||
|
||||
func testBitwise_LeftAndRightShifts() {
|
||||
typealias _UInt64 = DoubleWidth<DoubleWidth<DoubleWidth<UInt8>>>
|
||||
typealias _Int64 = DoubleWidth<DoubleWidth<DoubleWidth<Int8>>>
|
||||
|
||||
func f<T: FixedWidthInteger, U: FixedWidthInteger>(_ x: T, type: U.Type) {
|
||||
let y = U(x)
|
||||
XCTAssertEqual(T.bitWidth, U.bitWidth)
|
||||
for i in -(T.bitWidth + 1)...(T.bitWidth + 1) {
|
||||
XCTAssertTrue(x << i == y << i)
|
||||
XCTAssertTrue(x >> i == y >> i)
|
||||
|
||||
XCTAssertTrue(x &<< i == y &<< i)
|
||||
XCTAssertTrue(x &>> i == y &>> i)
|
||||
}
|
||||
}
|
||||
|
||||
f(1 as UInt64, type: _UInt64.self)
|
||||
f(~(~0 as UInt64 >> 1), type: _UInt64.self)
|
||||
f(UInt64.max, type: _UInt64.self)
|
||||
// 0b01010101_10100101_11110000_10100101_11110000_10100101_11110000_10100101
|
||||
f(17340530535757639845 as UInt64, type: _UInt64.self)
|
||||
|
||||
f(1 as Int64, type: _Int64.self)
|
||||
f(Int64.min, type: _Int64.self)
|
||||
f(Int64.max, type: _Int64.self)
|
||||
// 0b01010101_10100101_11110000_10100101_11110000_10100101_11110000_10100101
|
||||
f(6171603459878809765 as Int64, type: _Int64.self)
|
||||
}
|
||||
|
||||
func testRemainder_ByZero() {
|
||||
func f(_ x: _Int1024, _ y: _Int1024) -> _Int1024 {
|
||||
return x % y
|
||||
}
|
||||
// TODO: expectCrashLater()
|
||||
// _ = f(42, 0)
|
||||
}
|
||||
|
||||
func testRemainder_ByMinusOne() {
|
||||
func f(_ x: _Int256, _ y: _Int256) -> _Int256 {
|
||||
return x.remainderReportingOverflow(dividingBy: y).partialValue
|
||||
}
|
||||
XCTAssertEqual(f(.max, -1), 0)
|
||||
XCTAssertEqual(f(.min, -1), 0)
|
||||
}
|
||||
|
||||
func testDivision_ByZero() {
|
||||
func f(_ x: _Int1024, _ y: _Int1024) -> _Int1024 {
|
||||
return x / y
|
||||
}
|
||||
// TODO: expectCrashLater()
|
||||
// _ = f(42, 0)
|
||||
}
|
||||
|
||||
func testDivision_ByMinusOne() {
|
||||
func f(_ x: _Int1024) -> _Int1024 {
|
||||
return x / -1
|
||||
}
|
||||
// TODO: expectCrashLater()
|
||||
// _ = f(_Int1024.min)
|
||||
}
|
||||
|
||||
func testMultipleOf() {
|
||||
func isMultipleTest<T: FixedWidthInteger>(type: T.Type) {
|
||||
XCTAssertTrue(T.min.isMultiple(of: 2))
|
||||
XCTAssertFalse(T.max.isMultiple(of: 10))
|
||||
// Test that these do not crash.
|
||||
XCTAssertTrue((0 as T).isMultiple(of: 0))
|
||||
XCTAssertFalse((1 as T).isMultiple(of: 0))
|
||||
XCTAssertTrue(T.min.isMultiple(of: 0 &- 1))
|
||||
}
|
||||
isMultipleTest(type: _Int128.self)
|
||||
isMultipleTest(type: _UInt128.self)
|
||||
}
|
||||
|
||||
func testMultiplication_ByMinusOne() {
|
||||
func f(_ x: _Int1024) -> _Int1024 {
|
||||
return x * -1
|
||||
}
|
||||
// TODO: expectCrashLater()
|
||||
// _ = f(_Int1024.min)
|
||||
}
|
||||
|
||||
func testConversions() {
|
||||
XCTAssertTrue(_Int16(1 << 15 - 1) == Int(1 << 15 - 1))
|
||||
XCTAssertTrue(_Int16(-1 << 15) == Int(-1 << 15))
|
||||
XCTAssertTrue(_UInt16(1 << 16 - 1) == Int(1 << 16 - 1))
|
||||
XCTAssertTrue(_UInt16(0) == Int(0))
|
||||
|
||||
XCTAssertTrue(_Int16(Double(1 << 15 - 1)) == Int(1 << 15 - 1))
|
||||
XCTAssertTrue(_Int16(Double(-1 << 15)) == Int(-1 << 15))
|
||||
XCTAssertTrue(_UInt16(Double(1 << 16 - 1)) == Int(1 << 16 - 1))
|
||||
XCTAssertTrue(_UInt16(Double(0)) == Int(0))
|
||||
|
||||
XCTAssertTrue(_Int16(Double(1 << 15 - 1) + 0.9) == Int(1 << 15 - 1))
|
||||
XCTAssertTrue(_Int16(Double(-1 << 15) - 0.9) == Int(-1 << 15))
|
||||
XCTAssertTrue(_UInt16(Double(1 << 16 - 1) + 0.9) == Int(1 << 16 - 1))
|
||||
XCTAssertTrue(_UInt16(Double(0) - 0.9) == Int(0))
|
||||
|
||||
XCTAssertEqual(_Int16(0.00001), 0)
|
||||
XCTAssertEqual(_UInt16(0.00001), 0)
|
||||
}
|
||||
|
||||
func testConversions_Exact() {
|
||||
XCTAssertEqual(
|
||||
_Int16(Double(1 << 15 - 1)),
|
||||
_Int16(exactly: Double(1 << 15 - 1))
|
||||
)
|
||||
XCTAssertEqual(
|
||||
_Int16(Double(-1 << 15)),
|
||||
_Int16(exactly: Double(-1 << 15))
|
||||
)
|
||||
XCTAssertEqual(
|
||||
_UInt16(Double(1 << 16 - 1)),
|
||||
_UInt16(exactly: Double(1 << 16 - 1))
|
||||
)
|
||||
XCTAssertEqual(
|
||||
_UInt16(Double(0)),
|
||||
_UInt16(exactly: Double(0))
|
||||
)
|
||||
|
||||
XCTAssertNil(_Int16(exactly: Double(1 << 15 - 1) + 0.9))
|
||||
XCTAssertNil(_Int16(exactly: Double(-1 << 15) - 0.9))
|
||||
XCTAssertNil(_UInt16(exactly: Double(1 << 16 - 1) + 0.9))
|
||||
XCTAssertNil(_UInt16(exactly: Double(0) - 0.9))
|
||||
|
||||
XCTAssertNil(_Int16(exactly: Double(1 << 15)))
|
||||
XCTAssertNil(_Int16(exactly: Double(-1 << 15) - 1))
|
||||
XCTAssertNil(_UInt16(exactly: Double(1 << 16)))
|
||||
XCTAssertNil(_UInt16(exactly: Double(-1)))
|
||||
|
||||
XCTAssertNil(_Int16(exactly: 0.00001))
|
||||
XCTAssertNil(_UInt16(exactly: 0.00001))
|
||||
|
||||
XCTAssertNil(_UInt16(exactly: Double.nan))
|
||||
XCTAssertNil(_UInt16(exactly: Float.nan))
|
||||
XCTAssertNil(_UInt16(exactly: Double.infinity))
|
||||
XCTAssertNil(_UInt16(exactly: Float.infinity))
|
||||
}
|
||||
|
||||
func testConversions_SignedMax() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = _Int16(1 << 15)
|
||||
}
|
||||
|
||||
func testConversions_SignedMin() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = _Int16(-1 << 15 - 1)
|
||||
}
|
||||
|
||||
func testConversions_UnsignedMax() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = _UInt16(1 << 16)
|
||||
}
|
||||
|
||||
func testConversions_UnsignedMin() {
|
||||
// TODO: expectCrashLater()
|
||||
// _ = _UInt16(-1)
|
||||
}
|
||||
|
||||
func testConversions_ToAndFromString<Number: FixedWidthInteger>(
|
||||
_ expectedNumber: Number,
|
||||
_ expectedString: String,
|
||||
radix: Int,
|
||||
file: StaticString = #filePath,
|
||||
line: UInt = #line
|
||||
) {
|
||||
let actualString = String(expectedNumber, radix: radix)
|
||||
XCTAssertEqual(expectedString, actualString, file: file, line: line)
|
||||
let actualNumber = Number(expectedString, radix: radix)
|
||||
XCTAssertEqual(expectedNumber, actualNumber, file: file, line: line)
|
||||
}
|
||||
|
||||
func testConversions_ToAndFromString_Binary() {
|
||||
testConversions_ToAndFromString(
|
||||
_Int128.max,
|
||||
"""
|
||||
111111111111111111111111111111111111111111111111111111111111111\
|
||||
1111111111111111111111111111111111111111111111111111111111111111
|
||||
""",
|
||||
radix: 2
|
||||
)
|
||||
testConversions_ToAndFromString(
|
||||
_Int128.min,
|
||||
"""
|
||||
-1000000000000000000000000000000000000000000000000000000000000000\
|
||||
0000000000000000000000000000000000000000000000000000000000000000
|
||||
""",
|
||||
radix: 2
|
||||
)
|
||||
}
|
||||
|
||||
func testConversions_ToAndFromString_Decimal() {
|
||||
testConversions_ToAndFromString(
|
||||
_Int256.max,
|
||||
"""
|
||||
5789604461865809771178549250434395392663\
|
||||
4992332820282019728792003956564819967
|
||||
""",
|
||||
radix: 10
|
||||
)
|
||||
testConversions_ToAndFromString(
|
||||
_Int256.min,
|
||||
"""
|
||||
-5789604461865809771178549250434395392663\
|
||||
4992332820282019728792003956564819968
|
||||
""",
|
||||
radix: 10
|
||||
)
|
||||
}
|
||||
|
||||
func testConversions_ToAndFromString_Hexadecimal() {
|
||||
testConversions_ToAndFromString(
|
||||
_Int512.max,
|
||||
"""
|
||||
7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\
|
||||
ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
""",
|
||||
radix: 16
|
||||
)
|
||||
testConversions_ToAndFromString(
|
||||
_Int512.min,
|
||||
"""
|
||||
-8000000000000000000000000000000000000000000000000000000000000000\
|
||||
0000000000000000000000000000000000000000000000000000000000000000
|
||||
""",
|
||||
radix: 16
|
||||
)
|
||||
}
|
||||
|
||||
func testWords() {
|
||||
XCTAssertTrue(_Int16(0).words.elementsEqual([0]))
|
||||
XCTAssertTrue(_Int16(1).words.elementsEqual([1]))
|
||||
XCTAssertTrue(_Int16(-1).words.elementsEqual([UInt.max]))
|
||||
XCTAssertTrue(_Int16(256).words.elementsEqual([256]))
|
||||
XCTAssertTrue(_Int16(-256).words.elementsEqual([UInt.max - 255]))
|
||||
XCTAssertTrue(_Int16.max.words.elementsEqual([32767]))
|
||||
XCTAssertTrue(_Int16.min.words.elementsEqual([UInt.max - 32767]))
|
||||
|
||||
XCTAssertTrue(
|
||||
(0 as _Int1024).words.elementsEqual(
|
||||
repeatElement(0 as UInt, count: 1024 / UInt.bitWidth)
|
||||
)
|
||||
)
|
||||
XCTAssertTrue(
|
||||
(-1 as _Int1024).words.elementsEqual(
|
||||
repeatElement(UInt.max, count: 1024 / UInt.bitWidth)
|
||||
)
|
||||
)
|
||||
XCTAssertTrue(
|
||||
(1 as _Int1024).words.elementsEqual(
|
||||
[1] + Array(repeating: 0, count: 1024 / UInt.bitWidth - 1)
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
func testConditionalConformance() {
|
||||
func checkSignedIntegerConformance<T: SignedInteger>(_: T) {}
|
||||
func checkUnsignedIntegerConformance<T: UnsignedInteger>(_: T) {}
|
||||
|
||||
checkSignedIntegerConformance(0 as _Int128)
|
||||
checkSignedIntegerConformance(0 as _Int1024)
|
||||
|
||||
checkUnsignedIntegerConformance(0 as _UInt128)
|
||||
checkUnsignedIntegerConformance(0 as _UInt1024)
|
||||
}
|
||||
}
|
||||
@@ -1,44 +0,0 @@
|
||||
//===--- GCDTests.swift ---------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import IntegerUtilities
|
||||
import XCTest
|
||||
|
||||
final class IntegerUtilitiesGCDTests: XCTestCase {
|
||||
func testGCDInt() {
|
||||
XCTAssertEqual(gcd(0, 0), 0)
|
||||
XCTAssertEqual(gcd(0, 1), 1)
|
||||
XCTAssertEqual(gcd(1, 0), 1)
|
||||
XCTAssertEqual(gcd(0, -1), 1)
|
||||
XCTAssertEqual(gcd(1, 1), 1)
|
||||
XCTAssertEqual(gcd(1, 2), 1)
|
||||
XCTAssertEqual(gcd(2, 2), 2)
|
||||
XCTAssertEqual(gcd(4, 2), 2)
|
||||
XCTAssertEqual(gcd(6, 8), 2)
|
||||
XCTAssertEqual(gcd(77, 91), 7)
|
||||
XCTAssertEqual(gcd(24, -36), 12)
|
||||
XCTAssertEqual(gcd(-24, -36), 12)
|
||||
XCTAssertEqual(gcd(51, 34), 17)
|
||||
XCTAssertEqual(gcd(64, 96), 32)
|
||||
XCTAssertEqual(gcd(-64, 96), 32)
|
||||
XCTAssertEqual(gcd(4*7*19, 27*25), 1)
|
||||
XCTAssertEqual(gcd(16*315, 11*315), 315)
|
||||
XCTAssertEqual(gcd(97*67*53*27*8, 83*67*53*9*32), 67*53*9*8)
|
||||
XCTAssertEqual(gcd(Int.min, 2), 2)
|
||||
|
||||
// TODO: Enable these when version compatibility allows.
|
||||
//
|
||||
// XCTExpectFailure{ gcd(0, Int.min) }
|
||||
// XCTExpectFailure{ gcd(Int.min, 0) }
|
||||
// XCTExpectFailure{ gcd(Int.min, Int.min) }
|
||||
}
|
||||
}
|
||||
@@ -1,74 +0,0 @@
|
||||
//===--- RotateTests.swift ------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import IntegerUtilities
|
||||
import XCTest
|
||||
|
||||
final class IntegerUtilitiesRotateTests: XCTestCase {
|
||||
func testRotateUInt8() {
|
||||
let x: UInt8 = 0b10011100
|
||||
XCTAssertEqual(0b01001110, x.rotated(right:-7))
|
||||
XCTAssertEqual(0b00100111, x.rotated(right:-6))
|
||||
XCTAssertEqual(0b10010011, x.rotated(right:-5))
|
||||
XCTAssertEqual(0b11001001, x.rotated(right:-4))
|
||||
XCTAssertEqual(0b11100100, x.rotated(right:-3))
|
||||
XCTAssertEqual(0b01110010, x.rotated(right:-2))
|
||||
XCTAssertEqual(0b00111001, x.rotated(right:-1))
|
||||
XCTAssertEqual(0b10011100, x.rotated(right: 0))
|
||||
XCTAssertEqual(0b01001110, x.rotated(right: 1))
|
||||
XCTAssertEqual(0b00100111, x.rotated(right: 2))
|
||||
XCTAssertEqual(0b10010011, x.rotated(right: 3))
|
||||
XCTAssertEqual(0b11001001, x.rotated(right: 4))
|
||||
XCTAssertEqual(0b11100100, x.rotated(right: 5))
|
||||
XCTAssertEqual(0b01110010, x.rotated(right: 6))
|
||||
XCTAssertEqual(0b00111001, x.rotated(right: 7))
|
||||
XCTAssertEqual(0b10011100, x.rotated(right: 8))
|
||||
}
|
||||
|
||||
func testRotateInt16() {
|
||||
let x = Int16(bitPattern: 0b1001110000111110)
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1001110000111110), x.rotated(left:-16))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0011100001111101), x.rotated(left:-15))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0111000011111010), x.rotated(left:-14))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1110000111110100), x.rotated(left:-13))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1100001111101001), x.rotated(left:-12))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1000011111010011), x.rotated(left:-11))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0000111110100111), x.rotated(left:-10))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0001111101001110), x.rotated(left:-9))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0011111010011100), x.rotated(left:-8))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0111110100111000), x.rotated(left:-7))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1111101001110000), x.rotated(left:-6))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1111010011100001), x.rotated(left:-5))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1110100111000011), x.rotated(left:-4))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1101001110000111), x.rotated(left:-3))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1010011100001111), x.rotated(left:-2))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0100111000011111), x.rotated(left:-1))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1001110000111110), x.rotated(left: 0))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0011100001111101), x.rotated(left: 1))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0111000011111010), x.rotated(left: 2))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1110000111110100), x.rotated(left: 3))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1100001111101001), x.rotated(left: 4))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1000011111010011), x.rotated(left: 5))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0000111110100111), x.rotated(left: 6))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0001111101001110), x.rotated(left: 7))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0011111010011100), x.rotated(left: 8))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0111110100111000), x.rotated(left: 9))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1111101001110000), x.rotated(left: 10))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1111010011100001), x.rotated(left: 11))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1110100111000011), x.rotated(left: 12))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1101001110000111), x.rotated(left: 13))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1010011100001111), x.rotated(left: 14))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b0100111000011111), x.rotated(left: 15))
|
||||
XCTAssertEqual(Int16(bitPattern: 0b1001110000111110), x.rotated(left: 16))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,192 +0,0 @@
|
||||
//===--- SaturatingArithmeticTests.swift ----------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2023 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import IntegerUtilities
|
||||
import XCTest
|
||||
import _TestSupport
|
||||
|
||||
final class IntegerUtilitiesSaturatingTests: XCTestCase {
|
||||
|
||||
func testSaturatingAddSigned() {
|
||||
for a in Int8.min ... Int8.max {
|
||||
for b in Int8.min ... Int8.max {
|
||||
let expected = Int8(clamping: Int16(a) + Int16(b))
|
||||
let observed = a.addingWithSaturation(b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).addingWithSaturation(\(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingSubSigned() {
|
||||
for a in Int8.min ... Int8.max {
|
||||
for b in Int8.min ... Int8.max {
|
||||
let expected = Int8(clamping: Int16(a) - Int16(b))
|
||||
let observed = a.subtractingWithSaturation(b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).subtractingWithSaturation(\(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingNegSigned() {
|
||||
for a in Int8.min ... Int8.max {
|
||||
let expected = Int8(clamping: 0 - Int16(a))
|
||||
let observed = a.negatedWithSaturation()
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).negatedWithSaturation().")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingMulSigned() {
|
||||
for a in Int8.min ... Int8.max {
|
||||
for b in Int8.min ... Int8.max {
|
||||
let expected = Int8(clamping: Int16(a) * Int16(b))
|
||||
let observed = a.multipliedWithSaturation(by: b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).multipliedWithSaturation(by: \(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingAddUnsigned() {
|
||||
for a in UInt8.min ... UInt8.max {
|
||||
for b in UInt8.min ... UInt8.max {
|
||||
let expected = UInt8(clamping: UInt16(a) + UInt16(b))
|
||||
let observed = a.addingWithSaturation(b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).addingWithSaturation(\(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingSubUnsigned() {
|
||||
for a in UInt8.min ... UInt8.max {
|
||||
for b in UInt8.min ... UInt8.max {
|
||||
let expected = UInt8(clamping: Int16(a) - Int16(b))
|
||||
let observed = a.subtractingWithSaturation(b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).subtractingWithSaturation(\(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingNegUnsigned() {
|
||||
for a in UInt8.min ... UInt8.max {
|
||||
let observed = a.negatedWithSaturation()
|
||||
if 0 != observed {
|
||||
print("Error found in (\(a)).negatedWithSaturation().")
|
||||
print("Expected: zero")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingMulUnsigned() {
|
||||
for a in UInt8.min ... UInt8.max {
|
||||
for b in UInt8.min ... UInt8.max {
|
||||
let expected = UInt8(clamping: UInt16(a) * UInt16(b))
|
||||
let observed = a.multipliedWithSaturation(by: b)
|
||||
if expected != observed {
|
||||
print("Error found in (\(a)).multipliedWithSaturation(by: \(b)).")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingShift<T, C>(
|
||||
_ value: T, _ count: C, rounding rule: RoundingRule
|
||||
) where T: FixedWidthInteger, C: FixedWidthInteger {
|
||||
let observed = value.shiftedWithSaturation(leftBy: count, rounding: rule)
|
||||
var expected: T = 0
|
||||
if count <= 0 {
|
||||
expected = value.shifted(rightBy: -Int64(count), rounding: rule)
|
||||
} else {
|
||||
let multiplier: T = 1 << count
|
||||
if multiplier <= 0 {
|
||||
expected = value == 0 ? 0 :
|
||||
value < 0 ? .min : .max
|
||||
} else {
|
||||
expected = value.multipliedWithSaturation(by: multiplier)
|
||||
}
|
||||
}
|
||||
if observed != expected {
|
||||
print("Error found in \(T.self).shiftedWithSaturation(leftBy: \(count), rounding: \(rule)).")
|
||||
print(" Value: \(String(value, radix: 16))")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingShift<T: FixedWidthInteger>(
|
||||
_ type: T.Type, rounding rule: RoundingRule
|
||||
) {
|
||||
for count in Int8.min ... .max {
|
||||
testSaturatingShift(0, count, rounding: rule)
|
||||
for bits in 0 ..< T.bitWidth {
|
||||
let msb: T.Magnitude = 1 << bits
|
||||
let value = T(truncatingIfNeeded: msb) | .random(in: 0 ... T(msb-1))
|
||||
testSaturatingShift(value, count, rounding: rule)
|
||||
testSaturatingShift(0 &- value, count, rounding: rule)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testSaturatingShifts() {
|
||||
testSaturatingShift(Int8.self, rounding: .toOdd)
|
||||
testSaturatingShift(UInt8.self, rounding: .toOdd)
|
||||
testSaturatingShift(Int.self, rounding: .toOdd)
|
||||
testSaturatingShift(UInt.self, rounding: .toOdd)
|
||||
}
|
||||
|
||||
func testEdgeCaseForNegativeCount() {
|
||||
XCTAssertEqual(1.shiftedWithSaturation(leftBy: Int.min), 0)
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,197 +0,0 @@
|
||||
//===--- ShiftTests.swift -------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift project authors
|
||||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||||
//
|
||||
// See https://swift.org/LICENSE.txt for license information
|
||||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import IntegerUtilities
|
||||
import XCTest
|
||||
import _TestSupport
|
||||
|
||||
final class IntegerUtilitiesShiftTests: XCTestCase {
|
||||
|
||||
func testRoundingShift<T, C>(
|
||||
_ value: T, _ count: C, rounding rule: RoundingRule
|
||||
) where T: FixedWidthInteger, C: BinaryInteger {
|
||||
let floor = value >> count
|
||||
let lost = value &- floor << count
|
||||
let exact = count <= 0 || lost == 0
|
||||
let ceiling = exact ? floor : floor &+ 1
|
||||
let expected: T
|
||||
switch rule {
|
||||
case .down:
|
||||
expected = floor
|
||||
case .up:
|
||||
expected = ceiling
|
||||
case .towardZero:
|
||||
expected = value < 0 ? ceiling : floor
|
||||
case .awayFromZero:
|
||||
expected = value > 0 ? ceiling : floor
|
||||
case .toOdd:
|
||||
expected = floor | (exact ? 0 : 1)
|
||||
case .toNearestOrAwayFromZero:
|
||||
if exact { expected = floor }
|
||||
else {
|
||||
let step = value.shifted(rightBy: count - 2, rounding: .toOdd)
|
||||
switch step & 0b11 {
|
||||
case 0b01: expected = floor
|
||||
case 0b10: expected = value > 0 ? ceiling : floor
|
||||
case 0b11: expected = ceiling
|
||||
default: preconditionFailure()
|
||||
}
|
||||
}
|
||||
case .toNearestOrEven:
|
||||
if exact { expected = floor }
|
||||
else {
|
||||
let step = value.shifted(rightBy: count - 2, rounding: .toOdd)
|
||||
switch step & 0b11 {
|
||||
case 0b01: expected = floor
|
||||
case 0b10: expected = floor & 1 == 0 ? floor : ceiling
|
||||
case 0b11: expected = ceiling
|
||||
default: preconditionFailure()
|
||||
}
|
||||
}
|
||||
case .stochastically:
|
||||
// Just test that it's floor if exact, otherwise either floor
|
||||
// or ceiling.
|
||||
if exact { expected = floor }
|
||||
else {
|
||||
let observed = value.shifted(rightBy: count, rounding: rule)
|
||||
if observed != floor && observed != ceiling {
|
||||
print("Error found in \(T.self).shifted(rightBy: \(count), rounding: \(rule)).")
|
||||
print(" Value: \(String(value, radix: 16))")
|
||||
print("Expected: \(String(floor, radix: 16)) or \(String(ceiling, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
}
|
||||
return
|
||||
}
|
||||
case .requireExact:
|
||||
preconditionFailure()
|
||||
}
|
||||
let observed = value.shifted(rightBy: count, rounding: rule)
|
||||
if observed != expected {
|
||||
print("Error found in \(T.self).shifted(rightBy: \(count), rounding: \(rule)).")
|
||||
print(" Value: \(String(value, radix: 16))")
|
||||
print("Expected: \(String(expected, radix: 16))")
|
||||
print("Observed: \(String(observed, radix: 16))")
|
||||
XCTFail()
|
||||
}
|
||||
}
|
||||
|
||||
func testRoundingShift<T: FixedWidthInteger>(
|
||||
_ type: T.Type, rounding rule: RoundingRule
|
||||
) {
|
||||
for count in -2*T.bitWidth ... 2*T.bitWidth {
|
||||
// zero shifted by anything is always zero
|
||||
XCTAssertEqual(0, (0 as T).shifted(rightBy: count, rounding: rule))
|
||||
for _ in 0 ..< 100 {
|
||||
testRoundingShift(T.random(in: .min ... .max), count, rounding: rule)
|
||||
}
|
||||
}
|
||||
|
||||
for count in Int8.min ... .max {
|
||||
testRoundingShift(T.random(in: .min ... .max), count, rounding: rule)
|
||||
}
|
||||
}
|
||||
|
||||
func testRoundingShifts() {
|
||||
testRoundingShift(Int8.self, rounding: .down)
|
||||
testRoundingShift(Int8.self, rounding: .up)
|
||||
testRoundingShift(Int8.self, rounding: .towardZero)
|
||||
testRoundingShift(Int8.self, rounding: .awayFromZero)
|
||||
testRoundingShift(Int8.self, rounding: .toOdd)
|
||||
testRoundingShift(Int8.self, rounding: .toNearestOrAwayFromZero)
|
||||
testRoundingShift(Int8.self, rounding: .toNearestOrEven)
|
||||
testRoundingShift(Int8.self, rounding: .stochastically)
|
||||
|
||||
testRoundingShift(UInt8.self, rounding: .down)
|
||||
testRoundingShift(UInt8.self, rounding: .up)
|
||||
testRoundingShift(UInt8.self, rounding: .towardZero)
|
||||
testRoundingShift(UInt8.self, rounding: .awayFromZero)
|
||||
testRoundingShift(UInt8.self, rounding: .toOdd)
|
||||
testRoundingShift(UInt8.self, rounding: .toNearestOrAwayFromZero)
|
||||
testRoundingShift(UInt8.self, rounding: .toNearestOrEven)
|
||||
testRoundingShift(UInt8.self, rounding: .stochastically)
|
||||
|
||||
testRoundingShift(Int.self, rounding: .down)
|
||||
testRoundingShift(Int.self, rounding: .up)
|
||||
testRoundingShift(Int.self, rounding: .towardZero)
|
||||
testRoundingShift(Int.self, rounding: .awayFromZero)
|
||||
testRoundingShift(Int.self, rounding: .toOdd)
|
||||
testRoundingShift(Int.self, rounding: .toNearestOrAwayFromZero)
|
||||
testRoundingShift(Int.self, rounding: .toNearestOrEven)
|
||||
testRoundingShift(Int.self, rounding: .stochastically)
|
||||
|
||||
testRoundingShift(UInt.self, rounding: .down)
|
||||
testRoundingShift(UInt.self, rounding: .up)
|
||||
testRoundingShift(UInt.self, rounding: .towardZero)
|
||||
testRoundingShift(UInt.self, rounding: .awayFromZero)
|
||||
testRoundingShift(UInt.self, rounding: .toOdd)
|
||||
testRoundingShift(UInt.self, rounding: .toNearestOrAwayFromZero)
|
||||
testRoundingShift(UInt.self, rounding: .toNearestOrEven)
|
||||
testRoundingShift(UInt.self, rounding: .stochastically)
|
||||
}
|
||||
|
||||
// Stochastic rounding doesn't have a deterministic "expected" answer,
|
||||
// but we know that the result must be either the floor or the ceiling.
|
||||
// The above tests ensure that, but that's not a very strong guarantee;
|
||||
// an implementation could just implement it as self >> count and pass
|
||||
// that test.
|
||||
//
|
||||
// Here we round the _same_ value many times, compute the average, and
|
||||
// check that it is acceptably close to the exact expected value; simple
|
||||
// use of any deterministic rounding rule will not achieve this.
|
||||
func testStochasticAverage<T: FixedWidthInteger>(_ value: T) {
|
||||
var fails = 0
|
||||
for count in 1 ... T.bitWidth {
|
||||
let sum = (0..<256).reduce(into: DoubleWidth<T>.zero) { sum, _ in
|
||||
let rounded = value.shifted(rightBy: count, rounding: .stochastically)
|
||||
sum += DoubleWidth(rounded)
|
||||
}
|
||||
let expected = DoubleWidth<T>(value) << (8 - count)
|
||||
let difference = sum >= expected ? sum - expected : expected - sum
|
||||
// Waving my hands slightly instead of giving a precise explanation
|
||||
// here, the expectation is that difference should be about
|
||||
// 1/2 sqrt(256). If it's repeatedly bigger than that, we _may_
|
||||
// have a problem, but it's OK for this to fail occasionally.
|
||||
//
|
||||
// TODO: precise justification of thresholds
|
||||
if difference > 8 { fails += 1 }
|
||||
// On the other hand, if we're more than a couple standard deviations
|
||||
// off, we should flag that. This still isn't _necessarily_ a problem,
|
||||
// but if you see a repeated failure for a given shift count, that's
|
||||
// almost surely a real bug.
|
||||
XCTAssertLessThanOrEqual(difference, 32,
|
||||
"Accumulated error (\(difference)) was unexpectedly large in \(value).shifted(rightBy: \(count))"
|
||||
)
|
||||
}
|
||||
// Threshold chosen so that this is expected to _usually_ pass, but
|
||||
// it will fail sporadically even with a correct implementation. This is
|
||||
// not a great fit for CI workflows, sorry. Basically ignore one-off
|
||||
// failures, but a repeated failure here is an indication that a bug
|
||||
// exists.
|
||||
XCTAssertLessThanOrEqual(fails, T.bitWidth/2,
|
||||
"Accumulated error was large more often than expected for \(value).shifted(rightBy:)"
|
||||
)
|
||||
}
|
||||
|
||||
func testStochasticShifts() {
|
||||
testStochasticAverage(Int8.random(in: .min ... .max))
|
||||
testStochasticAverage(Int16.random(in: .min ... .max))
|
||||
testStochasticAverage(Int32.random(in: .min ... .max))
|
||||
testStochasticAverage(UInt8.random(in: .min ... .max))
|
||||
testStochasticAverage(UInt16.random(in: .min ... .max))
|
||||
testStochasticAverage(UInt32.random(in: .min ... .max))
|
||||
testStochasticAverage(Int64.random(in: .min ... .max))
|
||||
testStochasticAverage(UInt64.random(in: .min ... .max))
|
||||
testStochasticAverage(DoubleWidth<Int64>.random(in: .min ... .max))
|
||||
testStochasticAverage(DoubleWidth<UInt64>.random(in: .min ... .max))
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
//===--- LinuxMain.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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
fatalError("Use --enable-test-discovery to run Swift Numerics tests on Linux.")
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- ApproximateEqualityTests.swift -----------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2020 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
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
//===--- AugmentedArithmeticTests.swift -----------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift.org open source project
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2021 Apple Inc. and the Swift project authors
|
||||
// Copyright (c) 2021 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
|
||||
|
||||
@@ -148,7 +148,7 @@ final class ElementaryFunctionChecks: XCTestCase {
|
||||
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
func testFloat16() {
|
||||
if #available(macOS 11.0, iOS 14.0, watchOS 14.0, tvOS 7.0, *) {
|
||||
if #available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *) {
|
||||
Float16.elementaryFunctionChecks()
|
||||
Float16.realFunctionChecks()
|
||||
Float16.powZeroChecks()
|
||||
|
||||
@@ -78,7 +78,7 @@ internal extension Real where Self: FixedWidthFloatingPoint {
|
||||
}
|
||||
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
@available(macOS 11.0, iOS 14.0, watchOS 14.0, tvOS 7.0, *)
|
||||
@available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *)
|
||||
extension Float16 {
|
||||
static func testIntegerExponent() {
|
||||
testIntegerExponentCommon()
|
||||
@@ -157,10 +157,10 @@ extension Double {
|
||||
#endif
|
||||
assertClose( 1.7976931348623151738531864721534215e308, Double.pow(-u, 3196577161300664268), allowedError: tol)
|
||||
assertClose(-1.7976931348623155730212483790972209e308, Double.pow(-u, 3196577161300664269), allowedError: tol)
|
||||
assertClose( 1.7976931348623159721893102860411089e308, Double.pow(-u, 3196577161300664270), allowedError: tol)
|
||||
assertClose( 1.7976931348623159721893102860411089e308, Double.pow(-u, 3196577161300664270), allowedError: tol) // warning expected on non-x86
|
||||
assertClose( 1.7976931348623157075547244136070910e308, Double.pow(-d, -6393154322601327474), allowedError: tol)
|
||||
assertClose(-1.7976931348623159071387553670790721e308, Double.pow(-d, -6393154322601327475), allowedError: tol)
|
||||
assertClose( 1.7976931348623161067227863205510754e308, Double.pow(-d, -6393154322601327476), allowedError: tol)
|
||||
assertClose(-1.7976931348623159071387553670790721e308, Double.pow(-d, -6393154322601327475), allowedError: tol) // warning expected on non-x86
|
||||
assertClose( 1.7976931348623161067227863205510754e308, Double.pow(-d, -6393154322601327476), allowedError: tol) // warning expected on non-x86
|
||||
// Exponents close to underflow boundary.
|
||||
assertClose( 2.4703282292062334560337346683707907e-324, Double.pow(-u, -3355781687888880946))
|
||||
assertClose(-2.4703282292062329075106789791206172e-324, Double.pow(-u, -3355781687888880947))
|
||||
@@ -176,7 +176,7 @@ final class IntegerExponentTests: XCTestCase {
|
||||
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
func testFloat16() {
|
||||
if #available(macOS 11.0, iOS 14.0, watchOS 14.0, tvOS 7.0, *) {
|
||||
if #available(macOS 11.0, iOS 14.0, tvOS 14.0, watchOS 7.0, *) {
|
||||
Float16.testIntegerExponent()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -102,7 +102,7 @@ final class RelaxedArithmeticTests: XCTestCase {
|
||||
// Summing all values in an array can be associated however we want, but
|
||||
// has to satisfy the usual error bound of 0.5 * sum.ulp * numberOfElements.
|
||||
// We don't have a golden reference, but we can compare two sums with twice
|
||||
// the bound for a sanity check.
|
||||
// the bound for a basic check.
|
||||
let array = (0 ..< 128).map { _ in T.random(in: 1 ..< 2) }
|
||||
var ref = strictSum(array)
|
||||
var tst = relaxedSum(array)
|
||||
@@ -116,7 +116,7 @@ final class RelaxedArithmeticTests: XCTestCase {
|
||||
}
|
||||
|
||||
func testRelaxedArithmetic() {
|
||||
#if swift(>=5.4) && !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
testRelaxedArithmetic(Float16.self)
|
||||
#endif
|
||||
testRelaxedArithmetic(Float.self)
|
||||
|
||||
@@ -1,194 +0,0 @@
|
||||
//===--- WindowsMain.swift ------------------------------------*- swift -*-===//
|
||||
//
|
||||
// This source file is part of the Swift Numerics open source project
|
||||
//
|
||||
// Copyright (c) 2019-2021 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
#if os(Windows)
|
||||
import XCTest
|
||||
|
||||
@testable
|
||||
import RealTests
|
||||
|
||||
@testable
|
||||
import ComplexTests
|
||||
|
||||
@testable
|
||||
import IntegerUtilitiesTests
|
||||
|
||||
extension ComplexTests.ApproximateEqualityTests {
|
||||
static var all = testCase([
|
||||
("testFloat", ComplexTests.ApproximateEqualityTests.testFloat),
|
||||
("testDouble", ComplexTests.ApproximateEqualityTests.testDouble),
|
||||
])
|
||||
}
|
||||
|
||||
extension RealTests.ApproximateEqualityTests {
|
||||
static var all = testCase([
|
||||
("testFloat", RealTests.ApproximateEqualityTests.testFloat),
|
||||
("testDouble", RealTests.ApproximateEqualityTests.testDouble),
|
||||
])
|
||||
}
|
||||
|
||||
#if !((os(macOS) || targetEnvironment(macCatalyst)) && arch(x86_64))
|
||||
extension ElementaryFunctionChecks {
|
||||
static var all = testCase([
|
||||
("testFloat16", ElementaryFunctionChecks.testFloat16),
|
||||
("testFloat", ElementaryFunctionChecks.testFloat),
|
||||
("testDouble", ElementaryFunctionChecks.testDouble),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerExponentTests {
|
||||
static var all = testCase([
|
||||
("testFloat16", IntegerExponentTests.testFloat16),
|
||||
("testFloat", IntegerExponentTests.testFloat),
|
||||
("testDouble", IntegerExponentTests.testDouble),
|
||||
])
|
||||
}
|
||||
#else
|
||||
extension ElementaryFunctionChecks {
|
||||
static var all = testCase([
|
||||
("testFloat", ElementaryFunctionChecks.testFloat),
|
||||
("testDouble", ElementaryFunctionChecks.testDouble),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerExponentTests {
|
||||
static var all = testCase([
|
||||
("testFloat", IntegerExponentTests.testFloat),
|
||||
("testDouble", IntegerExponentTests.testDouble),
|
||||
])
|
||||
}
|
||||
#endif
|
||||
|
||||
extension RealTests.AugmentedArithmeticTests {
|
||||
static var all = testCase([
|
||||
("testTwoSum", RealTests.AugmentedArithmeticTests.testTwoSum),
|
||||
])
|
||||
}
|
||||
|
||||
extension RealTests.RelaxedArithmeticTests {
|
||||
static var all = testCase([
|
||||
("testRelaxedArithmetic", RealTests.RelaxedArithmeticTests.testRelaxedArithmetic),
|
||||
])
|
||||
}
|
||||
|
||||
extension ArithmeticTests {
|
||||
static var all = testCase([
|
||||
("testPolar", ArithmeticTests.testPolar),
|
||||
("testBaudinSmith", ArithmeticTests.testBaudinSmith),
|
||||
("testDivisionByZero", ArithmeticTests.testDivisionByZero),
|
||||
])
|
||||
}
|
||||
|
||||
extension PropertyTests {
|
||||
static var all = testCase([
|
||||
("testProperties", PropertyTests.testProperties),
|
||||
("testEquatableHashable", PropertyTests.testEquatableHashable),
|
||||
("testCodable", PropertyTests.testCodable),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesDivideTests {
|
||||
static var all = testCase([
|
||||
("testDivideInt8", IntegerUtilitiesDivideTests.testDivideInt8),
|
||||
("testDivideInt", IntegerUtilitiesDivideTests.testDivideInt),
|
||||
("testDivideUInt8", IntegerUtilitiesDivideTests.testDivideUInt8),
|
||||
("testDivideStochasticInt8", IntegerUtilitiesDivideTests.testDivideStochasticInt8),
|
||||
("testDivideStochasticUInt32", IntegerUtilitiesDivideTests.testDivideStochasticUInt32),
|
||||
("testRemainderByMinusOne", IntegerUtilitiesDivideTests.testRemainderByMinusOne),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesGCDTests {
|
||||
static var all = testCase([
|
||||
("testGCDInt", IntegerUtilitiesGCDTests.testGCDInt),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesRotateTests {
|
||||
static var all = testCase([
|
||||
("testRotateUInt8", IntegerUtilitiesRotateTests.testRotateUInt8),
|
||||
("testRotateInt16", IntegerUtilitiesRotateTests.testRotateInt16),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesSaturatingTests {
|
||||
static var all = testCase([
|
||||
("testSaturatingAddSigned", IntegerUtilitiesSaturatingTests.testSaturatingAddSigned),
|
||||
("testSaturatingSubSigned", IntegerUtilitiesSaturatingTests.testSaturatingSubSigned),
|
||||
("testSaturatingNegSigned", IntegerUtilitiesSaturatingTests.testSaturatingNegSigned),
|
||||
("testSaturatingMulSigned", IntegerUtilitiesSaturatingTests.testSaturatingMulSigned),
|
||||
("testSaturatingAddUnsigned", IntegerUtilitiesSaturatingTests.testSaturatingAddUnsigned),
|
||||
("testSaturatingSubUnsigned", IntegerUtilitiesSaturatingTests.testSaturatingSubUnsigned),
|
||||
("testSaturatingNegUnsigned", IntegerUtilitiesSaturatingTests.testSaturatingNegUnsigned),
|
||||
("testSaturatingMulUnsigned", IntegerUtilitiesSaturatingTests.testSaturatingMulUnsigned),
|
||||
("testSaturatingShifts", IntegerUtilitiesSaturatingTests.testSaturatingShifts),
|
||||
("testEdgeCaseForNegativeCount", IntegerUtilitiesSaturatingTests.testEdgeCaseForNegativeCount)
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesShiftTests {
|
||||
static var all = testCase([
|
||||
("testRoundingShifts", IntegerUtilitiesShiftTests.testRoundingShifts),
|
||||
("testStochasticShifts", IntegerUtilitiesShiftTests.testStochasticShifts),
|
||||
])
|
||||
}
|
||||
|
||||
extension IntegerUtilitiesTests.DoubleWidthTests {
|
||||
static var all = testCase([
|
||||
("testArithmetic_Signed", IntegerUtilitiesTests.DoubleWidthTests.testArithmetic_Signed),
|
||||
("testArithmetic_Unsigned", IntegerUtilitiesTests.DoubleWidthTests.testArithmetic_Unsigned),
|
||||
("testBitwise_LeftAndRightShifts", IntegerUtilitiesTests.DoubleWidthTests.testBitwise_LeftAndRightShifts),
|
||||
("testCompileTime_SR_6947", IntegerUtilitiesTests.DoubleWidthTests.testCompileTime_SR_6947),
|
||||
("testConditionalConformance", IntegerUtilitiesTests.DoubleWidthTests.testConditionalConformance),
|
||||
("testConversions", IntegerUtilitiesTests.DoubleWidthTests.testConversions),
|
||||
("testConversions_Exact", IntegerUtilitiesTests.DoubleWidthTests.testConversions_Exact),
|
||||
("testConversions_SignedMax", IntegerUtilitiesTests.DoubleWidthTests.testConversions_SignedMax),
|
||||
("testConversions_SignedMin", IntegerUtilitiesTests.DoubleWidthTests.testConversions_SignedMin),
|
||||
("testConversions_ToAndFromString_Binary", IntegerUtilitiesTests.DoubleWidthTests.testConversions_ToAndFromString_Binary),
|
||||
("testConversions_ToAndFromString_Decimal", IntegerUtilitiesTests.DoubleWidthTests.testConversions_ToAndFromString_Decimal),
|
||||
("testConversions_ToAndFromString_Hexadecimal", IntegerUtilitiesTests.DoubleWidthTests.testConversions_ToAndFromString_Hexadecimal),
|
||||
("testConversions_UnsignedMax", IntegerUtilitiesTests.DoubleWidthTests.testConversions_UnsignedMax),
|
||||
("testConversions_UnsignedMin", IntegerUtilitiesTests.DoubleWidthTests.testConversions_UnsignedMin),
|
||||
("testDivision_ByMinusOne", IntegerUtilitiesTests.DoubleWidthTests.testDivision_ByMinusOne),
|
||||
("testDivision_ByZero", IntegerUtilitiesTests.DoubleWidthTests.testDivision_ByZero),
|
||||
("testInitialization", IntegerUtilitiesTests.DoubleWidthTests.testInitialization),
|
||||
("testInitialization_Overflow", IntegerUtilitiesTests.DoubleWidthTests.testInitialization_Overflow),
|
||||
("testLiterals", IntegerUtilitiesTests.DoubleWidthTests.testLiterals),
|
||||
("testLiterals_Underflow", IntegerUtilitiesTests.DoubleWidthTests.testLiterals_Underflow),
|
||||
("testMagnitude", IntegerUtilitiesTests.DoubleWidthTests.testMagnitude),
|
||||
("testMultipleOf", IntegerUtilitiesTests.DoubleWidthTests.testMultipleOf),
|
||||
("testMultiplication_ByMinusOne", IntegerUtilitiesTests.DoubleWidthTests.testMultiplication_ByMinusOne),
|
||||
("testNested", IntegerUtilitiesTests.DoubleWidthTests.testNested),
|
||||
("testRemainder_ByMinusOne", IntegerUtilitiesTests.DoubleWidthTests.testRemainder_ByMinusOne),
|
||||
("testRemainder_ByZero", IntegerUtilitiesTests.DoubleWidthTests.testRemainder_ByZero),
|
||||
("testTwoWords", IntegerUtilitiesTests.DoubleWidthTests.testTwoWords),
|
||||
("testWords", IntegerUtilitiesTests.DoubleWidthTests.testWords),
|
||||
])
|
||||
}
|
||||
|
||||
var testCases = [
|
||||
ComplexTests.ApproximateEqualityTests.all,
|
||||
RealTests.ApproximateEqualityTests.all,
|
||||
ElementaryFunctionChecks.all,
|
||||
IntegerExponentTests.all,
|
||||
ArithmeticTests.all,
|
||||
PropertyTests.all,
|
||||
IntegerUtilitiesDivideTests.all,
|
||||
IntegerUtilitiesGCDTests.all,
|
||||
IntegerUtilitiesRotateTests.all,
|
||||
IntegerUtilitiesShiftTests.all,
|
||||
IntegerUtilitiesSaturatingTests.all,
|
||||
IntegerUtilitiesTests.DoubleWidthTests.all,
|
||||
]
|
||||
|
||||
XCTMain(testCases)
|
||||
|
||||
#endif
|
||||
@@ -43,6 +43,8 @@ function(get_swift_host_arch result_var_name)
|
||||
set("${result_var_name}" "i686" PARENT_SCOPE)
|
||||
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "i686")
|
||||
set("${result_var_name}" "i686" PARENT_SCOPE)
|
||||
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "riscv64")
|
||||
set("${result_var_name}" "riscv64" PARENT_SCOPE)
|
||||
else()
|
||||
message(FATAL_ERROR "Unrecognized architecture on host system: ${CMAKE_SYSTEM_PROCESSOR}")
|
||||
endif()
|
||||
|
||||
Reference in new issue
Block a user