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(*Stack): Use local variables #1584

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

ChristianTackeGSI
Copy link
Member

... instead of member variable fFSTrackIter.

Deprecate that member variable.


Checklist:

Copy link

coderabbitai bot commented Aug 15, 2024

Walkthrough

Walkthrough

The recent changes to the FairStack and FairGenericStack classes involve refactoring for improved code clarity and maintainability. Key modifications include the introduction of the FSTrackMapLookup method for track ID retrieval, simplification of existing methods, and the use of modern C++ practices such as range-based for-loops and auto type inference. Additionally, compiler directives have been added to suppress warnings for deprecated declarations, ensuring compatibility with older code.

Changes

File Change Summary
.../mcstack/FairStack.cxx Refactored GetCurrentTrackNumber and AddPoint methods to use FSTrackMapLookup, simplified track management logic, and replaced iterator with range-based for-loop in SelectTracks.
.../sim/FairGenericStack.cxx, .../sim/FairGenericStack.h Added compiler directives to suppress deprecated warnings, modified FastSimMoveParticleTo to utilize FSTrackMapLookup, and updated FastSimUpdateTrackIndex to include const qualifier and use auto. A new method FSTrackMapLookup was also added.

Possibly related PRs

  • refactor(Base): Call GetCurrentTrackNumber directly from FairGenericStack #1588: This PR modifies the FairGenericStack::FastSimMoveParticleTo method to replace the logic for retrieving the current track ID with a call to GetCurrentTrackID(), which is related to the changes in the main PR that refactor the logic for track management in the FairStack class, specifically through the use of FSTrackMapLookup.

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ab409c and 6decd1e.

Files selected for processing (3)
  • examples/common/mcstack/FairStack.cxx (6 hunks)
  • fairroot/base/sim/FairGenericStack.cxx (4 hunks)
  • fairroot/base/sim/FairGenericStack.h (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • examples/common/mcstack/FairStack.cxx
  • fairroot/base/sim/FairGenericStack.cxx
  • fairroot/base/sim/FairGenericStack.h

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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 or @coderabbitai title 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.

@ChristianTackeGSI ChristianTackeGSI marked this pull request as draft August 15, 2024 07:58
@ChristianTackeGSI ChristianTackeGSI marked this pull request as ready for review August 15, 2024 09:22
// --> Clear storage map
fStoreMap.clear();

// loop over tracks created by FastSim to order the tracks
for (fFSTrackIter = fFSTrackMap.begin(); fFSTrackIter != fFSTrackMap.end(); ++fFSTrackIter) {
for (auto tmentry : fFSTrackMap) {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
for (auto tmentry : fFSTrackMap) {
for (const auto [newTrack, originalTrack] : fFSTrackMap) {

see https://en.cppreference.com/w/cpp/language/structured_binding

Perhaps you find better names even, .first/.second is definitely terrible for readability.

Copy link
Member Author

Choose a reason for hiding this comment

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

TL;DR I wont do this in this PR.

To Be Honest, I have not yet udnerstood what this map is actually mapping. Yes, it's something "old" / "new". But I really don't understand it yet. So if someone else has this understanding, then I'd ask that person to go ahead and improve things!

Copy link
Member

Choose a reason for hiding this comment

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

This comment I took the terms "new" and "original" from:

/** FastSimulation: STL map from new track index to original track index **/
std::map<Int_t, Int_t> fFSTrackMap; //!

Copy link
Member

Choose a reason for hiding this comment

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

But I agree, it does not help much.

Copy link
Member Author

Choose a reason for hiding this comment

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

Can we resolve this and postpone for the next refactoring round?

Copy link
Collaborator

Choose a reason for hiding this comment

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

From what I remember this map was introduced when we (@karabowi and @kresan) introduced the possibility to run FastSimulation in FairRoot. From what I remember the problem was the particle counting in the FastSimulation mode: normally, the secondaries created in the transport engine go to the end of the stack, while in the FS mode they were pushed just after the primary. That caused problem later on, so a map was created to track the FS secondaries.
After the event, the FS secondaries were to be moved to the end of the stack, and the points created by the had to be changed.

All that said. @fuhlig1 , @kresan , I think the FastSim mode was a dead end. PANDA is not using our implementation, they have their own. What about CBM or R3B? IMHO we could get rid of FastSim totally.
What do you think?

Copy link
Member Author

@ChristianTackeGSI ChristianTackeGSI Aug 20, 2024

Choose a reason for hiding this comment

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

IMHO we could get rid of FastSim totally.
What do you think?

Should we move that part of the discussion to a fresh issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

TBH, I don't know how to continue with this PR: If FastSim is a "dead end", then I probably should not invent new APIs like FairGenericStack::FSTrackMapLookup (which I currently do in this PR)?

But on the other hand, I am not feeling happy to just strip all FastSim stuff away.

If we wanted to merge this one "to simplify our current code", then I could already deprecated FairGenericStack::FSTrackMapLookup?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we can discuss the issue on our meeting next Monday. Dima is pretty sure it is not used in R3B, cbmroot also has no traces of FastSim.

Copy link
Member Author

Choose a reason for hiding this comment

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

Rethinking this, I would propose the following:

  • We consider this PR independant of a possible FastSim deprecation / removal.
  • Refactoring this might make the FastSim deprecation / removal even simpler, maybe
  • And in a second step let's look at the FastSim stuff (please let's open an issue!)

Considering a possible deprecation / removal of these Fastsim things, I'd propose to keep the non-intuitive names for the time being.

... instead of member variable fFSTrackIter.

Deprecate that member variable.

Refactor the map lookup into
FairGenericStack::FSTrackMapLookup().

Also some little related cleanups (use map.count, const).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants