refactor: Add new concepts for Eigen types #3966

stephenswat · 2024-12-07T12:16:48Z

This commit adds several new concepts for dealing with Eigen base types. The motivation for this is superficially to simplify some of the requirements in the track state proxy and the multi-trajectory, but it also allows me to more easily deal with some clang compiler warnings seen in #3949, as clang won't let me compare A::ColsAtCompileTime and B::ColsAtCompileTime if A and B are different types; this allows me to hide the conversion to integers inside a concept.

Summary by CodeRabbit

New Features
- Introduced new concepts for Eigen matrix types to enhance type safety and clarity in the TrackStateProxy and VectorMultiTrajectory classes.
- Updated method signatures in both classes to utilize these concepts for improved parameter validation.
Bug Fixes
- Enhanced error handling logic in the allocateCalibrated_impl method to ensure consistent exception messaging.
Documentation
- Added a new header file defining several concepts related to Eigen dense matrix types, improving code expressiveness and type-checking capabilities.

This commit adds several new concepts for dealing with Eigen base types. The motivation for this is superficially to simplify some of the requirements in the track state proxy and the multi-trajectory, but it also allows me to more easily deal with some clang compiler warnings seen in acts-project#3949, as clang won't let me compare `A::ColsAtCompileTime` and `B::ColsAtCompileTime` if `A` and `B` are different types; this allows me to hide the conversion to integers inside a concept.

coderabbitai · 2024-12-07T12:16:55Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new header file, EigenConcepts.hpp, introduced concepts for Eigen matrix types, enhancing type safety in the TrackStateProxy and VectorMultiTrajectory classes. The allocateCalibrated and allocateCalibrated_impl methods were updated to use these concepts instead of static assertions, ensuring that parameters conform to expected properties, such as being fixed-size and square. This change does not affect the overall structure or functionality of the classes, focusing instead on improving clarity and robustness in type constraints.

Changes

File Path	Change Summary
Core/include/Acts/EventData/TrackStateProxy.hpp	Added include for `EigenConcepts.hpp`; updated `allocateCalibrated` method signature to use concepts for parameter validation, enhancing type constraints.
Core/include/Acts/EventData/VectorMultiTrajectory.hpp	Added include for `EigenConcepts.hpp`; updated `allocateCalibrated_impl` method signature to use concepts for parameter validation, replacing static assertions with more robust type checks.
Core/include/Acts/Utilities/EigenConcepts.hpp	Introduced `EigenConcepts.hpp` defining concepts such as `is_eigen_base`, `eigen_base_is_fixed_size`, `eigen_base_is_square`, and others for type-checking Eigen matrix types, enhancing type safety in related classes.

Possibly related PRs

fix: oneAPI 2025 Fixes, main branch (2024.12.04.) #3938: This PR modifies the allocateCalibrated methods in the MultiTrajectory class, which is related to the changes in the allocateCalibrated method of the TrackStateProxy class in the main PR, as both involve similar method signatures and concepts related to Eigen matrix types.

Suggested labels

Component - Core, automerge

Suggested reviewers

AJPfleger
paulgessinger

In the realm of code, new concepts arise,
Type safety enhanced, a wise surprise.
With Eigen's might, constraints now clear,
Robust and strong, we have no fear.
Jedi coding, we shall prevail,
In clarity and strength, we will not fail! 🌟

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?

❤️ Share

🪧 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 @coderabbitai in 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 @coderabbitai in 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 pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

github-actions · 2024-12-07T13:10:06Z

📊: Physics performance monitoring for `b2dd297`

Full contents

physmon summary

Core/include/Acts/EventData/TrackStateProxy.hpp

Core/include/Acts/Utilities/EigenConcepts.hpp

sonarqubecloud · 2024-12-20T08:45:09Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

acts-project-service · 2024-12-20T11:12:57Z

✅ Athena integration test results [`26273bc`]

✅ All tests successful

status	job	report
🟢	report_pull_request
🟢	run_workflow_tests_run4_mc
🟢	run_workflow_tests_run2_mc
🟢	run_workflow_tests_run2_data
🟢	run_workflow_tests_run3_mc
🟢	run_workflow_tests_run3_data
🟢	test_ActsDumpGeometryIdentifiers
🟢	test_ActsCheckObjectCountsWorkflowHgtd
🟢	test_ActsCheckObjectCountsCachedWorkflow
🟢	test_ActsCheckObjectCountsWorkflow
🟢	test_ActsEFTrackFit
🟢	test_ActsPersistifySeeds
🟢	test_ActsBenchmarkWithSpot
🟢	test_ActsAnalogueClustering
🟢	test_ActsWorkflowHeavyIons
🟢	test_ActsWorkflowFastTracking
🟢	test_ActsWorkflowCached
🟢	test_ActsWorkflow
🟢	test_ActsValidateAmbiguityResolution
🟢	test_ActsValidateResolvedTracks
🟢	test_ActsValidateTracks
🟢	test_ActsValidateActsCoreSpacePoints
🟢	test_ActsValidateActsSpacePoints
🟢	test_ActsValidateSeeds
🟢	test_ActsValidateOrthogonalSeeds
🟢	test_ActsValidateClusters
🟢	test_ActsPersistifyEDM
🟢	test_ActsGx2fRefitting
🟢	test_ActsGSFRefitting
🟢	test_ActsKfRefitting
🟢	test_ActsExtrapolationAlgTest
🟢	test_ActsITkTest

github-actions bot added this to the next milestone Dec 7, 2024

github-actions bot added Component - Core Affects the Core module Event Data Model labels Dec 7, 2024

stephenswat marked this pull request as draft December 7, 2024 12:41

paulgessinger reviewed Dec 7, 2024

View reviewed changes

Core/include/Acts/EventData/TrackStateProxy.hpp Show resolved Hide resolved

Core/include/Acts/Utilities/EigenConcepts.hpp Show resolved Hide resolved

paulgessinger added 2 commits December 13, 2024 20:00

Merge branch 'main' into refactor/eigen_concepts

9a544bd

Merge branch 'main' into refactor/eigen_concepts

b2dd297

paulgessinger marked this pull request as ready for review December 20, 2024 07:22

paulgessinger approved these changes Dec 20, 2024

View reviewed changes

paulgessinger added the automerge label Dec 20, 2024

kodiakhq bot merged commit 26273bc into acts-project:main Dec 20, 2024
44 checks passed

github-actions bot removed the automerge label Dec 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Add new concepts for Eigen types #3966

refactor: Add new concepts for Eigen types #3966

stephenswat commented Dec 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 7, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Dec 7, 2024 •

edited

Loading

sonarqubecloud bot commented Dec 20, 2024

acts-project-service commented Dec 20, 2024

refactor: Add new concepts for Eigen types #3966

refactor: Add new concepts for Eigen types #3966

Conversation

stephenswat commented Dec 7, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 7, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Dec 7, 2024 • edited Loading

📊: Physics performance monitoring for b2dd297

physmon summary

sonarqubecloud bot commented Dec 20, 2024

Quality Gate passed

acts-project-service commented Dec 20, 2024

✅ Athena integration test results [26273bc]

✅ All tests successful

stephenswat commented Dec 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 7, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Dec 7, 2024 •

edited

Loading

📊: Physics performance monitoring for `b2dd297`

✅ Athena integration test results [`26273bc`]