chore: apply formatting

Author: GNMoseke

Package.swift

@@ -15,7 +15,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-collections.git", from: "1.1.4")
+        .package(url: "https://github.com/apple/swift-collections.git", from: "1.1.4"),
     ],
     targets: [
         .target(
@@ -28,13 +28,13 @@ let package = Package(
         .target(
             name: "OrderedCollectionsDifferentiable",
             dependencies: [
-                .product(name: "OrderedCollections", package: "swift-collections")
+                .product(name: "OrderedCollections", package: "swift-collections"),
             ]
         ),
         .testTarget(
             name: "OrderedCollectionsDifferentiableTests",
             dependencies: [
-                "OrderedCollectionsDifferentiable"
+                "OrderedCollectionsDifferentiable",
             ]
         ),
     ]

Sources/OrderedCollectionsDifferentiable/OrderedDictionary+Differentiable.swift

@@ -4,7 +4,7 @@ import _Differentiation
 
 extension OrderedDictionary: @retroactive Differentiable where Value: Differentiable {
     public typealias TangentVector = OrderedDictionary<Key, Value.TangentVector>
-    
+
     public mutating func move(by direction: TangentVector) {
         for (componentKey, componentDirection) in direction {
             func fatalMissingComponent() -> Value {
@@ -29,7 +29,8 @@ extension OrderedDictionary: @retroactive AdditiveArithmetic where Value: Additi
 }
 
 extension OrderedDictionary where Value: Differentiable {
-    /// Defines a derivative for `OrderedDictionary`s subscript getter enabling calls like `var value = dictionary[key]` to be differentiable
+    /// Defines a derivative for `OrderedDictionary`s subscript getter enabling calls like `var value = dictionary[key]` to be
+    /// differentiable
     @inlinable
     @derivative(of: subscript(_:))
     func _vjpSubscript(key: Key)
@@ -38,7 +39,8 @@ extension OrderedDictionary where Value: Differentiable {
         let keys = self.keys
         // When adding two dictionaries, nil values are equivalent to zeroes, so there is no need to manually zero-out
         // every key's value. Instead, it is faster to create a dictionary with the single non-zero entry.
-        // for ordered dictionaries however we can't because the keys will be added in reverse order so the tangentvector's key order will be different from the original
+        // for ordered dictionaries however we can't because the keys will be added in reverse order so the tangentvector's key order will
+        // be different from the original
         return (
             value: self[key],
             pullback: { tangentVector in
@@ -61,4 +63,3 @@ extension OrderedDictionary where Value: Differentiable {
 // TODO: make `OrderedDictionary.Values` and `OrderedDictionary.Elements` differentiable
 
 #endif
-

Tests/OrderedCollectionsDifferentiableTests/OrderedDictionary+DifferentiableTests.swift

@@ -43,23 +43,28 @@ struct DictionaryDifferentiationTests {
         #expect(vwg.value == 140.0)
         #expect(vwg.gradient == ["s1": 1.0, "s2": 2.0, "s3": 3.0])
     }
-    
-    
-    
+
     @Test
     func testOrderedDictionaryInoutWriteMethod() {
         @differentiable(reverse)
-        func combineByReplacingDictionaryValues(of mainDict: inout OrderedDictionary<String, Double>, with otherDict: OrderedDictionary<String, Double>) {
+        func combineByReplacingDictionaryValues(
+            of mainDict: inout OrderedDictionary<String, Double>,
+            with otherDict: OrderedDictionary<String, Double>
+        ) {
             for key in withoutDerivative(at: otherDict.keys) {
-                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt differentiation)
+                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt
+                // differentiation)
                 // swift-format-ignore: NeverForceUnwrap
                 let otherValue = otherDict[key]!
                 mainDict.update(at: key, with: otherValue)
             }
         }
 
         @differentiable(reverse)
-        func inoutWrapper(dictionary: OrderedDictionary<String, Double>, otherDictionary: OrderedDictionary<String, Double>) -> OrderedDictionary<String, Double> {
+        func inoutWrapper(
+            dictionary: OrderedDictionary<String, Double>,
+            otherDictionary: OrderedDictionary<String, Double>
+        ) -> OrderedDictionary<String, Double> {
             // we wrap the `combineByReplacingDictionaryValues`
             var mainCopy = dictionary
             combineByReplacingDictionaryValues(of: &mainCopy, with: otherDictionary)
@@ -68,7 +73,7 @@ struct DictionaryDifferentiationTests {
 
         let vwpb = valueWithPullback(
             at: ["s1": 10.0, "s2": 20.0, "s3": 30.0],
-            ["s1": 2.0],  //, "s2": nil, "s3": nil],
+            ["s1": 2.0], // , "s2": nil, "s3": nil],
             of: inoutWrapper
         )
 
@@ -82,9 +87,13 @@ struct DictionaryDifferentiationTests {
     @Test
     func testInoutWriteAndSumValues() {
         @differentiable(reverse)
-        func combineByReplacingDictionaryValues(of mainDict: inout OrderedDictionary<String, Double>, with otherDict: OrderedDictionary<String, Double>) {
+        func combineByReplacingDictionaryValues(
+            of mainDict: inout OrderedDictionary<String, Double>,
+            with otherDict: OrderedDictionary<String, Double>
+        ) {
             for key in withoutDerivative(at: otherDict.keys) {
-                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt differentiation)
+                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt
+                // differentiation)
                 // swift-format-ignore: NeverForceUnwrap
                 let otherValue = otherDict[key]!
                 mainDict.update(at: key, with: otherValue)
@@ -93,25 +102,29 @@ struct DictionaryDifferentiationTests {
 
         @differentiable(reverse)
         func sumValues(of dictionary: OrderedDictionary<String, Double>) -> Double {
-            var sum: Double = 0.0
+            var sum = 0.0
             for key in withoutDerivative(at: dictionary.keys) {
-                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt differentiation)
+                // note that we cannot use #require here as this function cannot throw (due to current compiler constraints wrt
+                // differentiation)
                 // swift-format-ignore: NeverForceUnwrap
                 sum += dictionary[key]!
             }
             return sum
         }
-        @differentiable(reverse,wrt: dictionary)
+        @differentiable(reverse, wrt: dictionary)
 
-        func inoutWrapperAndSum(dictionary: OrderedDictionary<String, Double>, otherDictionary: OrderedDictionary<String, Double>) -> Double {
+        func inoutWrapperAndSum(
+            dictionary: OrderedDictionary<String, Double>,
+            otherDictionary: OrderedDictionary<String, Double>
+        ) -> Double {
             var mainCopy = dictionary
             combineByReplacingDictionaryValues(of: &mainCopy, with: otherDictionary)
             return sumValues(of: mainCopy)
         }
 
         let vwg = valueWithGradient(
             at: ["s1": 10.0, "s2": 20.0, "s3": 30.0],
-            ["s1": 2.0],  //, "s2": nil, "s3": nil],
+            ["s1": 2.0], // , "s2": nil, "s3": nil],
             of: inoutWrapperAndSum
         )