Skip to content

Commit 768427e

Browse files
authored
chore: Use camel case spacePoint (#5106)
Consistently use - `SpacePoint` for classes and file names - `spacePoint` for variables - `space point` in comments and text
1 parent ac032de commit 768427e

File tree

97 files changed

+693
-687
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+693
-687
lines changed

Core/include/Acts/EventData/CompositeSpacePoint.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ concept CompositeSpacePoint = requires(const SpacePointType sp) {
6060
{ sp.measuresLoc1() } -> std::same_as<bool>;
6161
};
6262

63-
/// @brief Define the Space Point pointer concept as an ordinary / smart pointer
63+
/// @brief Define the space point pointer concept as an ordinary / smart pointer
6464
/// over space points
6565
template <typename SpacePoint_t>
6666
concept CompositeSpacePointPtr =

Core/include/Acts/EventData/Seed.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@
1414
namespace Acts {
1515

1616
/// Seed built from N external space points.
17-
template <typename external_spacepoint_t, std::size_t N = 3ul>
17+
template <typename external_space_point_t, std::size_t N = 3ul>
1818
class Seed {
1919
static_assert(N >= 3ul);
2020

2121
public:
2222
/// Type of the external space point
23-
using value_type = external_spacepoint_t;
23+
using value_type = external_space_point_t;
2424
/// Number of space points in the seed
2525
static constexpr std::size_t DIM = N;
2626

2727
/// Constructor from N space points
2828
/// @param points The space points to build the seed from
2929
template <typename... args_t>
3030
requires(sizeof...(args_t) == N) &&
31-
(std::same_as<external_spacepoint_t, args_t> && ...)
31+
(std::same_as<external_space_point_t, args_t> && ...)
3232
explicit Seed(const args_t&... points);
3333

3434
/// Set the z-coordinate of the vertex
@@ -40,7 +40,7 @@ class Seed {
4040

4141
/// Get the space points in the seed
4242
/// @return Array of pointers to the space points
43-
const std::array<const external_spacepoint_t*, N>& sp() const;
43+
const std::array<const external_space_point_t*, N>& sp() const;
4444
/// Get the z-coordinate of the vertex
4545
/// @return The vertex z-coordinate
4646
float z() const;
@@ -49,7 +49,7 @@ class Seed {
4949
float seedQuality() const;
5050

5151
private:
52-
std::array<const external_spacepoint_t*, N> m_spacepoints{};
52+
std::array<const external_space_point_t*, N> m_spacepoints{};
5353
float m_vertexZ{0.f};
5454
float m_seedQuality{-std::numeric_limits<float>::infinity()};
5555
};

Core/include/Acts/EventData/Seed.ipp

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,36 @@
1212

1313
namespace Acts {
1414

15-
template <typename external_spacepoint_t, std::size_t N>
15+
template <typename external_space_point_t, std::size_t N>
1616
template <typename... args_t>
1717
requires(sizeof...(args_t) == N) &&
18-
(std::same_as<external_spacepoint_t, args_t> && ...)
19-
Seed<external_spacepoint_t, N>::Seed(const args_t&... points)
18+
(std::same_as<external_space_point_t, args_t> && ...)
19+
Seed<external_space_point_t, N>::Seed(const args_t&... points)
2020
: m_spacepoints({&points...}) {}
2121

22-
template <typename external_spacepoint_t, std::size_t N>
23-
void Seed<external_spacepoint_t, N>::setVertexZ(float vertex) {
22+
template <typename external_space_point_t, std::size_t N>
23+
void Seed<external_space_point_t, N>::setVertexZ(float vertex) {
2424
m_vertexZ = vertex;
2525
}
2626

27-
template <typename external_spacepoint_t, std::size_t N>
28-
void Seed<external_spacepoint_t, N>::setQuality(float seedQuality) {
27+
template <typename external_space_point_t, std::size_t N>
28+
void Seed<external_space_point_t, N>::setQuality(float seedQuality) {
2929
m_seedQuality = seedQuality;
3030
}
3131

32-
template <typename external_spacepoint_t, std::size_t N>
33-
const std::array<const external_spacepoint_t*, N>&
34-
Seed<external_spacepoint_t, N>::sp() const {
32+
template <typename external_space_point_t, std::size_t N>
33+
const std::array<const external_space_point_t*, N>&
34+
Seed<external_space_point_t, N>::sp() const {
3535
return m_spacepoints;
3636
}
3737

38-
template <typename external_spacepoint_t, std::size_t N>
39-
float Seed<external_spacepoint_t, N>::z() const {
38+
template <typename external_space_point_t, std::size_t N>
39+
float Seed<external_space_point_t, N>::z() const {
4040
return m_vertexZ;
4141
}
4242

43-
template <typename external_spacepoint_t, std::size_t N>
44-
float Seed<external_spacepoint_t, N>::seedQuality() const {
43+
template <typename external_space_point_t, std::size_t N>
44+
float Seed<external_space_point_t, N>::seedQuality() const {
4545
return m_seedQuality;
4646
}
4747

Core/include/Acts/EventData/SpacePointContainer.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class SpacePointContainer {
4747
Acts::SpacePointContainer<container_t, holder_t>>;
4848

4949
public:
50-
/// Space point proxy type
50+
/// space point proxy type
5151
using SpacePointProxyType =
5252
Acts::SpacePointProxy<Acts::SpacePointContainer<container_t, holder_t>>;
5353

@@ -106,10 +106,10 @@ class SpacePointContainer {
106106

107107
// move operations
108108
/// Move constructor
109-
/// @param other Space point container to move from
109+
/// @param other space point container to move from
110110
SpacePointContainer(SpacePointContainer&& other) noexcept = default;
111111
/// Move assignment operator
112-
/// @param other Space point container to move from
112+
/// @param other space point container to move from
113113
/// @return Reference to this container
114114
SpacePointContainer& operator=(SpacePointContainer&& other) noexcept =
115115
default;

Core/include/Acts/EventData/SpacePointContainer2.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -725,8 +725,8 @@ class SpacePointContainer2 {
725725
assert(index < m_varianceZColumn->size() && "Index out of bounds");
726726
return m_varianceZColumn->proxy(*this)[index];
727727
}
728-
/// Const access to the variance in R direction of the space
729-
/// point at the given index.
728+
/// Const access to the variance in R direction of the space point at the
729+
/// given index.
730730
/// @param index The index of the space point.
731731
/// @return A const reference to the variance in R direction of the space point.
732732
float varianceR(Index index) const noexcept {

Core/include/Acts/Seeding/CandidatesForMiddleSp.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace Acts {
1414

1515
/// @brief A description of a triplet candidate.
16-
/// @tparam external_space_point_t The external spacepoint type.
16+
/// @tparam external_space_point_t The external space point type.
1717
template <typename external_space_point_t>
1818
struct TripletCandidate {
1919
/// @brief Default Constructor
@@ -46,10 +46,10 @@ struct TripletCandidate {
4646

4747
/// @class CandidatesForMiddleSp
4848
/// The CandidatesForMiddleSp collects the triplet candidates given a
49-
/// fixed middle spacepoint. It internally stores the triplet candidates
49+
/// fixed middle space point. It internally stores the triplet candidates
5050
/// keeping only those with the higher quality.
5151
///
52-
/// @tparam external_space_point_t The external spacepoint type.
52+
/// @tparam external_space_point_t The external space point type.
5353

5454
template <typename external_space_point_t>
5555
concept SatisfyCandidateConcept = requires(external_space_point_t spacePoint) {

Core/include/Acts/Seeding/SeedFilter.hpp

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,22 @@ struct SeedFilterState {
3232

3333
/// Filter seeds at various stages with the currently
3434
/// available information.
35-
template <typename external_spacepoint_t>
35+
template <typename external_space_point_t>
3636
class SeedFilter final {
3737
public:
3838
/// Constructor with configuration and optional experimental cuts
3939
/// @param config Seed filter configuration
4040
/// @param expCuts Optional experimental cuts (defaults to nullptr)
4141
explicit SeedFilter(
4242
const SeedFilterConfig& config,
43-
IExperimentCuts<external_spacepoint_t>* expCuts = nullptr);
43+
IExperimentCuts<external_space_point_t>* expCuts = nullptr);
4444
/// Constructor with configuration, logger, and optional experimental cuts
4545
/// @param config Seed filter configuration
4646
/// @param logger Logger for output messages
4747
/// @param expCuts Optional experimental cuts (defaults to nullptr)
4848
explicit SeedFilter(
4949
const SeedFilterConfig& config, std::unique_ptr<const Logger> logger,
50-
IExperimentCuts<external_spacepoint_t>* expCuts = nullptr);
50+
IExperimentCuts<external_space_point_t>* expCuts = nullptr);
5151

5252
/// Create Seeds for the all seeds with the same bottom and middle
5353
/// space point and discard all others.
@@ -62,13 +62,13 @@ class SeedFilter final {
6262
/// @param candidatesCollector container for the seed candidates
6363
void filterSeeds_2SpFixed(
6464
const SpacePointMutableData& mutableData,
65-
const external_spacepoint_t& bottomSp,
66-
const external_spacepoint_t& middleSp,
67-
const std::vector<const external_spacepoint_t*>& topSpVec,
65+
const external_space_point_t& bottomSp,
66+
const external_space_point_t& middleSp,
67+
const std::vector<const external_space_point_t*>& topSpVec,
6868
const std::vector<float>& invHelixDiameterVec,
6969
const std::vector<float>& impactParametersVec,
7070
SeedFilterState& seedFilterState,
71-
CandidatesForMiddleSp<const external_spacepoint_t>& candidatesCollector)
71+
CandidatesForMiddleSp<const external_space_point_t>& candidatesCollector)
7272
const;
7373

7474
/// Filter seeds once all seeds for one middle space point have been created
@@ -79,7 +79,7 @@ class SeedFilter final {
7979
template <typename collection_t>
8080
void filterSeeds_1SpFixed(
8181
SpacePointMutableData& mutableData,
82-
CandidatesForMiddleSp<const external_spacepoint_t>& candidatesCollector,
82+
CandidatesForMiddleSp<const external_space_point_t>& candidatesCollector,
8383
collection_t& outputCollection) const;
8484

8585
/// Filter seeds once all seeds for one middle space point have been created
@@ -92,15 +92,15 @@ class SeedFilter final {
9292
void filterSeeds_1SpFixed(
9393
SpacePointMutableData& mutableData,
9494
std::vector<typename CandidatesForMiddleSp<
95-
const external_spacepoint_t>::value_type>& candidates,
95+
const external_space_point_t>::value_type>& candidates,
9696
const std::size_t numQualitySeeds, collection_t& outputCollection) const;
9797

9898
/// Get the seed filter configuration
9999
/// @return Copy of the seed filter configuration
100100
const SeedFilterConfig getSeedFilterConfig() const { return m_cfg; }
101101
/// Get the experimental cuts pointer
102102
/// @return Pointer to experimental cuts (may be nullptr)
103-
const IExperimentCuts<external_spacepoint_t>* getExperimentCuts() const {
103+
const IExperimentCuts<external_space_point_t>* getExperimentCuts() const {
104104
return m_experimentCuts;
105105
}
106106

@@ -110,7 +110,7 @@ class SeedFilter final {
110110
const SeedFilterConfig m_cfg;
111111
std::unique_ptr<const Logger> m_logger =
112112
getDefaultLogger("Filter", Logging::Level::INFO);
113-
const IExperimentCuts<external_spacepoint_t>* m_experimentCuts;
113+
const IExperimentCuts<external_space_point_t>* m_experimentCuts;
114114
};
115115

116116
} // namespace Acts

Core/include/Acts/Seeding/SeedFilter.ipp

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,28 @@
1818

1919
namespace Acts {
2020

21-
template <typename external_spacepoint_t>
22-
SeedFilter<external_spacepoint_t>::SeedFilter(
21+
template <typename external_space_point_t>
22+
SeedFilter<external_space_point_t>::SeedFilter(
2323
const SeedFilterConfig& config,
24-
IExperimentCuts<external_spacepoint_t>* expCuts /* = 0*/)
24+
IExperimentCuts<external_space_point_t>* expCuts /* = 0*/)
2525
: m_cfg(config), m_experimentCuts(expCuts) {}
2626

27-
template <typename external_spacepoint_t>
28-
SeedFilter<external_spacepoint_t>::SeedFilter(
27+
template <typename external_space_point_t>
28+
SeedFilter<external_space_point_t>::SeedFilter(
2929
const SeedFilterConfig& config, std::unique_ptr<const Logger> logger,
30-
IExperimentCuts<external_spacepoint_t>* expCuts /* = 0*/)
30+
IExperimentCuts<external_space_point_t>* expCuts /* = 0*/)
3131
: m_cfg(config), m_logger(std::move(logger)), m_experimentCuts(expCuts) {}
3232

33-
template <typename external_spacepoint_t>
34-
void SeedFilter<external_spacepoint_t>::filterSeeds_2SpFixed(
33+
template <typename external_space_point_t>
34+
void SeedFilter<external_space_point_t>::filterSeeds_2SpFixed(
3535
const SpacePointMutableData& mutableData,
36-
const external_spacepoint_t& bottomSp,
37-
const external_spacepoint_t& middleSp,
38-
const std::vector<const external_spacepoint_t*>& topSpVec,
36+
const external_space_point_t& bottomSp,
37+
const external_space_point_t& middleSp,
38+
const std::vector<const external_space_point_t*>& topSpVec,
3939
const std::vector<float>& invHelixDiameterVec,
4040
const std::vector<float>& impactParametersVec,
4141
SeedFilterState& seedFilterState,
42-
CandidatesForMiddleSp<const external_spacepoint_t>& candidatesCollector)
42+
CandidatesForMiddleSp<const external_space_point_t>& candidatesCollector)
4343
const {
4444
// seed confirmation
4545
SeedConfirmationRangeConfig seedConfRange;
@@ -234,11 +234,11 @@ void SeedFilter<external_spacepoint_t>::filterSeeds_2SpFixed(
234234

235235
// after creating all seeds with a common middle space point, filter again
236236

237-
template <typename external_spacepoint_t>
237+
template <typename external_space_point_t>
238238
template <typename collection_t>
239-
void SeedFilter<external_spacepoint_t>::filterSeeds_1SpFixed(
239+
void SeedFilter<external_space_point_t>::filterSeeds_1SpFixed(
240240
SpacePointMutableData& mutableData,
241-
CandidatesForMiddleSp<const external_spacepoint_t>& candidatesCollector,
241+
CandidatesForMiddleSp<const external_space_point_t>& candidatesCollector,
242242
collection_t& outputCollection) const {
243243
// retrieve all candidates
244244
// this collection is already sorted
@@ -249,12 +249,12 @@ void SeedFilter<external_spacepoint_t>::filterSeeds_1SpFixed(
249249
outputCollection);
250250
}
251251

252-
template <typename external_spacepoint_t>
252+
template <typename external_space_point_t>
253253
template <typename collection_t>
254-
void SeedFilter<external_spacepoint_t>::filterSeeds_1SpFixed(
254+
void SeedFilter<external_space_point_t>::filterSeeds_1SpFixed(
255255
SpacePointMutableData& mutableData,
256256
std::vector<typename CandidatesForMiddleSp<
257-
const external_spacepoint_t>::value_type>& candidates,
257+
const external_space_point_t>::value_type>& candidates,
258258
const std::size_t numQualitySeeds, collection_t& outputCollection) const {
259259
if (m_experimentCuts != nullptr) {
260260
candidates = m_experimentCuts->cutPerMiddleSP(std::move(candidates));
@@ -294,7 +294,7 @@ void SeedFilter<external_spacepoint_t>::filterSeeds_1SpFixed(
294294
mutableData.setQuality(medium->index(), bestSeedQuality);
295295
mutableData.setQuality(top->index(), bestSeedQuality);
296296

297-
Seed<external_spacepoint_t> seed{*bottom, *medium, *top};
297+
Seed<external_space_point_t> seed{*bottom, *medium, *top};
298298
seed.setVertexZ(zOrigin);
299299
seed.setQuality(bestSeedQuality);
300300

0 commit comments

Comments
 (0)