Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Combine GSF actor and aborter #3984

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

andiwand
Copy link
Contributor

@andiwand andiwand commented Dec 14, 2024

Currently the GSF actor communicates the abort flag via the navigation break which is not ideal. I want to remove setting this flag from outside in #3449. The GSF can carry this flag by itself and after the actor+aborter refactor we do not need a separate aborter anymore.

pulled out of #3449

Summary by CodeRabbit

  • New Features
    • Introduced a new method to check if navigation should be aborted based on processed measurements.
  • Improvements
    • Updated navigation handling in the fitting process by removing the NavigationBreakAborter struct.
    • Refined geo context management in multiple methods for better clarity and consistency.

@andiwand andiwand added this to the next milestone Dec 14, 2024
Copy link

coderabbitai bot commented Dec 14, 2024

Walkthrough

Changes to the Gaussian Sum Fitter, there are. Removed, the NavigationBreakAborter has been. Simplified, the actor lists become. In the GsfActor, a new method to check abort conditions, introduced. Geo context handling, refined it has been. Subtle shifts in track fitting navigation and measurement processing, these modifications represent.

Changes

File Change Summary
Core/include/Acts/.../GaussianSumFitter.hpp - Removed NavigationBreakAborter struct
- Simplified Actors type aliases in fit methods
Core/include/Acts/.../detail/GsfActor.hpp - Added checkAbort() method
- Updated act() method with abort checking
- Modified geo context usage in applyBetheHeitler and updateStepper methods

Possibly related PRs

Poem

In the realm of tracks so fine,
Navigators dance, actors align.
Breaking rules with Jedi grace, 🚀
Measurements flow, finding their place.
Code evolves, the Force grows bright! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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.

Copy link

github-actions bot commented Dec 14, 2024

📊: Physics performance monitoring for 99c9806

Full contents

physmon summary

@andiwand andiwand marked this pull request as ready for review December 14, 2024 12:32
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
Core/include/Acts/TrackFitting/detail/GsfActor.hpp (2)

535-537: Documentation for geo context usage, suggest I do.

Help future Padawans understand the ways of the Force, a comment about geo context usage would. The code itself, correct it is.

+ // Use stepping's geo context for bound to free transformation
  cmp.jacToGlobal() = surface.boundToFreeJacobian(
    state.stepping.geoContext, freeParams.template segment<3>(eFreePos0),
    freeParams.template segment<3>(eFreeDir0));

Line range hint 1-824: Wise architectural changes, these are.

Improved encapsulation through internal abort handling, I sense. Clean separation of concerns, maintained it is. The Dark Side of external dependencies, reduced it has been.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dbd469a and 3c898ca.

📒 Files selected for processing (1)
  • Core/include/Acts/TrackFitting/detail/GsfActor.hpp (2 hunks)
🔇 Additional comments (1)
Core/include/Acts/TrackFitting/detail/GsfActor.hpp (1)

322-333: Clean and focused, this new method is, hmmmm.

Well-implemented function for navigation control, I see. Proper logging and clear purpose, it has. The Force is strong with this code.

benjaminhuth
benjaminhuth previously approved these changes Dec 16, 2024
Copy link
Member

@benjaminhuth benjaminhuth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Core/include/Acts/TrackFitting/detail/GsfActor.hpp Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
Core/include/Acts/TrackFitting/detail/GsfActor.hpp (1)

Inconsistent usage of geoContext in GsfActor.hpp, I sense.

In GsfActor.hpp, three instances of state.stepping.geoContext still remain, while other files have embraced state.options.geoContext. Harmonize these patterns, we must:

  • Line references in GsfActor.hpp:
    • old_bound.position(state.stepping.geoContext), state.options.direction
    • state.stepping.geoContext
    • old_bound.position(state.stepping.geoContext), old_bound.direction()
🔗 Analysis chain

Line range hint 1-320: Verify the geo context changes across the codebase, we must.

Replaced state.stepping.geoContext with state.options.geoContext, I see. Ensure consistency across all usages, we should.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining instances of stepping.geoContext
rg "stepping\.geoContext" 

# Search for new pattern to verify consistency
rg "options\.geoContext"

Length of output: 1755

🧹 Nitpick comments (1)
Core/include/Acts/TrackFitting/detail/GsfActor.hpp (1)

322-333: Improved encapsulation, this refactoring brings.

Moving abort logic into GsfActor, better design it is. Single Responsibility Principle, it now follows. No longer does it depend on NavigationBreakAborter, hmm.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c898ca and 99c9806.

📒 Files selected for processing (1)
  • Core/include/Acts/TrackFitting/detail/GsfActor.hpp (1 hunks)
🔇 Additional comments (1)
Core/include/Acts/TrackFitting/detail/GsfActor.hpp (1)

322-333: Clean and focused, this implementation is!

Well-implemented abort check, with clear purpose and good logging, I see. Single responsibility principle, it follows.

Copy link
Member

@benjaminhuth benjaminhuth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@kodiakhq kodiakhq bot merged commit 1960d7a into acts-project:main Dec 16, 2024
44 checks passed
@andiwand andiwand deleted the refactor-gsf-abort branch December 16, 2024 10:48
@paulgessinger paulgessinger modified the milestones: next, v38.2.0 Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Track Fitting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants