Clean up the Diffing and Diffing.Myers benchmarks

Author: numist

benchmark/CMakeLists.txt

@@ -79,6 +79,7 @@ set(SWIFT_BENCH_MODULES
     single-source/DictionarySubscriptDefault
     single-source/DictionarySwap
     single-source/Diffing
+    single-source/DiffingMyers
     single-source/DropFirst
     single-source/DropLast
     single-source/DropWhile
@@ -105,7 +106,6 @@ set(SWIFT_BENCH_MODULES
     single-source/Memset
     single-source/MonteCarloE
     single-source/MonteCarloPi
-    single-source/Myers
     single-source/NSDictionaryCastToSwift
     single-source/NSError
     single-source/NSStringConversion

benchmark/single-source/Diffing.swift

@@ -15,111 +15,55 @@ import TestsUtils
 let t: [BenchmarkCategory] = [.api]
 public let Diffing = [
   BenchmarkInfo(
-    name: "DiffSame",
-    runFunction: run_DiffSame,
+    name: "Diffing.Same",
+    runFunction: { diff($0, from: longPangram, to: longPangram) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole(longPangram) }),
   BenchmarkInfo(
-    name: "DiffPangramToAlphabet",
-    runFunction: run_DiffPangramToAlphabet,
+    name: "Diffing.PangramToAlphabet",
+    runFunction: { diff($0, from: longPangram, to: alphabets) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((longPangram, alphabets)) }),
   BenchmarkInfo(
-    name: "DiffPangrams",
-    runFunction: run_DiffPangrams,
+    name: "Diffing.Pangrams",
+    runFunction: { diff($0, from:typingPangram, to: longPangram) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((longPangram, typingPangram)) }),
   BenchmarkInfo(
-    name: "DiffReversedAlphabets",
-    runFunction: run_DiffReversedAlphabets,
+    name: "Diffing.ReversedAlphabets",
+    runFunction: { diff($0, from:alphabets, to: alphabetsReversed) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((alphabets, alphabetsReversed)) }),
   BenchmarkInfo(
-    name: "DiffReversedLorem",
-    runFunction: run_DiffReversedLorem,
+    name: "Diffing.ReversedLorem",
+    runFunction: { diff($0, from: loremIpsum, to: loremReversed) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((loremIpsum, loremReversed)) }),
   BenchmarkInfo(
-    name: "DiffDisparate",
-    runFunction: run_DiffDisparate,
+    name: "Diffing.Disparate",
+    runFunction: { diff($0, from: numbersAndSymbols, to: alphabets) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((numbersAndSymbols, alphabets)) }),
   BenchmarkInfo(
-    name: "DiffSimilar",
-    runFunction: run_DiffSimilar,
+    name: "Diffing.Similar",
+    runFunction: { diff($0, from: unabridgedLorem, to: loremIpsum) },
     tags: t,
-    legacyFactor: 10),
+    setUpFunction: { blackHole((unabridgedLorem, loremIpsum)) }),
 ]
 
 let numbersAndSymbols = Array("0123456789`~!@#$%^&*()+=_-\"'?/<,>.\\{}'")
 let alphabets = Array("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
-let alphabetsReversed = Array("ZYXWVUTSRQPONMLKJIHGFEDCBAzyxwvutsrqponmlkjihgfedcba")
+let alphabetsReversed = Array(alphabets.reversed())
 let longPangram = Array("This pangram contains four As, one B, two Cs, one D, thirty Es, six Fs, five Gs, seven Hs, eleven Is, one J, one K, two Ls, two Ms, eighteen Ns, fifteen Os, two Ps, one Q, five Rs, twenty-seven Ss, eighteen Ts, two Us, seven Vs, eight Ws, two Xs, three Ys, & one Z")
 let typingPangram = Array("The quick brown fox jumps over the lazy dog")
 let loremIpsum = Array("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.")
 let unabridgedLorem = Array("Lorem ipsum, quia dolor sit amet consectetur adipisci[ng] velit, sed quia non-numquam [do] eius modi tempora inci[di]dunt, ut labore et dolore magnam aliqua.")
-let loremReverse = Array(".auqila angam erolod te erobal tu tnudidicni ropmet domsuie od des ,tile gnicsipida rutetcesnoc ,tema tis rolod muspi meroL")
+let loremReversed = Array(loremIpsum.reversed())
 
-
-@inline(never)
-public func run_DiffSame(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = longPangram.difference(from: longPangram)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffPangramToAlphabet(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = longPangram.difference(from: alphabets)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffPangrams(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = longPangram.difference(from: typingPangram)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffReversedAlphabets(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = alphabets.difference(from: alphabetsReversed)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffReversedLorem(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = loremIpsum.difference(from: loremReverse)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffDisparate(_ N: Int) {
-  if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
-    for _ in 1...N {
-      let _ = alphabets.difference(from: numbersAndSymbols)
-    }
-  }
-}
-
-@inline(never)
-public func run_DiffSimilar(_ N: Int) {
+@inline(never) func diff(_ N: Int, from older: [Character], to newer: [Character]) {
   if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
     for _ in 1...N {
-      let _ = loremIpsum.difference(from: unabridgedLorem)
+      blackHole(newer.difference(from: older))
     }
   }
 }

benchmark/single-source/Myers.swift renamed to benchmark/single-source/DiffingMyers.swift

@@ -1,4 +1,4 @@
-//===--- Myers.swift -------------------------------------------===//
+//===--- DiffingMyers.swift -----------------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -12,18 +12,25 @@
 
 import TestsUtils
 
-public let Myers = [
-  BenchmarkInfo(name: "Myers", runFunction: run_Myers, tags: [.algorithm]),
-]
+// The DiffingMyers test benchmarks Swift's performance running the algorithm
+// described in Myers (1986). The Diffing benchmark tracks the performance
+// of `Collection.difference(from:to:)`.
 
-let loremShort = Array("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
-let loremLong = Array("Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci[ng] velit, sed quia non-numquam [do] eius modi tempora inci[di]dunt, ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum[d] exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?")
+public let DiffingMyers = BenchmarkInfo(
+  name: "Diffing.Myers.Similar",
+  runFunction: run_Myers,
+  tags: [.algorithm],
+  setUpFunction: { blackHole((loremIpsum, unabridgedLorem)) })
+
+
+let loremIpsum = Array("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.")
+let unabridgedLorem = Array("Lorem ipsum, quia dolor sit amet consectetur adipisci[ng] velit, sed quia non-numquam [do] eius modi tempora inci[di]dunt, ut labore et dolore magnam aliqua.")
 
 @inline(never)
 public func run_Myers(N: Int) {
   if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
     for _ in 1...N {
-      let _ = myers(from: loremShort, to: loremLong, using: ==)
+      blackHole(myers(from: unabridgedLorem, to: loremIpsum, using: ==))
     }
   }
 }
@@ -193,4 +200,4 @@ fileprivate func myers<C,D>(
       return CollectionDifference(_formChanges(from: a, to: b, using:_descent(from: a, to: b)))!
     }
   }
-}
+}

benchmark/utils/main.swift

@@ -67,6 +67,7 @@ import DictionaryRemove
 import DictionarySubscriptDefault
 import DictionarySwap
 import Diffing
+import DiffingMyers
 import DropFirst
 import DropLast
 import DropWhile
@@ -93,7 +94,6 @@ import MapReduce
 import Memset
 import MonteCarloE
 import MonteCarloPi
-import Myers
 import NibbleSort
 import NIOChannelPipeline
 import NSDictionaryCastToSwift
@@ -243,6 +243,7 @@ registerBenchmark(DictionaryRemove)
 registerBenchmark(DictionarySubscriptDefault)
 registerBenchmark(DictionarySwap)
 registerBenchmark(Diffing)
+registerBenchmark(DiffingMyers)
 registerBenchmark(DropFirst)
 registerBenchmark(DropLast)
 registerBenchmark(DropWhile)
@@ -270,7 +271,6 @@ registerBenchmark(MapReduce)
 registerBenchmark(Memset)
 registerBenchmark(MonteCarloE)
 registerBenchmark(MonteCarloPi)
-registerBenchmark(Myers)
 registerBenchmark(NSDictionaryCastToSwift)
 registerBenchmark(NSErrorTest)
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)