acts-project
refactor: FPE safe eta/theta conversion
See two open discussion items here
- https://github.com/acts-project/acts/pull/3756#discussion_r1817429988
- https://github.com/acts-project/acts/pull/3756#discussion_r1817437660
📊: Physics performance monitoring for f92f14463986f8b3f4210d2e850abed2c91b2989
physmon summary
- ✅ Particles fatras
- ✅ Particles geant4
- ✅ Particles ttbar
- ✅ Vertices ttbar
- ✅ Truth tracking (KF)
- ✅ Truth tracking (GSF)
- ✅ Truth tracking (GX2F)
- ✅ Truth tracking (KF refit)
- ✅ Truth tracking (GSF refit)
- ✅ CKF finding performance | trackfinding | single muon | truth smeared seeding
- ✅ CKF fitting performance | trackfinding | single muon | truth smeared seeding
- ✅ CKF track summary | trackfinding | single muon | truth smeared seeding
- ✅ Seeding trackfinding | single muon | truth estimated seeding
- ✅ CKF finding performance | trackfinding | single muon | truth estimated seeding
- ✅ CKF fitting performance | trackfinding | single muon | truth estimated seeding
- ✅ CKF track summary | trackfinding | single muon | truth estimated seeding
- ✅ Seeding trackfinding | single muon | default seeding
- ✅ CKF finding performance | trackfinding | single muon | default seeding
- ✅ CKF fitting performance | trackfinding | single muon | default seeding
- ✅ CKF track summary | trackfinding | single muon | default seeding
- ✅ Seeding trackfinding | single muon | orthogonal seeding
- ✅ CKF finding performance | trackfinding | single muon | orthogonal seeding
- ✅ CKF fitting performance | trackfinding | single muon | orthogonal seeding
- ✅ CKF track summary | trackfinding | single muon | orthogonal seeding
- ✅ Seeding trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF finding performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF fitting performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF track summary | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ Ambisolver finding performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ IVF notime | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ AMVF gauss notime | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ AMVF grid time | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ Seeding trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF finding performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF fitting performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF track summary | trackfinding | ttbar with 200 pileup | default seeding
- ✅ Ambisolver finding performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ AMVF gauss notime | trackfinding | ttbar with 200 pileup | default seeding
- ✅ AMVF grid time | trackfinding | ttbar with 200 pileup | default seeding
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
I experimented with the unit test and thrown FPEs to come up with some bounds
Empirical boundaries seem fine to me personally.
I don't know if this is what @paulgessinger meant.
Personally, I would prefer consistent boundaries, as I suggested in https://github.com/acts-project/acts/pull/3756#discussion_r1817850323 so you get
- roughly the same limits for different FP types, and
- if beyond the limit, you are returned the equivalent value at the limit, not ±
inf.
I am less sure about (2). I don't know if any other bits of code (eg. printout of η) worry about inf.
Empirical boundaries seem fine to me personally.
I don't know if this is what @paulgessinger meant.
Personally, I would prefer consistent boundaries, as I suggested in #3756 (comment) so you get
- roughly the same limits for different FP types, and
- if beyond the limit, you are returned the equivalent value at the limit, not ±
inf.I am less sure about (2). I don't know if any other bits of code (eg. printout of η) worry about
inf.
I don't see a good reason for making the bounds the same TBH. If double has more precision than float why not use it. Same goes for different bounds in different directions. If eta->theta has different numerical properties than theta->eta why trim the precision?
What I meant is that pragmatically, for a selector like this, is there a reason that makes picking a very large value but not necessarily the numerical limit problematic.
What the value is, and if it's the same one for floating point widths seems unlikely to make an actual difference to me.
I added a clamped version @paulgessinger @timadye
@timadye can you check if this is what you had in mind?
Walkthrough
A new template structure EtaThetaConversionTraits for float and double types has been introduced in the Acts::AngleHelpers namespace, defining constants for angle conversions. The functions etaFromTheta and thetaFromEta have been modified to include safety checks against these constants to prevent floating-point exceptions. In the test files, local implementations of thetaFromEta have been replaced with calls to AngleHelpers::thetaFromEta, and new data-driven tests have been added to validate the robustness of the angle conversion functions.
Changes
| File Path | Change Summary |
|---|---|
| Core/include/Acts/Utilities/AngleHelpers.hpp | New struct EtaThetaConversionTraits for float and double, modified etaFromTheta and thetaFromEta functions for safety checks. |
| Tests/UnitTests/Core/TrackFinding/TrackSelectorTests.cpp | Removed local thetaFromEta function, updated test cases to use AngleHelpers::thetaFromEta, included AngleHelpers.hpp. |
| Tests/UnitTests/Core/Utilities/AngleHelpersTests.cpp | Added new test cases EtaFromThetaRobustness and ThetaFromEtaRobustness to validate angle conversion functions. |
Poem
In the realm of angles, new traits arise,
With safety checks, the errors minimize.
From theta to eta, the journey's now bright,
Robust tests ensure conversions are right.
In CodeRabbit's code, precision we find,
A leap for the future, with wisdom aligned! 🐰✨
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: ASSERTIVE
📥 Commits
Reviewing files that changed from the base of the PR and between 5a220d77e52693f4e100ccab3b3a3194396e6a2d and f92f14463986f8b3f4210d2e850abed2c91b2989.
📒 Files selected for processing (1)
Core/include/Acts/Utilities/AngleHelpers.hpp(1 hunks)
🔇 Additional comments (3)
Core/include/Acts/Utilities/AngleHelpers.hpp (3)
19-35: Specializations for float and double, well-implemented they are.
Appropriate constants defined, enhancing FPE safety they do.
47-54: Correct the logic of etaFromTheta is.
Checks against minTheta and maxTheta ensure FPE safety.
67-73: Implementation of thetaFromEta, appropriate it is.
Gracefully handling edge cases, the function does.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}
I feat
constexpris only available with C++26 onwards for math functions.
ah yes of course. I forgot I already mentioned that 😉
Quality Gate passed
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
88.2% Coverage on New Code
0.0% Duplication on New Code
See analysis details on SonarCloud
![sonarqubecloud[bot] avatar](https://avatars.githubusercontent.com/in/12526?v=4 "Published by a pub.dev verified publisher"){kind=small}
:red_circle: Athena integration test results [76bc018dfc5ecdc76d9f34cb38b4750dbb55fb16]
:red_circle: Some tests have failed!
Please investigate the pipeline!
