refactor!: Move Grid out of detail (#2616)

This is part of the public API (and documented to some degree) so shouldn't be in `detail`.
acts-project · Nov 3, 2023 · 76cf010 · 76cf010
1 parent 6e56a98
commit 76cf010
Show file tree

Hide file tree

Showing 39 changed files with 131 additions and 147 deletions.
diff --git a/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp b/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp
@@ -8,8 +8,8 @@
 
 #pragma once
 
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <array>
 #include <tuple>
@@ -39,7 +39,7 @@ struct Eq {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
+  using grid_type = Acts::Grid<
       T, Acts::detail::Axis<Acts::detail::AxisType::Equidistant, aType>>;
 
   std::array<ActsScalar, 2u> range = {};
@@ -69,8 +69,9 @@ struct Var {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
-      T, Acts::detail::Axis<Acts::detail::AxisType::Variable, aType>>;
+  using grid_type =
+      Acts::Grid<T,
+                 Acts::detail::Axis<Acts::detail::AxisType::Variable, aType>>;
 
   std::vector<ActsScalar> edges = {};
 
@@ -101,7 +102,7 @@ struct EqEq {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
+  using grid_type = Acts::Grid<
       T, Acts::detail::Axis<Acts::detail::AxisType::Equidistant, aType>,
       Acts::detail::Axis<Acts::detail::AxisType::Equidistant, bType>>;
 
@@ -156,9 +157,10 @@ struct EqVar {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
-      T, Acts::detail::Axis<Acts::detail::AxisType::Equidistant, aType>,
-      Acts::detail::Axis<Acts::detail::AxisType::Variable, bType>>;
+  using grid_type =
+      Acts::Grid<T,
+                 Acts::detail::Axis<Acts::detail::AxisType::Equidistant, aType>,
+                 Acts::detail::Axis<Acts::detail::AxisType::Variable, bType>>;
 
   std::array<ActsScalar, 2u> range = {};
   std::size_t nBins = 0u;
@@ -208,7 +210,7 @@ struct VarEq {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
+  using grid_type = Acts::Grid<
       T, Acts::detail::Axis<Acts::detail::AxisType::Variable, aType>,
       Acts::detail::Axis<Acts::detail::AxisType::Equidistant, bType>>;
 
@@ -260,9 +262,9 @@ struct VarVar {
 
   /// Broadcast the grid type
   template <typename T>
-  using grid_type = Acts::detail::Grid<
-      T, Acts::detail::Axis<Acts::detail::AxisType::Variable, aType>,
-      Acts::detail::Axis<Acts::detail::AxisType::Variable, bType>>;
+  using grid_type =
+      Acts::Grid<T, Acts::detail::Axis<Acts::detail::AxisType::Variable, aType>,
+                 Acts::detail::Axis<Acts::detail::AxisType::Variable, bType>>;
 
   std::vector<ActsScalar> edges0 = {};
   std::vector<ActsScalar> edges1 = {};

diff --git a/Core/include/Acts/MagneticField/BFieldMapUtils.hpp b/Core/include/Acts/MagneticField/BFieldMapUtils.hpp
@@ -10,8 +10,8 @@
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Definitions/Units.hpp"
 #include "Acts/MagneticField/InterpolatedBFieldMap.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/AxisFwd.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <array>
 #include <cstddef>
@@ -69,8 +69,8 @@ class SolenoidBField;
 ///       {-1,0,1} and the BFieldValues will be set to {3,2,3}.
 /// @return A field map instance for use in interpolation.
 Acts::InterpolatedBFieldMap<
-    Acts::detail::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
-                       Acts::detail::EquidistantAxis>>
+    Acts::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
+               Acts::detail::EquidistantAxis>>
 fieldMapRZ(const std::function<size_t(std::array<size_t, 2> binsRZ,
                                       std::array<size_t, 2> nBinsRZ)>&
                localToGlobalBin,
@@ -127,9 +127,9 @@ fieldMapRZ(const std::function<size_t(std::array<size_t, 2> binsRZ,
 ///       z-axis grid values will be set to {-1,0,1} and the BFieldValues will
 ///       be set to {3,2,3}.
 /// @return A field map instance for use in interpolation.
-Acts::InterpolatedBFieldMap<Acts::detail::Grid<
-    Acts::Vector3, Acts::detail::EquidistantAxis, Acts::detail::EquidistantAxis,
-    Acts::detail::EquidistantAxis>>
+Acts::InterpolatedBFieldMap<
+    Acts::Grid<Acts::Vector3, Acts::detail::EquidistantAxis,
+               Acts::detail::EquidistantAxis, Acts::detail::EquidistantAxis>>
 fieldMapXYZ(const std::function<size_t(std::array<size_t, 3> binsXYZ,
                                        std::array<size_t, 3> nBinsXYZ)>&
                 localToGlobalBin,
@@ -149,8 +149,8 @@ fieldMapXYZ(const std::function<size_t(std::array<size_t, 3> binsXYZ,
 ///
 /// @return A field map instance for use in interpolation.
 Acts::InterpolatedBFieldMap<
-    Acts::detail::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
-                       Acts::detail::EquidistantAxis>>
+    Acts::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
+               Acts::detail::EquidistantAxis>>
 solenoidFieldMap(std::pair<double, double> rlim, std::pair<double, double> zlim,
                  std::pair<size_t, size_t> nbins, const SolenoidBField& field);
 

diff --git a/Core/include/Acts/MagneticField/InterpolatedBFieldMap.hpp b/Core/include/Acts/MagneticField/InterpolatedBFieldMap.hpp
@@ -12,9 +12,9 @@
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/MagneticField/MagneticFieldError.hpp"
 #include "Acts/MagneticField/MagneticFieldProvider.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/Interpolation.hpp"
 #include "Acts/Utilities/Result.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <functional>
 #include <optional>

diff --git a/Core/include/Acts/Material/MaterialGridHelper.hpp b/Core/include/Acts/Material/MaterialGridHelper.hpp
@@ -13,9 +13,9 @@
 #include "Acts/Material/Material.hpp"
 #include "Acts/Utilities/BinUtility.hpp"
 #include "Acts/Utilities/BinningType.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
 #include "Acts/Utilities/detail/AxisFwd.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <array>
 #include <cstddef>
@@ -29,14 +29,12 @@ namespace Acts {
 class MaterialSlab;
 
 using EAxis = Acts::detail::EquidistantAxis;
-using Grid2D =
-    Acts::detail::Grid<Acts::AccumulatedVolumeMaterial, EAxis, EAxis>;
-using Grid3D =
-    Acts::detail::Grid<Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis>;
+using Grid2D = Acts::Grid<Acts::AccumulatedVolumeMaterial, EAxis, EAxis>;
+using Grid3D = Acts::Grid<Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis>;
 using MaterialGrid2D =
-    Acts::detail::Grid<Acts::Material::ParametersVector, EAxis, EAxis>;
+    Acts::Grid<Acts::Material::ParametersVector, EAxis, EAxis>;
 using MaterialGrid3D =
-    Acts::detail::Grid<Acts::Material::ParametersVector, EAxis, EAxis, EAxis>;
+    Acts::Grid<Acts::Material::ParametersVector, EAxis, EAxis, EAxis>;
 
 using MaterialGridAxisData = std::tuple<double, double, size_t>;
 

diff --git a/Core/include/Acts/Material/MaterialMapUtils.hpp b/Core/include/Acts/Material/MaterialMapUtils.hpp
@@ -12,8 +12,8 @@
 #include "Acts/Definitions/Units.hpp"
 #include "Acts/Material/InterpolatedMaterialMap.hpp"
 #include "Acts/Material/Material.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/AxisFwd.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <array>
 #include <cstddef>
@@ -59,8 +59,8 @@ class Material;
 /// @note The function localToGlobalBin determines how the material was
 /// stored in the vector in respect to the grid values
 /// @param [in] lengthUnit The unit of the grid points
-MaterialMapper<detail::Grid<Material::ParametersVector, detail::EquidistantAxis,
-                            detail::EquidistantAxis>>
+MaterialMapper<Grid<Material::ParametersVector, detail::EquidistantAxis,
+                    detail::EquidistantAxis>>
 materialMapperRZ(const std::function<size_t(std::array<size_t, 2> binsRZ,
                                             std::array<size_t, 2> nBinsRZ)>&
                      materialVectorToGridMapper,
@@ -109,8 +109,8 @@ materialMapperRZ(const std::function<size_t(std::array<size_t, 2> binsRZ,
 /// @note The function localToGlobalBin determines how the material was
 /// stored in the vector in respect to the grid values
 /// @param [in] lengthUnit The unit of the grid points
-MaterialMapper<detail::Grid<Material::ParametersVector, detail::EquidistantAxis,
-                            detail::EquidistantAxis, detail::EquidistantAxis>>
+MaterialMapper<Grid<Material::ParametersVector, detail::EquidistantAxis,
+                    detail::EquidistantAxis, detail::EquidistantAxis>>
 materialMapperXYZ(const std::function<size_t(std::array<size_t, 3> binsXYZ,
                                              std::array<size_t, 3> nBinsXYZ)>&
                       materialVectorToGridMapper,

diff --git a/Core/include/Acts/Navigation/DetectorVolumeFinders.hpp b/Core/include/Acts/Navigation/DetectorVolumeFinders.hpp
@@ -15,8 +15,8 @@
 #include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Navigation/NavigationStateFillers.hpp"
 #include "Acts/Navigation/NavigationStateUpdators.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <stdexcept>
 

diff --git a/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp b/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp
@@ -13,8 +13,8 @@
 #include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Navigation/NavigationStateFillers.hpp"
 #include "Acts/Navigation/NavigationStateUpdators.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <stdexcept>
 
@@ -69,8 +69,7 @@ using SingleIndex = std::size_t;
 using VariableBoundAxis =
     Acts::detail::Axis<Acts::detail::AxisType::Variable,
                        Acts::detail::AxisBoundaryType::Bound>;
-using VariableBoundIndexGrid1 =
-    Acts::detail::Grid<SingleIndex, VariableBoundAxis>;
+using VariableBoundIndexGrid1 = Acts::Grid<SingleIndex, VariableBoundAxis>;
 
 /// @brief This holds and extracts a collection of detector
 /// volumes. Alternatively an extractor could also use the

diff --git a/Core/include/Acts/Seeding/SpacePointGrid.hpp b/Core/include/Acts/Seeding/SpacePointGrid.hpp
@@ -10,8 +10,8 @@
 
 #include "Acts/Definitions/Units.hpp"
 #include "Acts/Seeding/InternalSpacePoint.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <memory>
 
@@ -88,7 +88,7 @@ struct SpacePointGridOptions {
 };
 
 template <typename external_spacepoint_t>
-using SpacePointGrid = detail::Grid<
+using SpacePointGrid = Grid<
     std::vector<std::unique_ptr<InternalSpacePoint<external_spacepoint_t>>>,
     detail::Axis<detail::AxisType::Equidistant,
                  detail::AxisBoundaryType::Closed>,

diff --git a/Core/include/Acts/Surfaces/SurfaceArray.hpp b/Core/include/Acts/Surfaces/SurfaceArray.hpp
@@ -11,9 +11,9 @@
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Surfaces/Surface.hpp"
 #include "Acts/Utilities/BinningType.hpp"
+#include "Acts/Utilities/Grid.hpp"
 #include "Acts/Utilities/IAxis.hpp"
 #include "Acts/Utilities/detail/Axis.hpp"
-#include "Acts/Utilities/detail/Grid.hpp"
 
 #include <iostream>
 #include <type_traits>
@@ -125,7 +125,7 @@ class SurfaceArray {
     /// std::array<double, 1>
     using point_t =
         std::conditional_t<DIM == 1, std::array<double, 1>, ActsVector<DIM>>;
-    using Grid_t = detail::Grid<SurfaceVector, Axes...>;
+    using Grid_t = Grid<SurfaceVector, Axes...>;
 
     /// @brief Default constructor
     ///