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

fix!: Make BinUtility constructor explicit #3953

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Dec 5, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced JSON serialization and deserialization for material types, including robust handling for binned materials.
    • Improved error handling for unsupported binning configurations during JSON conversion.
    • Updated constructor for BinUtility to prevent implicit conversions.
  • Bug Fixes

    • Adjusted grid index type assignment based on binning values to prevent runtime errors.
    • Improved error handling and logging in material conversion processes.
  • Tests

    • Updated test cases for BinUtility initialization to improve clarity without altering functionality.

@paulgessinger paulgessinger added this to the next milestone Dec 5, 2024
Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

Modify the BinUtility constructor in Core/include/Acts/Utilities/BinUtility.hpp to include the explicit keyword, preventing implicit conversions. Enhance JSON serialization and deserialization in Plugins/Json/src/MaterialJsonConverter.cpp for materials, especially for binned materials, with new checks and error handling. Update the ModuleClustersTests.cpp to directly initialize BinUtility with BinningData instances, improving clarity without altering test logic.

Changes

File Path Change Summary
Core/include/Acts/Utilities/BinUtility.hpp Constructor updated to explicit BinUtility(const BinningData& bData, const Transform3& tForm = Transform3::Identity()).
Plugins/Json/src/MaterialJsonConverter.cpp Enhanced JSON conversion for materials, added checks for binned materials, updated function signatures for serialization/deserialization.
Tests/UnitTests/Examples/Algorithms/Digitization/ModuleClustersTests.cpp Updated testDigitizedParametersWithTwoClusters to directly initialize BinUtility with BinningData.
Plugins/Detray/src/DetrayMaterialConverter.cpp Updated convertGridSurfaceMaterial and convertHomogeneousSurfaceMaterial methods for better handling of binned materials and error management.

Possibly related PRs

  • refactor: modernise map utils #3615: The changes in this PR involve modifications to function signatures and the introduction of a new utility function that processes vectors, which may indirectly relate to the handling of BinningData in the BinUtility class, but there is no direct connection to the constructor modification of BinUtility.

Suggested labels

automerge

Suggested reviewers

  • andiwand

Poem

In the code, a change so bright,
BinUtility shines with new light.
JSON flows with checks anew,
Binned materials, clearer too!
Tests now sing with simpler grace,
A joyful dance in the coding space! 🌟


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 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.

@paulgessinger paulgessinger modified the milestones: next, v39.0.0 Dec 5, 2024
@paulgessinger paulgessinger changed the title fix: Make BinUtility constructor explicit fix!: Make BinUtility constructor explicit Dec 5, 2024
@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins labels Dec 5, 2024
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 and nitpick comments (3)
Plugins/Detray/src/DetrayMaterialConverter.cpp (3)

Line range hint 165-166: Throw the exception, you must.

At line 166, an exception you construct, but throw it you do not. Missing the throw keyword, it is.

Apply this diff to fix the issue:

- std::invalid_argument("Unsupported binning for Detray");
+ throw std::invalid_argument("Unsupported binning for Detray");

Line range hint 172-174: Exception not thrown, issue this is.

An exception object you create at line 173, but throw it you must.

Apply this diff to fix the issue:

- std::runtime_error(
-     "DetrayMaterialConverter: Unsupported binning for Detray");
+ throw std::runtime_error(
+     "DetrayMaterialConverter: Unsupported binning for Detray");

Line range hint 219-220: Consider consistency in exception handling, you should.

Properly throwing exceptions in all cases, ensure you must.

Review exception handling throughout the code, and consistent use of throw confirm.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e22bee0 and 73d0e09.

📒 Files selected for processing (1)
  • Plugins/Detray/src/DetrayMaterialConverter.cpp (1 hunks)
🔇 Additional comments (1)
Plugins/Detray/src/DetrayMaterialConverter.cpp (1)

177-177: Adapting to explicit constructor, correctly you have.

The explicit construction of BinUtility with {} ensures compatibility and clarity.

Copy link

github-actions bot commented Dec 5, 2024

📊: Physics performance monitoring for 73d0e09

Full contents

physmon summary

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 Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants