feat: Allow multiple aliases for one whiteboard entry in Examples

[andiwand]

This allows us having multiple aliases pointing to the same object in the whiteboard which was not possible before because of the usage of std::unordered_map which is now replaced with std:: unordered_multimap

Pulled out of #3969

Summary by CodeRabbit

• New Features

  • Enhanced object aliasing capabilities in the framework
  • Added support for multiple aliases per object name

• Refactor

  • Updated data structures to support more flexible alias management
  • Modified alias handling logic in WhiteBoard and Sequencer components

• Bug Fixes

  • Improved error checking and logging for object aliases

[coderabbitai]

Walkthrough

In the framework of ACTS Examples, a transformation has occurred in the WhiteBoard and Sequencer components. The primary change involves shifting from a standard unordered map to a multimap for object aliases, enabling multiple aliases to be associated with a single object name. This modification enhances the flexibility of object name management across the system, allowing more nuanced alias handling.

Changes

File	Change Summary
Examples/Framework/include/ActsExamples/Framework/Sequencer.hpp	Changed m_whiteboardObjectAliases from std::unordered_map to std::unordered_multimap
Examples/Framework/include/ActsExamples/Framework/WhiteBoard.hpp	Updated constructor and m_objectAliases to use std::unordered_multimap
Examples/Framework/src/Framework/Sequencer.cpp	Modified addWhiteboardAlias method to work with multimap, adjusted alias insertion logic

Sequence Diagram

sequenceDiagram
    participant Sequencer
    participant WhiteBoard
    Sequencer->>WhiteBoard: addWhiteboardAlias
    WhiteBoard-->>Sequencer: Check existing aliases
    WhiteBoard->>WhiteBoard: Insert new alias if unique

Loading

Poem

Aliases dance, multiple and free
🗺️ Maps transform with gentle glee
One name, now many paths to see
Flexibility blooms like a coding tree
Multimap magic, oh what could be! 🌟

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e40c90 and c87a2d9.

📒 Files selected for processing (3)

• Examples/Framework/include/ActsExamples/Framework/Sequencer.hpp (1 hunks)
• Examples/Framework/include/ActsExamples/Framework/WhiteBoard.hpp (4 hunks)
• Examples/Framework/src/Framework/Sequencer.cpp (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (18)

• GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
• GitHub Check: merge-sentinel
• GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
• GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
• GitHub Check: CI Bridge / build_linux_ubuntu
• GitHub Check: CI Bridge / linux_ubuntu_2204
• GitHub Check: CI Bridge / linux_ubuntu_2204_clang
• GitHub Check: CI Bridge / build_exatrkx_cpu
• GitHub Check: CI Bridge / build_exatrkx
• GitHub Check: CI Bridge / clang_tidy
• GitHub Check: unused_files
• GitHub Check: macos
• GitHub Check: missing_includes
• GitHub Check: linux_ubuntu_extra (ubuntu2204_clang, 20)
• GitHub Check: linux_ubuntu_extra (ubuntu2204, 20)
• GitHub Check: build_debug
• GitHub Check: docs
• GitHub Check: linux_ubuntu

🔇 Additional comments (4)

Examples/Framework/include/ActsExamples/Framework/WhiteBoard.hpp (2)

36-39: Approve these changes, I do!

Wise choice it is, to use std::unordered_multimap. Multiple aliases per object, this enables. Consistent with the objective of the changes, this implementation is.

Also applies to: 85-85

---

119-123: Handle multiple aliases correctly, this implementation does!

Through the range of aliases, it iterates. Each alias to the store, it adds. Proper logging of actions, it maintains.

Examples/Framework/include/ActsExamples/Framework/Sequencer.hpp (1)

180-180: Consistency in the Force, I sense!

Changed to std::unordered_multimap, the member variable is. With WhiteBoard changes, this aligns perfectly.

Examples/Framework/src/Framework/Sequencer.cpp (1)

256-275: Robust and wise, this implementation is!

Duplicate aliases, it prevents. Non-existent objects, it catches early. With WhiteBoard changes, in harmony it works.

Strong with the Force, this error handling is:

• Before insertion, existence of duplicates it checks
• Early validation of object names, it performs
• Clear logging messages, it provides

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

📊: Physics performance monitoring for c87a2d9

Full contents

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
• ✅ ML Ambisolver | 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

[sonarqubecloud]

Quality Gate passed

Issues
2 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

[paulgessinger]

Can we schedule this behind #4018? That also touches the aliasing.