Merge pull request #14 from RougeWare/develop

KyNorthstar · web-flow · commit 33adc02bdd4a · 2019-12-05T20:22:33.000-07:00
#11 and copyright header updates
diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
diff --git a/Sources/RectangleTools/Basic Protocols/MutableTwoDimensional.swift b/Sources/RectangleTools/Basic Protocols/MutableTwoDimensional.swift
@@ -1,8 +1,9 @@
 //
 //  TwoDimensional.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Basic Protocols/Point2D.swift b/Sources/RectangleTools/Basic Protocols/Point2D.swift
@@ -1,8 +1,9 @@
 //
 //  Point2D.swift
-//
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Basic Protocols/Rectangle.swift b/Sources/RectangleTools/Basic Protocols/Rectangle.swift
@@ -1,8 +1,9 @@
 //
 //  Rectangle.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Basic Protocols/Size2D.swift b/Sources/RectangleTools/Basic Protocols/Size2D.swift
@@ -1,8 +1,9 @@
 //
 //  Size2D.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Conformances/CGPoint + Point2D.swift b/Sources/RectangleTools/Default Conformances/CGPoint + Point2D.swift
@@ -1,8 +1,9 @@
 //
 //  CGPoint + Point2D.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Conformances/CGRect + Rectangle.swift b/Sources/RectangleTools/Default Conformances/CGRect + Rectangle.swift
@@ -1,8 +1,9 @@
 //
 //  File.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Conformances/CGSize + Size2D.swift b/Sources/RectangleTools/Default Conformances/CGSize + Size2D.swift
@@ -1,8 +1,9 @@
 //
 //  CGSize + Size2D.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Implementations/Decimal/DecimalPoint.swift b/Sources/RectangleTools/Default Implementations/Decimal/DecimalPoint.swift
@@ -1,8 +1,9 @@
 //
 //  DecimalPoint.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Implementations/Decimal/DecimalRect.swift b/Sources/RectangleTools/Default Implementations/Decimal/DecimalRect.swift
@@ -1,8 +1,9 @@
 //
 //  DecimalRect.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Implementations/Decimal/DecimalSize.swift b/Sources/RectangleTools/Default Implementations/Decimal/DecimalSize.swift
@@ -1,8 +1,9 @@
 //
 //  DecimalSize.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Implementations/Integer/IntPoint.swift b/Sources/RectangleTools/Default Implementations/Integer/IntPoint.swift
@@ -1,8 +1,9 @@
 //
 //  IntPoint.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
@@ -24,6 +25,7 @@ public struct BinaryIntegerPoint<Length: BinaryInteger>: MutablePoint2D {
 
 
 
+// MARK: - Common types
 
 public typealias IntPoint = BinaryIntegerPoint<Int>
 public typealias Int8Point = BinaryIntegerPoint<Int8>
@@ -36,3 +38,11 @@ public typealias UInt8Point = BinaryIntegerPoint<UInt8>
 public typealias UInt16Point = BinaryIntegerPoint<UInt16>
 public typealias UInt32Point = BinaryIntegerPoint<UInt32>
 public typealias UInt64Point = BinaryIntegerPoint<UInt64>
+
+
+
+// MARK: - Default conformances
+
+extension BinaryIntegerPoint: Equatable {}
+extension BinaryIntegerPoint: Hashable {}
+extension BinaryIntegerPoint: Codable where Length: Codable {}
diff --git a/Sources/RectangleTools/Default Implementations/Integer/IntRect.swift b/Sources/RectangleTools/Default Implementations/Integer/IntRect.swift
@@ -1,8 +1,9 @@
 //
 //  IntRect.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Default Implementations/Integer/IntSize.swift b/Sources/RectangleTools/Default Implementations/Integer/IntSize.swift
@@ -1,8 +1,9 @@
 //
 //  IntSize.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-22.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Synthesized Conveniences/Rectangle Extensions.swift b/Sources/RectangleTools/Synthesized Conveniences/Rectangle Extensions.swift
@@ -1,8 +1,9 @@
 //
 //  Rectangle Extensions.swift
-//  
+//  RectangleTools
 //
 //  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
 //
 
 import Foundation
diff --git a/Sources/RectangleTools/Synthesized Conveniences/Size2DCollection.swift b/Sources/RectangleTools/Synthesized Conveniences/Size2DCollection.swift
@@ -0,0 +1,166 @@
+//
+//  Integer Size Extensions.swift
+//  RectangleTools
+//
+//  Created by Ben Leggiero on 2019-12-04.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
+//
+
+import Foundation
+
+
+
+/// Allows you to treat an integer size as a grid which scans from top-left to bottom-right in left-to-right horizontal
+/// scanlines.
+///
+/// - Attention: Indices outside the bounds of the size are treated as its last element (bottom-rightmost)
+public protocol Size2DCollection: Collection, Size2D
+    where
+        Length: BinaryInteger,
+        Length.Stride: SignedInteger,
+        Index == Size2DCollectionIndex<Length>
+{
+    associatedtype Element = Size2DCollectionIndex<Length>
+    
+    
+    
+    /// Returns the index of the topmost-leftmost element in this size
+    var startIndex: Index { get }
+    
+    /// Returns the index of the bottommost-rightmost element in this size
+    var endIndex: Index { get }
+    
+    /// Returns the last index which addresses a real element.
+    ///
+    /// Any indices after this are not in this size and thus should not be addressed.
+    var lastValidIndex: Index { get }
+    
+    /// Returns the last element in this size
+    var lastValidElement: Element { get }
+    
+    
+    subscript(position: Index) -> Element { get }
+    
+    func index(after i: Index) -> Index
+    
+    
+    /// Maps this size to a 2D array of values, using the given transformer to generate them.
+    ///
+    /// This will scan the size from top-left to bottom-right in left-to-right horizontal scanlines.
+    ///
+    /// - Parameters:
+    ///   - transformer: The function which will transform each element to the new value/type
+    ///    - element: Each position in a scanline of this Size
+    /// - Returns: A 2D array of values as generated by the given transformer
+    /// - Throws: Anything the given transformer function changes
+    func map2D<ElementOfResult>(_ transformer: (_ element: Element) throws -> ElementOfResult) rethrows -> [[ElementOfResult]]
+}
+
+
+
+/// This functions as a basic point index in a 2D size collection.
+///
+/// - Note: This can't be a `BinaryIntegerPoint` since it strictly acts as a point in a scanline pattern, whereas a
+///         `BinaryIntegerPoint` can act as any point in an integer plane.
+public struct Size2DCollectionIndex<Length: BinaryInteger> {
+    
+    /// The position within a row of the scanline in a Size
+    let x: Length
+    
+    /// The row of a scanline in a Size
+    let y: Length
+}
+
+
+
+extension Size2DCollectionIndex: Comparable {
+    public static func < (lhs: Size2DCollectionIndex<Length>, rhs: Size2DCollectionIndex<Length>) -> Bool {
+        return lhs.y < rhs.y
+            || (lhs.y == rhs.y
+                && lhs.x < rhs.x
+        )
+    }
+}
+
+
+
+public extension Size2DCollection
+    where
+        Length: BinaryInteger,
+        Element == Index
+{
+    var startIndex: Index { Index(x: 0, y: 0) }
+    var endIndex: Index { Index(x: width, y: height) }
+    var lastValidIndex: Index { Index(x: width - 1, y: height - 1) }
+    
+    var lastValidElement: Element { lastValidIndex }
+    
+    
+    func index(after i: Index) -> Index {
+        if i.y >= lastValidIndex.y {
+            return lastValidIndex
+        }
+        else if i.x >= lastValidIndex.x {
+            return Index(x: 0, y: i.y.advanced(by: 1))
+        }
+        else {
+            return Index(x: i.x.advanced(by: 1), y: i.y)
+        }
+    }
+    
+    
+    subscript(position: Index) -> Element {
+        if position.x >= width
+            || position.y >= height {
+            return lastValidElement
+        }
+        else {
+            return position
+        }
+    }
+}
+
+
+
+public extension Size2DCollection where Element == Index {
+    func map2D<ElementOfResult>(_ transformer: (Element) throws -> ElementOfResult) rethrows -> [[ElementOfResult]] {
+        try (0..<height).map { y in
+            try (0..<width).map { x in
+                try transformer(Element(x: .init(x), y: .init(y)))
+            }
+        }
+    }
+}
+
+
+
+// MARK: - Conforming `BinaryIntegerSize` to this
+
+extension BinaryIntegerSize: Sequence
+    where
+        Length: BinaryInteger,
+        Length.Stride: SignedInteger
+{
+    public typealias Iterator = IndexingIterator<Self>
+}
+
+
+
+extension BinaryIntegerSize: Collection
+    where
+        Length: BinaryInteger,
+        Length.Stride: SignedInteger
+{
+    // Empty on-purpose; All witnesses synthesized
+}
+
+
+
+extension BinaryIntegerSize: Size2DCollection
+    where
+        Length: BinaryInteger,
+        Length.Stride: SignedInteger
+{
+    public typealias Index = Size2DCollectionIndex<Length>
+    public typealias Element = Index
+}
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -1,7 +1,16 @@
+//
+//  LinuxMain.swift
+//  RectangleTools
+//
+//  Created by Ben Leggiero on 2019-10-21.
+//  Copyright © 2019 Ben Leggiero BH-1-PS.
+//
+
 import XCTest
 
 import RectangleToolsTests
 
 var tests = [XCTestCaseEntry]()
 tests += RectangleToolsTests.allTests()
+tests += IntegerSizeTests.allTests()
 XCTMain(tests)
diff --git a/Tests/RectangleToolsTests/Integer Size Tests.swift b/Tests/RectangleToolsTests/Integer Size Tests.swift
diff --git a/Tests/RectangleToolsTests/RectangleToolsTests.swift b/Tests/RectangleToolsTests/RectangleToolsTests.swift
diff --git a/Tests/RectangleToolsTests/XCTestManifests.swift b/Tests/RectangleToolsTests/XCTestManifests.swift
