docs: Add comments grid iterator #2839
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #2839 +/- ##
=======================================
Coverage 48.88% 48.89%
=======================================
Files 488 488
Lines 28244 28253 +9
Branches 13303 13307 +4
=======================================
+ Hits 13808 13813 +5
Misses 4827 4827
- Partials 9609 9613 +4 ☔ View full report in Codecov by Sentry. |
📊: Physics performance monitoring for fd91f49physmon summary
|
CarloVarni
force-pushed
the
AddCommentsGridIterator
branch
from
a325bc2 to
01fb179
Compare
added 2 commits
January 8, 2024 15:26
|
Hi @niermann999 thanks for the comment. I have applied your suggestions |
added 2 commits
January 9, 2024 10:16
niermann999
previously approved these changes
Jan 9, 2024
acts-policybot
bot
dismissed
niermann999’s stale review
Invalidated by push of fd91f49
|
Hi @niermann999 I had to make a minor change to fix a problem in the doc test ( This PR needs another approval for the CI to be happy |
niermann999
approved these changes
Jan 10, 2024
acts-project-service
added
the
Fails Athena tests
kodiakhq bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
A general class for defining a `BinnedGroup`. This class stores a `grid` (owns it), two `GridBinFinders` and a navigation pattern, optionally defined by the user. The PR also defines its iterator. This will replace the current `BinnedSPGroup` implementation, which is very specific. Also, creating and filling a grid cannot be generalized imho: variable definitions, selection cuts, number of axes and their ordering. As such, the creation and the filling of the grid are now handled externally, and not inside the `BinnedGroup` class, and it's the user's duty to make sure the filling happens. In my mind, all of this should be handled by the user for any custom way of doing it. One thing we can provide (as we currently do but I'm afraid is more a "nice consequence" then a "design") some pre-defined grids for specific geometries. For instance we can define a `CylindricalSpacePointGrid<external_spacepoint_t>` (as well as `CylindricalBinnedGroup<external_spacepoint_t>`) or a `TelescopeSpacePointGrid<external_spacepoint_t>` (and its `TelescopeBinnedGroup<external_spacepoint_t>`). These last points are not covered here, will be addressed in another PR once this one is in. My idea is to define these "specialization" as simple `typedef`s of the above generic classes, as well as defining functions for their creation and filling. This can be located inside a new `Acts/Seeding/detail` folder, so we can add as many specializations as possible. Requires: - #2838 - #2835 - #2839 (maybe optional?)
paulgessinger
removed
the
Fails Athena tests
LaraCalic
pushed a commit
to LaraCalic/acts
that referenced
this pull request
Feb 10, 2024
This adds some comments to the code to describe what the grid iterator classes do. It also adds two methods for retrieving the current local and global positions from the iterators, as well as adding some unit tests to check these newly-added methods. --------- Co-authored-by: Carlo Varni <carlovarni@pccvarni.dyndns.cern.ch> Co-authored-by: Carlo Varni <carlovarni@88-66-5a-25-b5-1f.dhcp.lbnl.us> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> Co-authored-by: Carlo Varni <carlovarni@MacBook-Pro-di-Carlo-5.local>
LaraCalic
pushed a commit
to LaraCalic/acts
that referenced
this pull request
Feb 10, 2024
A general class for defining a `BinnedGroup`. This class stores a `grid` (owns it), two `GridBinFinders` and a navigation pattern, optionally defined by the user. The PR also defines its iterator. This will replace the current `BinnedSPGroup` implementation, which is very specific. Also, creating and filling a grid cannot be generalized imho: variable definitions, selection cuts, number of axes and their ordering. As such, the creation and the filling of the grid are now handled externally, and not inside the `BinnedGroup` class, and it's the user's duty to make sure the filling happens. In my mind, all of this should be handled by the user for any custom way of doing it. One thing we can provide (as we currently do but I'm afraid is more a "nice consequence" then a "design") some pre-defined grids for specific geometries. For instance we can define a `CylindricalSpacePointGrid<external_spacepoint_t>` (as well as `CylindricalBinnedGroup<external_spacepoint_t>`) or a `TelescopeSpacePointGrid<external_spacepoint_t>` (and its `TelescopeBinnedGroup<external_spacepoint_t>`). These last points are not covered here, will be addressed in another PR once this one is in. My idea is to define these "specialization" as simple `typedef`s of the above generic classes, as well as defining functions for their creation and filling. This can be located inside a new `Acts/Seeding/detail` folder, so we can add as many specializations as possible. Requires: - acts-project#2838 - acts-project#2835 - acts-project#2839 (maybe optional?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some comments to the code to describe what the grid iterator classes do. It also adds two methods for retrieving the current local and global positions from the iterators, as well as adding some unit tests to check these newly-added methods.