From f0294bd49b3731a5c9771ba9941c8a9113da3c85 Mon Sep 17 00:00:00 2001
From: Carlo Varni <75478407+CarloVarni@users.noreply.github.com>
Date: Fri, 1 Mar 2024 20:29:41 +0100
Subject: [PATCH] refactor!: template the seed finder on the grid type (#2957)

Make the seed finder templated on the grid type so that we can use any kind of grid on it
---
 Core/include/Acts/Seeding/SeedFinder.hpp      | 13 ++++-----
 Core/include/Acts/Seeding/SeedFinder.ipp      | 28 +++++++++----------
 .../TrackFinding/SeedingAlgorithm.hpp         |  4 ++-
 .../TrackFinding/src/SeedingAlgorithm.cpp     |  5 +++-
 .../UnitTests/Core/Seeding/SeedFinderTest.cpp |  6 ++--
 .../Cuda/Seeding/SeedFinderCudaTest.cpp       |  3 +-
 .../UnitTests/Plugins/Cuda/Seeding2/main.cpp  |  4 ++-
 .../Sycl/Seeding/SeedFinderSyclTest.cpp       |  3 +-
 8 files changed, 38 insertions(+), 28 deletions(-)

diff --git a/Core/include/Acts/Seeding/SeedFinder.hpp b/Core/include/Acts/Seeding/SeedFinder.hpp
index 95220477490..e25d1263111 100644
--- a/Core/include/Acts/Seeding/SeedFinder.hpp
+++ b/Core/include/Acts/Seeding/SeedFinder.hpp
@@ -18,8 +18,6 @@
 #include "Acts/Seeding/SeedFilter.hpp"
 #include "Acts/Seeding/SeedFinderConfig.hpp"
 #include "Acts/Seeding/SeedFinderUtils.hpp"
-#include "Acts/Seeding/SpacePointGrid.hpp"
-#include "Acts/Utilities/detail/grid_helper.hpp"
 
 #include <array>
 #include <limits>
@@ -37,12 +35,12 @@ enum class SpacePointCandidateType : short { eBottom, eTop };
 
 enum class DetectorMeasurementInfo : short { eDefault, eDetailed };
 
-template <typename external_spacepoint_t, typename platform_t = void*>
+template <typename external_spacepoint_t, typename grid_t,
+          typename platform_t = void*>
 class SeedFinder {
   ///////////////////////////////////////////////////////////////////
   // Public methods:
   ///////////////////////////////////////////////////////////////////
-  using grid_t = Acts::CylindricalSpacePointGrid<external_spacepoint_t>;
 
  public:
   struct SeedingState {
@@ -83,9 +81,10 @@ class SeedFinder {
   /**    @name Disallow default instantiation, copy, assignment */
   //@{
   SeedFinder() = default;
-  SeedFinder(const SeedFinder<external_spacepoint_t, platform_t>&) = delete;
-  SeedFinder<external_spacepoint_t, platform_t>& operator=(
-      const SeedFinder<external_spacepoint_t, platform_t>&) = default;
+  SeedFinder(const SeedFinder<external_spacepoint_t, grid_t, platform_t>&) =
+      delete;
+  SeedFinder<external_spacepoint_t, grid_t, platform_t>& operator=(
+      const SeedFinder<external_spacepoint_t, grid_t, platform_t>&) = default;
   //@}
 
   /// Create all seeds from the space points in the three iterators.
diff --git a/Core/include/Acts/Seeding/SeedFinder.ipp b/Core/include/Acts/Seeding/SeedFinder.ipp
index b29c4336598..3fcd0542583 100644
--- a/Core/include/Acts/Seeding/SeedFinder.ipp
+++ b/Core/include/Acts/Seeding/SeedFinder.ipp
@@ -13,8 +13,8 @@
 
 namespace Acts {
 
-template <typename external_spacepoint_t, typename platform_t>
-SeedFinder<external_spacepoint_t, platform_t>::SeedFinder(
+template <typename external_spacepoint_t, typename grid_t, typename platform_t>
+SeedFinder<external_spacepoint_t, grid_t, platform_t>::SeedFinder(
     const Acts::SeedFinderConfig<external_spacepoint_t>& config)
     : m_config(config) {
   if (!config.isInInternalUnits) {
@@ -35,9 +35,9 @@ SeedFinder<external_spacepoint_t, platform_t>::SeedFinder(
   }
 }
 
-template <typename external_spacepoint_t, typename platform_t>
+template <typename external_spacepoint_t, typename grid_t, typename platform_t>
 template <template <typename...> typename container_t, typename sp_range_t>
-void SeedFinder<external_spacepoint_t, platform_t>::createSeedsForGroup(
+void SeedFinder<external_spacepoint_t, grid_t, platform_t>::createSeedsForGroup(
     const Acts::SeedFinderOptions& options, SeedingState& state,
     const grid_t& grid,
     std::back_insert_iterator<container_t<Seed<external_spacepoint_t>>> outIt,
@@ -192,16 +192,15 @@ void SeedFinder<external_spacepoint_t, platform_t>::createSeedsForGroup(
   }  // loop on mediums
 }
 
-template <typename external_spacepoint_t, typename platform_t>
+template <typename external_spacepoint_t, typename grid_t, typename platform_t>
 template <Acts::SpacePointCandidateType candidateType, typename out_range_t>
 inline void
-SeedFinder<external_spacepoint_t, platform_t>::getCompatibleDoublets(
+SeedFinder<external_spacepoint_t, grid_t, platform_t>::getCompatibleDoublets(
     Acts::SpacePointData& spacePointData,
     const Acts::SeedFinderOptions& options, const grid_t& grid,
-    boost::container::small_vector<
-        Acts::Neighbour<
-            typename SeedFinder<external_spacepoint_t, platform_t>::grid_t>,
-        Acts::detail::ipow(3, grid_t::DIM)>& otherSPsNeighbours,
+    boost::container::small_vector<Acts::Neighbour<grid_t>,
+                                   Acts::detail::ipow(3, grid_t::DIM)>&
+        otherSPsNeighbours,
     const InternalSpacePoint<external_spacepoint_t>& mediumSP,
     std::vector<LinCircle>& linCircleVec, out_range_t& outVec,
     const float deltaRMinSP, const float deltaRMaxSP, const float uIP,
@@ -456,9 +455,10 @@ SeedFinder<external_spacepoint_t, platform_t>::getCompatibleDoublets(
   }
 }
 
-template <typename external_spacepoint_t, typename platform_t>
+template <typename external_spacepoint_t, typename grid_t, typename platform_t>
 template <Acts::DetectorMeasurementInfo detailedMeasurement>
-inline void SeedFinder<external_spacepoint_t, platform_t>::filterCandidates(
+inline void
+SeedFinder<external_spacepoint_t, grid_t, platform_t>::filterCandidates(
     Acts::SpacePointData& spacePointData,
     const InternalSpacePoint<external_spacepoint_t>& spM,
     const Acts::SeedFinderOptions& options, SeedFilterState& seedFilterState,
@@ -817,10 +817,10 @@ inline void SeedFinder<external_spacepoint_t, platform_t>::filterCandidates(
   }  // loop on bottoms
 }
 
-template <typename external_spacepoint_t, typename platform_t>
+template <typename external_spacepoint_t, typename grid_t, typename platform_t>
 template <typename sp_range_t>
 std::vector<Seed<external_spacepoint_t>>
-SeedFinder<external_spacepoint_t, platform_t>::createSeedsForGroup(
+SeedFinder<external_spacepoint_t, grid_t, platform_t>::createSeedsForGroup(
     const Acts::SeedFinderOptions& options, const grid_t& grid,
     const sp_range_t& bottomSPs, const std::size_t middleSPs,
     const sp_range_t& topSPs) const {
diff --git a/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/SeedingAlgorithm.hpp b/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/SeedingAlgorithm.hpp
index a3e39fe4d24..0133e6d7d82 100644
--- a/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/SeedingAlgorithm.hpp
+++ b/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/SeedingAlgorithm.hpp
@@ -82,7 +82,9 @@ class SeedingAlgorithm final : public IAlgorithm {
   const Config& config() const { return m_cfg; }
 
  private:
-  Acts::SeedFinder<SimSpacePoint> m_seedFinder;
+  Acts::SeedFinder<SimSpacePoint,
+                   Acts::CylindricalSpacePointGrid<SimSpacePoint>>
+      m_seedFinder;
   std::unique_ptr<const Acts::GridBinFinder<2ul>> m_bottomBinFinder;
   std::unique_ptr<const Acts::GridBinFinder<2ul>> m_topBinFinder;
 
diff --git a/Examples/Algorithms/TrackFinding/src/SeedingAlgorithm.cpp b/Examples/Algorithms/TrackFinding/src/SeedingAlgorithm.cpp
index c7d9eb9d8fb..3bc1e6e329a 100644
--- a/Examples/Algorithms/TrackFinding/src/SeedingAlgorithm.cpp
+++ b/Examples/Algorithms/TrackFinding/src/SeedingAlgorithm.cpp
@@ -212,7 +212,10 @@ ActsExamples::SeedingAlgorithm::SeedingAlgorithm(
 
   m_cfg.seedFinderConfig.seedFilter =
       std::make_unique<Acts::SeedFilter<SimSpacePoint>>(m_cfg.seedFilterConfig);
-  m_seedFinder = Acts::SeedFinder<SimSpacePoint>(m_cfg.seedFinderConfig);
+  m_seedFinder =
+      Acts::SeedFinder<SimSpacePoint,
+                       Acts::CylindricalSpacePointGrid<SimSpacePoint>>(
+          m_cfg.seedFinderConfig);
 }
 
 ActsExamples::ProcessCode ActsExamples::SeedingAlgorithm::execute(
diff --git a/Tests/UnitTests/Core/Seeding/SeedFinderTest.cpp b/Tests/UnitTests/Core/Seeding/SeedFinderTest.cpp
index 5e256abf8ed..456033ad723 100644
--- a/Tests/UnitTests/Core/Seeding/SeedFinderTest.cpp
+++ b/Tests/UnitTests/Core/Seeding/SeedFinderTest.cpp
@@ -174,8 +174,10 @@ int main(int argc, char** argv) {
   Acts::ATLASCuts<SpacePoint> atlasCuts = Acts::ATLASCuts<SpacePoint>();
   config.seedFilter = std::make_unique<Acts::SeedFilter<SpacePoint>>(
       Acts::SeedFilter<SpacePoint>(sfconf, &atlasCuts));
-  Acts::SeedFinder<SpacePoint> a;  // test creation of unconfigured finder
-  a = Acts::SeedFinder<SpacePoint>(config);
+  Acts::SeedFinder<SpacePoint, Acts::CylindricalSpacePointGrid<SpacePoint>>
+      a;  // test creation of unconfigured finder
+  a = Acts::SeedFinder<SpacePoint, Acts::CylindricalSpacePointGrid<SpacePoint>>(
+      config);
 
   // covariance tool, sets covariances per spacepoint as required
   auto ct = [=](const SpacePoint& sp, float, float, float) {
diff --git a/Tests/UnitTests/Plugins/Cuda/Seeding/SeedFinderCudaTest.cpp b/Tests/UnitTests/Plugins/Cuda/Seeding/SeedFinderCudaTest.cpp
index 1d1cce0f147..d30ed0d398e 100644
--- a/Tests/UnitTests/Plugins/Cuda/Seeding/SeedFinderCudaTest.cpp
+++ b/Tests/UnitTests/Plugins/Cuda/Seeding/SeedFinderCudaTest.cpp
@@ -222,7 +222,8 @@ int main(int argc, char** argv) {
   Acts::ATLASCuts<SpacePoint> atlasCuts = Acts::ATLASCuts<SpacePoint>();
   config.seedFilter = std::make_unique<Acts::SeedFilter<SpacePoint>>(
       Acts::SeedFilter<SpacePoint>(sfconf, &atlasCuts));
-  Acts::SeedFinder<SpacePoint> seedFinder_cpu(config);
+  Acts::SeedFinder<SpacePoint, Acts::CylindricalSpacePointGrid<SpacePoint>>
+      seedFinder_cpu(config);
   Acts::SeedFinder<SpacePoint, Acts::Cuda> seedFinder_cuda(config, options);
 
   // covariance tool, sets covariances per spacepoint as required
diff --git a/Tests/UnitTests/Plugins/Cuda/Seeding2/main.cpp b/Tests/UnitTests/Plugins/Cuda/Seeding2/main.cpp
index 91c02f31f68..ba927acde5c 100644
--- a/Tests/UnitTests/Plugins/Cuda/Seeding2/main.cpp
+++ b/Tests/UnitTests/Plugins/Cuda/Seeding2/main.cpp
@@ -165,7 +165,9 @@ int main(int argc, char* argv[]) {
   auto deviceCuts = testDeviceCuts();
 
   // Set up the seedFinder objects.
-  Acts::SeedFinder<TestSpacePoint> seedFinder_host(sfConfig);
+  Acts::SeedFinder<TestSpacePoint,
+                   Acts::CylindricalSpacePointGrid<TestSpacePoint>>
+      seedFinder_host(sfConfig);
   Acts::Cuda::SeedFinder<TestSpacePoint> seedFinder_device(
       sfConfig, sfOptions, filterConfig, deviceCuts, cmdl.cudaDevice);
 
diff --git a/Tests/UnitTests/Plugins/Sycl/Seeding/SeedFinderSyclTest.cpp b/Tests/UnitTests/Plugins/Sycl/Seeding/SeedFinderSyclTest.cpp
index d3c3f592e48..36ed7251311 100644
--- a/Tests/UnitTests/Plugins/Sycl/Seeding/SeedFinderSyclTest.cpp
+++ b/Tests/UnitTests/Plugins/Sycl/Seeding/SeedFinderSyclTest.cpp
@@ -184,7 +184,8 @@ auto main(int argc, char** argv) -> int {
   vecmem::sycl::device_memory_resource device_resource(queue.getQueue());
   Acts::Sycl::SeedFinder<SpacePoint> syclSeedFinder(
       config, options, deviceAtlasCuts, queue, resource, &device_resource);
-  Acts::SeedFinder<SpacePoint> normalSeedFinder(config);
+  Acts::SeedFinder<SpacePoint, Acts::CylindricalSpacePointGrid<SpacePoint>>
+      normalSeedFinder(config);
   auto globalTool = [=](const SpacePoint& sp, float /*unused*/,
                         float /*unused*/, float /*unused*/)
       -> std::tuple<Acts::Vector3, Acts::Vector2, std::optional<float>> {