Add google/benchmarks

Author: ramsafin

.clang-tidy

@@ -11,7 +11,7 @@ Checks: >
 
 UseColor: true
 WarningsAsErrors: ''
-HeaderFilterRegex: '.*'
+HeaderFilterRegex: '^(include|src|tests|benchmarks)/'
 FormatStyle: file
 CheckOptions:
   - key: modernize-use-nullptr.NullMacros

CMakeLists.txt

@@ -9,9 +9,10 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # Options
-option(ENABLE_TESTING "Build tests" ON)
-option(BUILD_APP      "Build the demo application" ON)
-option(BUILD_DOCS     "Enable documentation via Doxygen" ON)
+option(ENABLE_TESTING    "Build tests" ON)
+option(ENABLE_BENCHMARKS "Build benchmarks" ON)
+option(BUILD_APP         "Build the demo application" ON)
+option(BUILD_DOCS        "Build documentation via Doxygen" ON)
 
 # Add custom "Sanitize" build type
 if(CMAKE_CONFIGURATION_TYPES)
@@ -42,6 +43,10 @@ if(ENABLE_TESTING)
   add_subdirectory(tests)
 endif()
 
+if(ENABLE_BENCHMARKS)
+  add_subdirectory(benchmarks)
+endif()
+
 # === Docs ===
 if(BUILD_DOCS)
   include(tools/Doxygen)

CMakePresets.json

@@ -12,6 +12,7 @@
       "binaryDir": "${sourceDir}/build/${presetName}",
       "cacheVariables": {
         "ENABLE_TESTING": "ON",
+        "ENABLE_BENCHMARKS": "ON",
         "BUILD_APP": "ON",
         "BUILD_DOCS": "ON",
         "CMAKE_EXPORT_COMPILE_COMMANDS": "ON"

benchmarks/CMakeLists.txt

@@ -0,0 +1,21 @@
+include(FetchContent)
+
+set(BENCHMARK_ENABLE_TESTING OFF CACHE BOOL "Disable benchmark library tests")
+
+FetchContent_Declare(
+  benchmark
+  URL https://github.com/google/benchmark/archive/refs/tags/v1.9.4.zip
+  DOWNLOAD_EXTRACT_TIMESTAMP TRUE  # Prevents timestamp-related rebuild issues
+)
+
+FetchContent_MakeAvailable(benchmark)
+
+add_executable(benchmarks
+  bench_arithmetic.cpp
+)
+
+target_link_libraries(benchmarks
+  PRIVATE benchmark::benchmark benchmark::benchmark_main ${PROJECT_NAME}::math
+)
+
+enable_strict_warnings(benchmarks)

benchmarks/bench_arithmetic.cpp

@@ -0,0 +1,22 @@
+#include <benchmark/benchmark.h>
+
+#include "math/arithmetic.hpp"
+
+static void BM_Add(benchmark::State& state)
+{
+  for (auto _ : state)  // NOLINT
+  {
+    benchmark::DoNotOptimize(math::add(1, 2));  // NOLINT
+  }
+}
+
+static void BM_Subtract(benchmark::State& state)
+{
+  for (auto _ : state)  // NOLINT
+  {
+    benchmark::DoNotOptimize(math::subtract(5, 3));  // NOLINT
+  }
+}
+
+BENCHMARK(BM_Add);
+BENCHMARK(BM_Subtract);

cmake/tools/ClangFormat.cmake

@@ -12,6 +12,8 @@ if(CLANG_FORMAT_EXE)
     "${CMAKE_SOURCE_DIR}/tests/**/*.cpp"
     "${CMAKE_SOURCE_DIR}/tests/*.hpp"
     "${CMAKE_SOURCE_DIR}/tests/**/*.hpp"
+    "${CMAKE_SOURCE_DIR}/benchmarks/*.cpp"
+    "${CMAKE_SOURCE_DIR}/benchmarks/**/*.cpp"
   )
 
   add_custom_target(clang-format

cmake/tools/ClangTidy.cmake

@@ -6,6 +6,8 @@ if(CLANG_TIDY_EXE)
     "${CMAKE_SOURCE_DIR}/src/**/*.cpp"
     "${CMAKE_SOURCE_DIR}/tests/*.cpp"
     "${CMAKE_SOURCE_DIR}/tests/**/*.cpp"
+    "${CMAKE_SOURCE_DIR}/benchmarks/*.cpp"
+    "${CMAKE_SOURCE_DIR}/benchmarks/**/*.cpp"
   )
 
   add_custom_target(clang-tidy