From 3aa70a3f53f1d329508540228e497cadbe12613f Mon Sep 17 00:00:00 2001
From: Drewniok <jan.drewniok.research@gmail.com>
Date: Wed, 22 Nov 2023 15:13:12 +0100
Subject: [PATCH] :sparkles: introduce benchmark for simulators.

---
 test/benchmark/simulation.cpp | 85 +++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 test/benchmark/simulation.cpp

diff --git a/test/benchmark/simulation.cpp b/test/benchmark/simulation.cpp
new file mode 100644
index 000000000..f9d3e0c16
--- /dev/null
+++ b/test/benchmark/simulation.cpp
@@ -0,0 +1,85 @@
+//
+// Created by Jan Drewniok on 22.11.23.
+//
+
+#include <catch2/benchmark/catch_benchmark.hpp>
+#include <catch2/catch_test_macros.hpp>
+
+#include <fiction/algorithms/simulation/sidb/quickexact.hpp>
+#include <fiction/algorithms/simulation/sidb/quicksim.hpp>
+#include <fiction/technology/cell_technologies.hpp>
+#include <fiction/types.hpp>
+
+using namespace fiction;
+
+TEST_CASE("Benchmark simulators", "[benchmark]")
+{
+    // crossing bestagon gate
+    sidb_cell_clk_lyt_siqad lyt{};
+
+    lyt.assign_cell_type({36, 1, 0}, sidb_technology::cell_type::INPUT);
+    lyt.assign_cell_type({2, 1, 0}, sidb_technology::cell_type::INPUT);
+
+    lyt.assign_cell_type({0, 0, 0}, sidb_technology::cell_type::INPUT);
+    lyt.assign_cell_type({38, 0, 0}, sidb_technology::cell_type::INPUT);
+
+    lyt.assign_cell_type({6, 2, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({20, 12, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({8, 3, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({14, 5, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({14, 11, 1}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({12, 4, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({14, 15, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({26, 4, 0}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({14, 9, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({24, 15, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({12, 16, 0}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({18, 9, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({26, 16, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({24, 13, 1}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({24, 5, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({30, 3, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({16, 13, 1}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({32, 2, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({20, 8, 0}, sidb_technology::cell_type::NORMAL);
+
+    lyt.assign_cell_type({30, 17, 0}, sidb_technology::cell_type::OUTPUT);
+    lyt.assign_cell_type({6, 18, 0}, sidb_technology::cell_type::OUTPUT);
+
+    lyt.assign_cell_type({32, 18, 0}, sidb_technology::cell_type::OUTPUT);
+    lyt.assign_cell_type({8, 17, 0}, sidb_technology::cell_type::OUTPUT);
+
+    lyt.assign_cell_type({2, 19, 0}, sidb_technology::cell_type::NORMAL);
+    lyt.assign_cell_type({36, 19, 0}, sidb_technology::cell_type::NORMAL);
+
+    BENCHMARK("QuickExact")
+    {
+        const quickexact_params<sidb_cell_clk_lyt_siqad> sim_params{sidb_simulation_parameters{2, -0.32}};
+        return quickexact<sidb_cell_clk_lyt_siqad>(lyt, sim_params);
+    };
+
+    BENCHMARK("QuickSim")
+    {
+        const quicksim_params quicksim_params{sidb_simulation_parameters{2, -0.32}};
+        return quicksim<sidb_cell_clk_lyt_siqad>(lyt, quicksim_params);
+    };
+}
+
+//  Mac M1, Ventura 13.0, Apple clang version 14.0.0 (22.11.23)
+
+//    benchmark name    samples          iterations          est run time
+//                      mean             low mean            high mean
+//                      std dev          low std dev         high std dev
+//    -------------------------------------------------------------------------------
+//    QuickExact        100             1                    1.75185 m
+//                      1.03471 s       1.03254 s            1.03694 s
+//                      11.2095 ms      10.2241 ms           12.5137 ms
+//
+//    QuickSim          100              1                   449.61 ms
+//                      4.49349 ms      4.47125 ms           4.51652 ms
+//                      115.682 us      101.563 us           135.051 us