Merge pull request #15 from heckj/main

adds sub-project with benchmarks

Author: tayloraswift

.github/workflows/build.yml

@@ -18,6 +18,28 @@ jobs:
             run: |
               swift --version
               swift build
+
+    benchmark-macos:
+        runs-on: macos-14
+        steps:
+          - uses: actions/checkout@v3
+          - uses: SwiftyLab/setup-swift@latest
+            with:
+              swift-version: "5.10.0"
+          - name: Homebrew Mac
+            if: ${{ runner.os == 'Macos' }}
+            run: |
+              echo "/opt/homebrew/bin:/usr/local/bin" >> $GITHUB_PATH
+              brew install jemalloc
+          - name: Ubuntu deps
+            if: ${{ runner.os == 'Linux' }}
+            run: |
+              sudo apt-get install -y libjemalloc-dev
+          - name: benchmark
+            run: |
+              cd ExternalBenchmarks
+              swift package benchmark
+
     build-linux:
         runs-on: ubuntu-22.04
         steps:

ExternalBenchmarks/.benchmarkBaselines/ExternalBenchmarks/bdb4ef08/results.json

@@ -0,0 +1,10 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+.vscode

ExternalBenchmarks/.gitignore

@@ -0,0 +1,102 @@
+import Benchmark
+import Noise
+import Foundation
+
+let viewer_size: Int = 1024
+let offset: Double = 0
+
+// running at roughly 500ms for a pass, so maxDuration will limit far before iteration count for this
+//func cell2d() async -> Data {
+//    var pixbuf:[UInt8]  = [UInt8](repeating: 0, count: viewer_size * viewer_size)
+//    for (i, (x, y)) in Domain2D(samples_x: viewer_size, samples_y: viewer_size).enumerated() {
+//        pixbuf[i] = UInt8(max(0, min(255, CellNoise2D(amplitude: 255, frequency: 0.01).evaluate(x, y) + offset)))
+//    }
+//    return Data(pixbuf)
+//}
+
+let benchmarks = {
+    Benchmark.defaultConfiguration.maxIterations = .count(1024 * 1024) // Default = 100_000
+    Benchmark.defaultConfiguration.maxDuration = .seconds(1) // Default = 1 second
+    Benchmark.defaultConfiguration.metrics = [.throughput, .wallClock]
+    
+    Benchmark("disk2d") { benchmark in
+        var poisson = DiskSampler2D(seed: 0)
+        for _ in benchmark.scaledIterations {
+            blackHole(poisson.generate(radius: 10, width: viewer_size, height: viewer_size))
+        }
+    }
+    
+    Benchmark("cell2d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(CellNoise2D(amplitude: 255, frequency: 0.01))
+        }
+    }
+    
+    Benchmark("cell3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(CellNoise3D(amplitude: 255, frequency: 0.01))
+        }
+    }
+
+    Benchmark("cell_tiling3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                TilingCellNoise3D(amplitude: 255,
+                                  frequency: 16 / Double(viewer_size),
+                                  wavelengths: 16)
+            )
+        }
+    }
+
+    Benchmark("classic_tiling_fbm3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                FBM<TilingClassicNoise3D>(
+                    tiling: TilingClassicNoise3D(amplitude: 255,
+                                                 frequency: 16 / Double(viewer_size),
+                                                 wavelengths: 16),
+                    octaves: 10,
+                    persistence: 0.62)
+            )
+        }
+    }
+
+    Benchmark("classic3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                FBM<ClassicNoise3D>(ClassicNoise3D(amplitude: 255, frequency: 0.001),
+                    octaves: 10, persistence: 0.62)
+            )
+        }
+    }
+
+    
+    Benchmark("classic_tiling3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                TilingClassicNoise3D(amplitude: 255, frequency: 16 / Double(viewer_size), wavelengths: 16)
+            )
+        }
+    }
+    Benchmark("gradient2d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                FBM<GradientNoise2D>(GradientNoise2D(amplitude: 180, frequency: 0.001), octaves: 10, persistence: 0.62)
+            )
+        }
+    }
+
+    Benchmark("gradient3d") { benchmark in
+        for _ in benchmark.scaledIterations {
+            blackHole(
+                FBM<GradientNoise3D>(GradientNoise3D(amplitude: 180, frequency: 0.001), octaves: 10, persistence: 0.62)
+            )
+        }
+    }
+
+    
+    
+    
+    
+}
+

ExternalBenchmarks/Benchmarks/ExternalBenchmarks/ExternalBenchmarks.swift

@@ -0,0 +1,25 @@
+// swift-tools-version: 5.9
+
+import PackageDescription
+
+let package = Package(
+    name: "ExternalBenchmarks",
+    platforms: [
+        .macOS(.v13),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.0.0")),
+        .package(path: "../"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "ExternalBenchmarks",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                .product(name: "BenchmarkPlugin", package: "package-benchmark"),
+                .product(name: "Noise", package: "swift-noise"),
+            ],
+            path: "Benchmarks/ExternalBenchmarks"
+        )
+    ]
+)

ExternalBenchmarks/Package.resolved

@@ -0,0 +1,46 @@
+# ExternalBenchmarks
+
+Additional benchmarks that utilize https://github.com/ordo-one/package-benchmark.
+
+This code is explicitly in a subdirectory with a local reference to swift-noise
+in order avoid adding transitive dependencies.
+
+To run the benchmarks, invoke the following command:
+
+    swift package benchmark
+
+## Using Benchmarks
+
+- [Documentation for the package](https://swiftinit.org/docs/package-benchmark/benchmark/gettingstarted)
+  - [Creating and Comparing Baselines](https://swiftinit.org/docs/package-benchmark/benchmark/creatingandcomparingbaselines)
+  - [Exporting Benchmark Results](https://swiftinit.org/docs/package-benchmark/benchmark/exportingbenchmarks)
+
+## Baselines
+
+The baselines are set by commit hash (first 8 hex characters) or (in the future) tag with this work in place.
+The initial baseline is `bdb4ef08`.
+It builds on the tag `1.0.0` with updates to dependencies and Swift versions and no functional code changes.
+
+```bash
+swift package --allow-writing-to-package-directory benchmark baseline update bdb4ef08
+```
+
+To compare current development branch against this baseline, run the following command from this sub-project in the terminal:
+
+```bash
+swift package benchmark baseline compare bdb4ef08
+```
+
+The output defaults to plain text. If you'd like markdown output, for pasting into a pull request, add `--format markdown` to the command.
+
+For a summary comparison, use the command:
+
+```bash
+swift package benchmark baseline check --check-absolute
+```
+
+### Stored Baselines
+
+`bdb4ef08`: M1 macbook pro, 16GB ram, running only iTerm2
+
+