Release 1.11.0

leif-ibsen · Apr 20, 2023 · bafec95 · bafec95
1 parent ae9a61a
commit bafec95
Show file tree

Hide file tree

Showing 62 changed files with 146 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ BigInt requires Swift 5.0. It also requires that the Int and UInt types be 64 bi
 In your projects Package.swift file add a dependency like<br/>
 
 	  dependencies: [
-	  .package(url: "https://github.com/leif-ibsen/BigInt", from: "1.10.0"),
+	  .package(url: "https://github.com/leif-ibsen/BigInt", from: "1.11.0"),
 	  ]
 
 <h2 id="ex"><b>Examples</b></h2>

diff --git a/Sources/BigInt/BigInt.swift b/Sources/BigInt/BigInt.swift
@@ -1251,6 +1251,32 @@ public struct BInt: CustomStringConvertible, Comparable, Equatable, Hashable {
     /// - Returns: If *self* and m are coprime, x such that (*self* \* x) mod m = 1
     public func modInverse(_ m: Int) -> Int {
         precondition(m > 0, "Modulus must be positive")
+        guard m > 1 else {
+            return 0
+        }
+        let tb = m.trailingZeroBitCount
+        if tb + m.leadingZeroBitCount == 63 {
+
+            precondition(self.isOdd, "No inverse modulus")
+
+            // Fast power of 2 implementation
+            // [KOC] - section 7
+
+            // Reduce mod m
+            let m = self.magnitude[0] & (1 << tb - 1)
+            let selfr = self.isNegative ? -Int(m) : Int(m)
+
+            var x = 0
+            var b = 1
+            for i in 0 ..< tb {
+                if b & 1 == 1 {
+                    x |= 1 << i
+                    b -= selfr
+                }
+                b >>= 1
+            }
+            return x
+        }
         var a = 1
         var g = self.mod(m)
         var u = 0

diff --git a/Tests/BigIntTests/AdditionTest.swift b/Tests/BigIntTests/AdditionTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class AdditionTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/BinomialTest.swift b/Tests/BigIntTests/BinomialTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class BinomialTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/BitTest.swift b/Tests/BigIntTests/BitTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class BitTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ComparisonTest.swift b/Tests/BigIntTests/ComparisonTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ComparisonTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ConstructorTest.swift b/Tests/BigIntTests/ConstructorTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ConstructorTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/DivExactTest.swift b/Tests/BigIntTests/DivExactTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class DivExactTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/DivModBZTest.swift b/Tests/BigIntTests/DivModBZTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 // Test of the Burnikel-Ziegler division algorithm
 // Tests are performed by verifying that the result of using Burnikel-Ziegler

diff --git a/Tests/BigIntTests/DivModTest.swift b/Tests/BigIntTests/DivModTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class DivModTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ExpModTest.swift b/Tests/BigIntTests/ExpModTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ExpModTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/FFTTest.swift b/Tests/BigIntTests/FFTTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class FFTTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/FactorialTest.swift b/Tests/BigIntTests/FactorialTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class FactorialTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/FibonacciTest.swift b/Tests/BigIntTests/FibonacciTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class FibonacciTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/FractionTest.swift b/Tests/BigIntTests/FractionTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class FractionTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/GcdExtendedTest.swift b/Tests/BigIntTests/GcdExtendedTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class GcdExtendedTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/GcdTest.swift b/Tests/BigIntTests/GcdTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class GcdTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/IntMinMaxTest.swift b/Tests/BigIntTests/IntMinMaxTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class IntMinMaxTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/JacobiTest.swift b/Tests/BigIntTests/JacobiTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class JacobiTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/KaratsubaTest.swift b/Tests/BigIntTests/KaratsubaTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class KaratsubaTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/KroneckerTest.swift b/Tests/BigIntTests/KroneckerTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class KroneckerTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/LcmTest.swift b/Tests/BigIntTests/LcmTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class LcmTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/LimbTest.swift b/Tests/BigIntTests/LimbTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class LimbTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ModInverseTest.swift b/Tests/BigIntTests/ModInverseTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ModInverseTest: XCTestCase {
 
@@ -64,4 +65,16 @@ class ModInverseTest: XCTestCase {
         XCTAssertEqual((-BInt.THREE).modInverse(BInt.ONE), BInt.ZERO)
     }
 
+    func test3() {
+        let x1 = BInt.ONE << 20 + 1
+        let x2 = BInt.ONE << 200 + 1
+        for i in 0 ... 62 {
+            let m = 1 << i
+            XCTAssertEqual(BInt(x1.modInverse(m)), x1.modInverse(BInt(m)))
+            XCTAssertEqual(BInt((-x1).modInverse(m)), (-x1).modInverse(BInt(m)))
+            XCTAssertEqual(BInt(x2.modInverse(m)), x2.modInverse(BInt(m)))
+            XCTAssertEqual(BInt((-x2).modInverse(m)), (-x2).modInverse(BInt(m)))
+        }
+    }
+
 }
diff --git a/Tests/BigIntTests/MulSquareTest.swift b/Tests/BigIntTests/MulSquareTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class MulSquareTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/MultiplicationTest.swift b/Tests/BigIntTests/MultiplicationTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class MultiplicationTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/PerformanceTest.swift b/Tests/BigIntTests/PerformanceTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class PerformanceTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/PrimeTest.swift b/Tests/BigIntTests/PrimeTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class PrimeTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/RootTest.swift b/Tests/BigIntTests/RootTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class RootTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ShiftTest.swift b/Tests/BigIntTests/ShiftTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ShiftTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/SubtractionTest.swift b/Tests/BigIntTests/SubtractionTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class SubtractionTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ToByteArrayTest.swift b/Tests/BigIntTests/ToByteArrayTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ToByteArrayTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ToStringTest.swift b/Tests/BigIntTests/ToStringTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ToStringTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/ToomCookTest.swift b/Tests/BigIntTests/ToomCookTest.swift
@@ -6,6 +6,7 @@
 //
 
 import XCTest
+@testable import BigInt
 
 class ToomCookTest: XCTestCase {
 

diff --git a/Tests/BigIntTests/XCTestManifests.swift b/Tests/BigIntTests/XCTestManifests.swift
diff --git a/docs/Structs.html b/docs/Structs.html
@@ -17,7 +17,7 @@
     <a title="Structures  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html"> Docs</a> (100% documented)</p>
+        <p><a href="index.html">BigInt Docs</a> (100% documented)</p>
         <div class="header-right">
           <form role="search" action="search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -27,7 +27,7 @@
     </header>
     <div class="content-wrapper">
       <p id="breadcrumbs">
-        <a href="index.html"> Reference</a>
+        <a href="index.html">BigInt Reference</a>
         <img id="carat" src="img/carat.png" alt=""/>
         Structures  Reference
       </p>
@@ -145,7 +145,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-04-12)</p>
+          <p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-04-19)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Structs/BFraction.html b/docs/Structs/BFraction.html
@@ -17,7 +17,7 @@
     <a title="BFraction Structure Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html"> Docs</a> (100% documented)</p>
+        <p><a href="../index.html">BigInt Docs</a> (100% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -27,7 +27,7 @@
     </header>
     <div class="content-wrapper">
       <p id="breadcrumbs">
-        <a href="../index.html"> Reference</a>
+        <a href="../index.html">BigInt Reference</a>
         <img id="carat" src="../img/carat.png" alt=""/>
         BFraction Structure Reference
       </p>
@@ -5179,7 +5179,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-04-12)</p>
+          <p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-04-19)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ @@
     //
     import XCTest
+    @testable import BigInt
     class AdditionTest: XCTestCase {
@@ Expand Down @@