NONE: Prepare the library benchmarking subproject layout

SpectraL519 · SpectraL519 · commit 2ad5a98b16a0 · 2026-04-02T11:37:31.000+02:00
- Added the `benchmarks` directory containing the initial library benchmarks implementation
- Defined the benchmark suite and runner classes responsible for proper setup and execution of CPP-GL benchmarks
- Implemented a simple benchmark: bipartiteness verification of a K_n,n biclique
- Added the `benchmarks` smoke test workflow
diff --git a/.clangd b/.clangd
@@ -1,12 +1,18 @@
 CompileFlags:
+  CompilationDatabase: build
   Add:
     - -std=c++23
     - -xc++-header
     - -Iinclude
-    - -Itests/include
-    - -Itests/external
     - -Wall
     - -Wextra
+    - -Wcast-align
+    - -Wconversion
+    - -Wsign-conversion
+    - -Wunreachable-code
+    - -Wuninitialized
+    - -Wunused
+    - -pedantic
     - -ftemplate-depth=512
 
 Diagnostics:
@@ -21,3 +27,21 @@ Diagnostics:
 
 Index:
   Background: Build
+
+---
+
+If:
+  PathMatch: tests/.*
+CompileFlags:
+  Add:
+    - -Itests/include
+    - -Itests/external
+
+---
+
+If:
+  PathMatch: benchmarks/.*
+CompileFlags:
+  CompilationDatabase: build_bench
+  Add:
+    - -Ibenchmarks/include
diff --git a/.github/workflows/benchmarks.yaml b/.github/workflows/benchmarks.yaml
@@ -0,0 +1,45 @@
+name: Benchmarks Smoke Test
+on:
+  push:
+    branches:
+      - "*"
+    paths:
+      - .github/workflows/benchmarks.yaml
+      - CMakeLists.txt
+      - cmake/
+      - include/**
+      - benchmarks/**
+
+jobs:
+  build:
+    name: Build and run benchmarks
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Dependencies (Boost)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libboost-graph-dev
+
+      - name: Prepare
+        env:
+          CC: gcc-14
+          CXX: g++-14
+        run: |
+          cmake -B build_bench \
+            -DBUILD_BENCHMARKS=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=$CXX -DCMAKE_C_COMPILER=$CC
+        continue-on-error: false
+
+      - name: Build the benchmarks
+        run: |
+          cmake --build build_bench/ -j$(nproc)
+        continue-on-error: false
+
+      - name: Execute the smoke test
+        run: |
+          ./build_bench/benchmarks/gl_benchmarks \
+            --benchmark_repetitions=1 --benchmark_display_aggregates_only=true \
+            --bip-v 100
diff --git a/.github/workflows/clang.yaml b/.github/workflows/clang.yaml
@@ -1,10 +1,12 @@
-name: clang++
+name: Clang++
 on:
   push:
     branches:
       - "*"
     paths:
       - .github/workflows/clang.yaml
+      - CMakeLists.txt
+      - cmake/
       - include/**
       - tests/**
 
@@ -27,7 +29,7 @@ jobs:
 
       - name: Build test executable
         run: |
-          cmake --build build_clang/ -j5
+          cmake --build build_clang/ -j$(nproc)
         continue-on-error: false
 
       - name: Run tests
diff --git a/.github/workflows/format.yaml b/.github/workflows/format.yaml
@@ -1,15 +1,17 @@
-name: format
+name: Code Formatting
 on:
   push:
     branches:
       - "*"
     paths:
       - .github/workflows/format.yaml
+      - scripts/common.py
       - scripts/format.py
       - include/**
       - tests/include/**
       - tests/source/**
       - tests/app/**
+      - benchmarks/**
 
 jobs:
   build:
diff --git a/.github/workflows/gpp.yaml b/.github/workflows/gpp.yaml
@@ -1,10 +1,12 @@
-name: g++
+name: G++
 on:
   push:
     branches:
       - "*"
     paths:
       - .github/workflows/gpp.yaml
+      - CMakeLists.txt
+      - cmake/
       - include/**
       - tests/**
 
@@ -27,7 +29,7 @@ jobs:
 
       - name: Build test executable
         run: |
-          cmake --build build_gcc/ -j5
+          cmake --build build_gcc/ -j$(nproc)
         continue-on-error: false
 
       - name: Run tests
diff --git a/.github/workflows/licence.yaml b/.github/workflows/licence.yaml
@@ -1,10 +1,11 @@
-name: licence
+name: Licence
 on:
   push:
     branches:
       - "*"
     paths:
       - .github/workflows/licence.yaml
+      - scripts/common.py
       - scripts/check_licence.py
       - include/**
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,6 +17,7 @@ project(cpp-gl
 set(MIN_CXX_STANDARD 23)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 option(BUILD_TESTS "Build project tests" OFF)
+option(BUILD_BENCHMARKS "Build project benchmarks" OFF)
 
 # Set the proper cxx standard
 if(NOT DEFINED CMAKE_CXX_STANDARD)
@@ -88,3 +89,8 @@ export(PACKAGE cpp-gl)
 if (CPP_GL_IS_TOP_LEVEL_PROJECT AND BUILD_TESTS)
     add_subdirectory(tests)
 endif()
+
+# Include test directory if cpp-gl is a top level project
+if (CPP_GL_IS_TOP_LEVEL_PROJECT AND BUILD_BENCHMARKS)
+    add_subdirectory(benchmarks)
+endif()
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@
 [![g++](https://github.com/SpectraL519/cpp-gl/actions/workflows/gpp.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/g++)
 [![clang++](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang++)
 [![format](https://github.com/SpectraL519/cpp-gl/actions/workflows/format.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/format)
+[![benchmarks](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml)
 
 </div>
 
diff --git a/benchmarks/CMakeLists.txt b/benchmarks/CMakeLists.txt
@@ -0,0 +1,65 @@
+cmake_minimum_required(VERSION 3.14)
+project(gl_benchmarks LANGUAGES CXX)
+
+include(FetchContent)
+
+# Build options
+set(BENCH_GL_DEFS "" CACHE STRING "Additional compile definitions for the CPP-GL target")
+set(BENCH_OPT_MODE "3" CACHE STRING "The optimisation mode used to build the project benchmarks (default: 3)")
+
+message(STATUS "Build options:")
+message(STATUS "[BENCH_GL_DEFS = ${BENCH_GL_DEFS}]")
+message(STATUS "[BENCH_OPT_MODE = ${BENCH_OPT_MODE}]")
+
+# Fetch Google Benchmark
+FetchContent_Declare(
+    googlebenchmark
+    GIT_REPOSITORY https://github.com/google/benchmark.git
+    GIT_TAG v1.8.3
+)
+set(BENCHMARK_ENABLE_TESTING OFF CACHE BOOL "Disable benchmark tests" FORCE)
+FetchContent_MakeAvailable(googlebenchmark)
+
+# Fetch CPP-ARGON
+FetchContent_Declare(
+    cpp-argon
+    GIT_REPOSITORY https://github.com/SpectraL519/cpp-argon.git
+    GIT_TAG v4.0.0
+)
+FetchContent_MakeAvailable(cpp-argon)
+
+# Find Boost for BGL comparisons
+find_package(Boost CONFIG REQUIRED)
+
+add_executable(gl_benchmarks
+    source/main.cpp
+    source/runner.cpp
+    suites/is_bipartite.cpp
+)
+
+target_compile_options(gl_benchmarks PRIVATE
+    -Werror
+    -Wall
+    -Wextra
+    -Wcast-align
+    -Wconversion
+    -Wsign-conversion
+    -Wunreachable-code
+    -Wuninitialized
+    -Wunused
+    -pedantic
+    -O${BENCH_OPT_MODE}
+)
+
+target_include_directories(gl_benchmarks PRIVATE include)
+target_link_libraries(gl_benchmarks PRIVATE
+    benchmark::benchmark
+    cpp-argon
+    cpp-gl
+    Boost::headers
+)
+
+if(BENCH_GL_DEFS)
+    separate_arguments(BENCH_GL_DEFS_LIST NATIVE_COMMAND "${BENCH_GL_DEFS}")
+    target_compile_definitions(gl_benchmarks PRIVATE ${BENCH_GL_DEFS_LIST})
+endif()
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -0,0 +1,18 @@
+# CPP-GL Benchmarks
+
+Building the benchmarks:
+
+```shell
+cmake -B build_bench -DBUILD_BENCHMARKS=ON -DCMAKE_BUILD_TYPE=Release
+cmake --build build_bench/ # -j<n>
+```
+
+> [!NOTE]
+> The benchmarks require having the Boost Graph Library installed.
+> To install the library you can use
+
+Running the benchmarks (example):
+
+```shell
+./build_bench/benchmarks/gl_benchmarks --bip-v 9000 --benchmark_repetitions=10 --benchmark_display_aggregates_only=true
+```
diff --git a/benchmarks/include/runner.hpp b/benchmarks/include/runner.hpp
@@ -0,0 +1,24 @@
+#pragma once
+
+#include "suite.hpp"
+
+#include <argon/argument_parser.hpp>
+#include <benchmark/benchmark.h>
+
+#include <vector>
+
+namespace gl_bench {
+
+class runner {
+public:
+    runner();
+
+    void add_suite(suite suite);
+    int run(int argc, char** argv);
+
+private:
+    argon::argument_parser _parser;
+    std::vector<suite> _suites;
+};
+
+} // namespace gl_bench
diff --git a/benchmarks/include/suite.hpp b/benchmarks/include/suite.hpp
@@ -0,0 +1,12 @@
+#pragma once
+
+#include <argon/argument_parser.hpp>
+
+namespace gl_bench {
+
+struct suite {
+    void (*add_args)(argon::argument_parser& parser);
+    void (*register_benchmarks)(const argon::argument_parser& parser);
+};
+
+} // namespace gl_bench
diff --git a/benchmarks/source/main.cpp b/benchmarks/source/main.cpp
@@ -0,0 +1,11 @@
+#include "runner.hpp"
+
+namespace gl_bench::is_bipartite {
+extern suite get_suite();
+} // namespace gl_bench::is_bipartite
+
+int main(int argc, char** argv) {
+    gl_bench::runner runner;
+    runner.add_suite(gl_bench::is_bipartite::get_suite());
+    return runner.run(argc, argv);
+}
diff --git a/benchmarks/source/runner.cpp b/benchmarks/source/runner.cpp
diff --git a/benchmarks/suites/is_bipartite.cpp b/benchmarks/suites/is_bipartite.cpp
diff --git a/include/gl/algorithm/spanning_tree/prim_mst.hpp b/include/gl/algorithm/spanning_tree/prim_mst.hpp
diff --git a/include/gl/topology/bipartite.hpp b/include/gl/topology/bipartite.hpp
diff --git a/scripts/format.py b/scripts/format.py
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
