feat: install codspeed

Author: art049

.github/workflows/codspeed.yml

@@ -0,0 +1,52 @@
+name: CodSpeed Benchmarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: codspeed-macro
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: 1.83.0
+
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: cargo-registry-${{ runner.arch }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            cargo-registry-${{ runner.arch }}-
+
+      - name: Cache target directory
+        uses: actions/cache@v4
+        with:
+          path: target
+          key: cargo-target-${{ runner.arch }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            cargo-target-${{ runner.arch }}-
+
+      - name: Install cargo-codspeed
+        run: cargo install cargo-codspeed --locked
+
+      - name: Build benchmarks
+        run: cargo codspeed build
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v4
+        with:
+          mode: walltime
+          run: cargo codspeed run

.gitignore

@@ -12,3 +12,4 @@ Cargo.lock
 # OS files
 .DS_Store
 Thumbs.db
+target

Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 [dependencies]
 
 [dev-dependencies]
-divan = "0.1"
+divan = { package = "codspeed-divan-compat", version = "4.2.1" }
 
 [[bench]]
 name = "particle_simulation"

benches/particle_simulation.rs

@@ -4,11 +4,15 @@ fn main() {
     divan::main();
 }
 
+const SMALL: usize = 100_000;
+const MEDIUM: usize = 1_000_000;
+const LARGE: usize = 10_000_000;
+
 // ============================================================================
 // Array of Structures (AoS) - Cache Unfriendly
 // ============================================================================
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn aos_update_positions(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| aos::ParticleSystem::new(count))
@@ -17,7 +21,7 @@ fn aos_update_positions(bencher: divan::Bencher, count: usize) {
         });
 }
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn aos_kinetic_energy(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| aos::ParticleSystem::new(count))
@@ -26,7 +30,7 @@ fn aos_kinetic_energy(bencher: divan::Bencher, count: usize) {
         });
 }
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn aos_apply_gravity(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| aos::ParticleSystem::new(count))
@@ -39,7 +43,7 @@ fn aos_apply_gravity(bencher: divan::Bencher, count: usize) {
 // Structure of Arrays - Cache Friendly
 // ============================================================================
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn soa_update_positions(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| soa::ParticleSystem::new(count))
@@ -48,7 +52,7 @@ fn soa_update_positions(bencher: divan::Bencher, count: usize) {
         });
 }
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn soa_kinetic_energy(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| soa::ParticleSystem::new(count))
@@ -57,7 +61,7 @@ fn soa_kinetic_energy(bencher: divan::Bencher, count: usize) {
         });
 }
 
-#[divan::bench(args = [1_000, 10_000, 100_000])]
+#[divan::bench(args = [SMALL, MEDIUM, LARGE])]
 fn soa_apply_gravity(bencher: divan::Bencher, count: usize) {
     bencher
         .with_inputs(|| soa::ParticleSystem::new(count))