🎨 Remove some genericity from TurfCore

RemiBardon · Dec 4, 2022 · a383f71 · a383f71
1 parent 593393a
commit a383f71
Show file tree

Hide file tree

Showing 35 changed files with 1,471 additions and 941 deletions.
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Turf.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Turf.xcscheme
@@ -20,20 +20,6 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "NO"
-            buildForProfiling = "NO"
-            buildForArchiving = "NO"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "TurfTests"
-               BuildableName = "TurfTests"
-               BlueprintName = "TurfTests"
-               ReferencedContainer = "container:">
-            </BuildableReference>
-         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction
@@ -78,16 +64,21 @@
             skipped = "NO">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "TurfTests"
-               BuildableName = "TurfTests"
-               BlueprintName = "TurfTests"
+               BlueprintIdentifier = "TurfCoreTests"
+               BuildableName = "TurfCoreTests"
+               BlueprintName = "TurfCoreTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "GeodeticGeometryTests"
+               BuildableName = "GeodeticGeometryTests"
+               BlueprintName = "GeodeticGeometryTests"
                ReferencedContainer = "container:">
             </BuildableReference>
-            <SkippedTests>
-               <Test
-                  Identifier = "SnapshotTests">
-               </Test>
-            </SkippedTests>
          </TestableReference>
       </Testables>
    </TestAction>

diff --git a/Sources/Geodesy/CoordinateComponent.swift b/Sources/Geodesy/CoordinateComponent.swift
@@ -14,27 +14,24 @@ import SwiftGeoToolbox
 
 public typealias CoordinateComponent = ValueWithUnit.Value
 
-//	// MARK: CustomStringConvertible
-//
-//	var description: String {
-//		let formatter = NumberFormatter()
-//		formatter.numberStyle = .decimal
-//		formatter.maximumFractionDigits = 9
-//		formatter.locale = .en
-//		return formatter.string(for: Double(self))
-//			?? "\(self.rawValue.rawValue)"
-//	}
-
-//	// MARK: CustomDebugStringConvertible
-//
-//	var debugDescription: String {
-//		let formatter = NumberFormatter()
-//		formatter.numberStyle = .decimal
-//		formatter.maximumFractionDigits = 99
-//		formatter.locale = .en
-//		return formatter.string(for: Double(self))
-//			?? "\(self.rawValue.rawValue)"
-//	}
+// MARK: CustomStringConvertible & CustomDebugStringConvertible
+
+public extension CoordinateComponent {
+	var description: String {
+		let formatter = NumberFormatter()
+		formatter.numberStyle = .decimal
+		formatter.maximumFractionDigits = 9
+		formatter.locale = .en
+		return formatter.string(for: Double(self.rawValue)) ?? String(describing: self.rawValue)
+	}
+	var debugDescription: String {
+		let formatter = NumberFormatter()
+		formatter.numberStyle = .decimal
+		formatter.locale = .en
+		formatter.maximumFractionDigits = 99
+		return formatter.string(for: Double(self.rawValue)) ?? String(reflecting: self.rawValue)
+	}
+}
 
 // MARK: - ValidatableCoordinateComponent
 

diff --git a/Sources/Geodesy/Coordinates.swift b/Sources/Geodesy/Coordinates.swift
@@ -0,0 +1,243 @@
+//
+//  Coordinates.swift
+//  SwiftGeo
+//
+//  Created by Rémi Bardon on 01/10/2022.
+//  Copyright © 2022 Rémi Bardon. All rights reserved.
+//
+
+import SwiftGeoToolbox
+
+// MARK: - Coordinates
+
+public protocol Coordinates<CRS>:
+	Hashable,
+	Zeroable,
+	AdditiveArithmetic,
+	MultiplicativeArithmetic,
+	InitializableByNumber,
+	CustomStringConvertible,
+	CustomDebugStringConvertible
+{
+	associatedtype CRS: Geodesy.CoordinateReferenceSystem
+	associatedtype Components
+
+	var components: Components { get set }
+
+	init(components: Components)
+}
+
+// CustomStringConvertible & CustomDebugStringConvertible
+public extension Coordinates {
+	var description: String { String(describing: self.components) }
+	var debugDescription: String {
+		"<\(Self.CRS.epsgName)>\(String(reflecting: self.components))"
+	}
+}
+
+// MARK: 2D Coordinates
+
+public protocol AtLeastTwoDimensionalCoordinates<CRS>: Geodesy.Coordinates
+where CRS: AtLeastTwoDimensionalCRS {
+	associatedtype X: CoordinateComponent
+	associatedtype Y: CoordinateComponent
+
+	var x: X { get set }
+	var y: Y { get set }
+}
+
+public extension AtLeastTwoDimensionalCoordinates where X == Geodesy.Latitude {
+	typealias Latitude = Geodesy.Latitude
+	var latitude: Latitude { self.x }
+}
+
+public extension AtLeastTwoDimensionalCoordinates where Y == Geodesy.Longitude {
+	typealias Longitude = Geodesy.Longitude
+	var longitude: Longitude { self.y }
+}
+
+public protocol TwoDimensionalCoordinates<CRS>: AtLeastTwoDimensionalCoordinates
+where Components == (X, Y) {
+	init(x: X, y: Y)
+}
+
+public struct Coordinates2DOf<CRS>: TwoDimensionalCoordinates
+where CRS: TwoDimensionalCRS
+{
+	public typealias X = CRS.CoordinateSystem.Axis1.Value
+	public typealias Y = CRS.CoordinateSystem.Axis2.Value
+
+	public var x: X
+	public var y: Y
+
+	public var components: (X, Y) {
+		get { (self.x, self.y) }
+		set {
+			self.x = newValue.0
+			self.y = newValue.1
+		}
+	}
+
+	public init(x: X, y: Y) {
+		#warning("TODO: Perform validations")
+		self.x = x
+		self.y = y
+	}
+	public init(components: (X, Y)) {
+		self.init(x: components.0, y: components.1)
+	}
+}
+
+// Zeroable
+public extension Coordinates2DOf {
+	static var zero: Self { Self.init(x: .zero, y: .zero) }
+}
+
+// AdditiveArithmetic
+public extension Coordinates2DOf {
+	static func + (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x + rhs.x, y: lhs.y + rhs.y)
+	}
+	static func - (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x - rhs.x, y: lhs.y - rhs.y)
+	}
+}
+// MultiplicativeArithmetic
+public extension Coordinates2DOf {
+	static func * (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x * rhs.x, y: lhs.y * rhs.y)
+	}
+	static func / (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x / rhs.x, y: lhs.y / rhs.y)
+	}
+}
+
+// InitializableByInteger
+public extension Coordinates2DOf {
+	init<Source: BinaryInteger>(_ value: Source) {
+		self.init(x: .init(value), y: .init(value))
+	}
+}
+// InitializableByFloatingPoint
+public extension Coordinates2DOf {
+	init<Source: BinaryFloatingPoint>(_ value: Source) {
+		self.init(x: .init(value), y: .init(value))
+	}
+}
+
+public extension TwoDimensionalCoordinates where X == Latitude {
+	var latitude: X { self.x }
+}
+public extension TwoDimensionalCoordinates where Y == Longitude {
+	var longitude: Y { self.y }
+	var withPositiveLongitude: Self {
+		Self.init(x: self.x, y: self.longitude.positive)
+	}
+}
+public extension TwoDimensionalCoordinates
+where X == Latitude, Y == Longitude
+{
+	init(latitude: X, longitude: Y) {
+		self.init(x: latitude, y: longitude)
+	}
+}
+
+// MARK: 3D Coordinates
+
+public protocol AtLeastThreeDimensionalCoordinates<CRS>: AtLeastTwoDimensionalCoordinates
+where CRS: AtLeastTwoDimensionalCRS {
+	associatedtype Z: CoordinateComponent
+
+	var z: Z { get set }
+}
+public protocol ThreeDimensionalCoordinates<CRS>: AtLeastThreeDimensionalCoordinates
+where Components == (X, Y, Z) {
+	init(x: X, y: Y, z: Z)
+}
+
+public struct Coordinates3DOf<CRS: ThreeDimensionalCRS>: ThreeDimensionalCoordinates {
+	public typealias X = CRS.CoordinateSystem.Axis1.Value
+	public typealias Y = CRS.CoordinateSystem.Axis2.Value
+	public typealias Z = CRS.CoordinateSystem.Axis3.Value
+
+	public var x: X
+	public var y: Y
+	public var z: Z
+
+	public var components: (X, Y, Z) {
+		get { (self.x, self.y, self.z) }
+		set {
+			self.x = newValue.0
+			self.y = newValue.1
+			self.z = newValue.2
+		}
+	}
+
+	public init(x: X, y: Y, z: Z) {
+		#warning("TODO: Perform validations")
+		self.x = x
+		self.y = y
+		self.z = z
+	}
+	public init(components: (X, Y, Z)) {
+		self.init(x: components.0, y: components.1, z: components.2)
+	}
+}
+
+// Zeroable
+public extension Coordinates3DOf {
+	static var zero: Self { Self.init(x: .zero, y: .zero, z: .zero) }
+}
+
+// AdditiveArithmetic
+public extension Coordinates3DOf {
+	static func + (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x + rhs.x, y: lhs.y + rhs.y, z: lhs.z + rhs.z)
+	}
+	static func - (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x - rhs.x, y: lhs.y - rhs.y, z: lhs.z - rhs.z)
+	}
+}
+// MultiplicativeArithmetic
+public extension Coordinates3DOf {
+	static func * (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x * rhs.x, y: lhs.y * rhs.y, z: lhs.z * rhs.z)
+	}
+	static func / (lhs: Self, rhs: Self) -> Self {
+		Self.init(x: lhs.x / rhs.x, y: lhs.y / rhs.y, z: lhs.z / rhs.z)
+	}
+}
+
+// InitializableByInteger
+public extension Coordinates3DOf {
+	init<Source: BinaryInteger>(_ value: Source) {
+		self.init(x: .init(value), y: .init(value), z: .init(value))
+	}
+}
+// InitializableByFloatingPoint
+public extension Coordinates3DOf {
+	init<Source: BinaryFloatingPoint>(_ value: Source) {
+		self.init(x: .init(value), y: .init(value), z: .init(value))
+	}
+}
+
+public extension ThreeDimensionalCoordinates where X == Latitude {
+	var latitude: X { self.x }
+}
+public extension ThreeDimensionalCoordinates where Y == Longitude {
+	var longitude: Y { self.y }
+	var withPositiveLongitude: Self {
+		Self.init(x: self.x, y: self.longitude.positive, z: self.z)
+	}
+}
+public extension ThreeDimensionalCoordinates where Z == Altitude {
+	var altitude: Z { self.z }
+}
+
+public extension ThreeDimensionalCoordinates
+where X == Latitude, Y == Longitude, Z == Altitude
+{
+	init(latitude: X, longitude: Y, altitude: Z) {
+		self.init(x: latitude, y: longitude, z: altitude)
+	}
+}