Adding micro-benchmarks to XDG

.github/workflows/ci.yml

@@ -71,7 +71,7 @@ jobs:
         shell: bash
         run: |
           cd build
-          ctest -j4 --output-on-failure
+          ctest -j1 --output-on-failure --verbose
 
       - name: Check installed executables
         shell: bash

tests/test_point_in_volume.cpp

@@ -4,6 +4,8 @@
 // xdg includes
 #include "xdg/mesh_manager_interface.h"
 #include "xdg/ray_tracing_interface.h"
+#include <catch2/benchmark/catch_benchmark.hpp>
+
 
 #include "mesh_mock.h"
 
@@ -22,10 +24,18 @@ TEST_CASE("Test Point in Volume")
   bool result = rti->point_in_volume(volume_tree, point);
   REQUIRE(result == true);
 
+  BENCHMARK("point_in_vol [Inside]"){
+    return rti->point_in_volume(volume_tree, point);
+  };
+
   point = {0.0, 0.0, 1000.0};
   result = rti->point_in_volume(volume_tree, point);
   REQUIRE(result == false);
 
+  BENCHMARK("point_in_vol [Outside]"){
+    return rti->point_in_volume(volume_tree, point);
+  };
+
   // test a point just inside the positive x boundary
   point = {4.0 - 1e-06, 0.0, 0.0};
   result = rti->point_in_volume(volume_tree, point);

tests/test_ray_fire.cpp

@@ -2,6 +2,7 @@
 // for testing
 #include <catch2/catch_test_macros.hpp>
 #include <catch2/matchers/catch_matchers_floating_point.hpp>
+#include <catch2/benchmark/catch_benchmark.hpp>
 
 // xdg includes
 #include "xdg/constants.h"
@@ -29,6 +30,18 @@ TEST_CASE("Test Ray Fire Mesh Mock")
   intersection = rti->ray_fire(volume_tree, origin, direction);
   REQUIRE_THAT(intersection.first, Catch::Matchers::WithinAbs(5.0, 1e-6));
 
+  // benchmark firing from inside the cube to a face
+  BENCHMARK("ray_fire_from_inside"){
+    return rti->ray_fire(volume_tree, origin, direction);
+  };
+
+  // advanced benchmark
+  BENCHMARK_ADVANCED("Advanced ray_fire benchmark")(Catch::Benchmark::Chronometer meter){
+    meter.measure([]{
+      return rti->ray_fire(volume_tree, origin, direction);
+    });
+  };
+
   direction *= -1;
   intersection = rti->ray_fire(volume_tree, origin, direction);
   REQUIRE_THAT(intersection.first, Catch::Matchers::WithinAbs(2.0, 1e-6));
@@ -56,6 +69,10 @@ TEST_CASE("Test Ray Fire Mesh Mock")
   intersection = rti->ray_fire(volume_tree, origin, direction);
   REQUIRE_THAT(intersection.first, Catch::Matchers::WithinAbs(15.0, 1e-6));
 
+  BENCHMARK("ray_fire_from_outside_vol [Exiting]"){
+    return rti->ray_fire(volume_tree, origin, direction);
+  };
+
   origin = {10.0, 0.0, 0.0};
   direction = {-1.0, 0.0, 0.0};
   intersection = rti->ray_fire(volume_tree, origin, direction);
@@ -68,6 +85,10 @@ TEST_CASE("Test Ray Fire Mesh Mock")
   intersection = rti->ray_fire(volume_tree, origin, direction, INFTY, HitOrientation::ENTERING);
   REQUIRE_THAT(intersection.first, Catch::Matchers::WithinAbs(8.0, 1e-6));
 
+  BENCHMARK("ray_fire_from_outside_vol [Entering]"){
+    return rti->ray_fire(volume_tree, origin, direction);
+  };
+
   origin = {10.0, 0.0, 0.0};
   direction = {-1.0, 0.0, 0.0};
   intersection = rti->ray_fire(volume_tree, origin, direction, INFTY, HitOrientation::ENTERING);
@@ -98,3 +119,18 @@ TEST_CASE("Test Ray Fire Mesh Mock")
   intersection = rti->ray_fire(volume_tree, origin, direction, INFTY, HitOrientation::EXITING, &exclude_primitives);
   REQUIRE(intersection.second == ID_NONE);
 }
+
+
+// TEST_CASE("Micro-Benchmark ray_fire()")
+// {
+//   std::shared_ptr<MeshManager> mm = std::make_shared<MeshMock>();
+//   mm->init(); // this should do nothing, just good practice to call it
+//   REQUIRE(mm->mesh_library() == MeshLibrary::INTERNAL);
+
+//   std::shared_ptr<RayTracer> rti = std::make_shared<RayTracer>();
+//   TreeID volume_tree = rti->register_volume(mm, mm->volumes()[0]);
+
+//   Position origin {0.0, 0.0, 0.0};
+//   Direction direction {1.0, 0.0, 0.0};
+//   std::pair<double, MeshID> intersection;
+// }