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!: Explicit BoundaryTolerance constructors #3974

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

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Dec 10, 2024

The commits contain two options on how to do this:

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Refactor

    • Updated BoundaryTolerance class internal representation
    • Replaced public structs with private parameter structs
    • Simplified initialization and type checking methods
    • Updated method signatures to use new parameter types
  • Style

    • Modified object initialization syntax from brace initialization to constructor calls in multiple files

The changes primarily focus on improving the internal structure of the BoundaryTolerance class while maintaining its existing functionality.

Copy link

coderabbitai bot commented Dec 10, 2024

Warning

Rate limit exceeded

@paulgessinger has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 15 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ed92262 and 11ec20a.

📒 Files selected for processing (1)
  • Core/include/Acts/Surfaces/BoundaryTolerance.hpp (4 hunks)

Walkthrough

In the realm of boundary tolerance, a significant restructuring has occurred within the BoundaryTolerance class. The public structs representing different tolerance types have been transformed into private parameter structs, enhancing encapsulation and interface clarity. Static methods now provide a clean mechanism for creating tolerance instances, while maintaining the core validation logic and functionality of the original implementation.

Changes

File Change Summary
Core/include/Acts/Surfaces/BoundaryTolerance.hpp Renamed public structs to private parameter structs, added static creation methods
Core/src/Surfaces/BoundaryTolerance.cpp Consolidated constructors, updated type checks and return types
Core/src/Geometry/TrapezoidVolumeBounds.cpp Updated BoundaryTolerance::AbsoluteBound instantiation syntax
Examples/Io/Root/src/RootAthenaDumpReader.cpp Modified BoundaryTolerance::AbsoluteEuclidean instantiation
Tests/* Updated boundary tolerance object initialization across test files

Possibly related PRs

Suggested Labels

automerge

Suggested Reviewers

  • andiwand

Poem

Boundaries shift like sands of time,
Tolerances dance, a code sublime
Structs transform, parameters gleam
In Acts' embrace, a refactored dream
Wisdom flows through lines of might 🧘‍♂️✨


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 github-actions bot added this to the next milestone Dec 10, 2024
Copy link

github-actions bot commented Dec 10, 2024

📊: Physics performance monitoring for 11ec20a

Full contents

physmon summary

@github-actions github-actions bot added the Stale label Jan 9, 2025
@andiwand andiwand removed the Stale label Jan 15, 2025
@paulgessinger paulgessinger marked this pull request as ready for review January 15, 2025 17:58
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 (1)
Core/include/Acts/Surfaces/BoundaryTolerance.hpp (1)

Line range hint 56-109: Wise move to private parameter structs, it is! Hmmmm.

Strong encapsulation and validation, these parameter structs provide. Clear separation between interface and implementation, there now is.

A suggestion for consistency, I have:

-    AbsoluteEuclideanParams() = default;
-    explicit AbsoluteEuclideanParams(double tolerance_)
-        : tolerance(tolerance_) {}
+    AbsoluteEuclideanParams() = default;
+    explicit AbsoluteEuclideanParams(double tolerance_)
+        : tolerance(tolerance_) {
+      // No validation needed for Euclidean tolerance as it can be negative
+    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f060123 and ed92262.

📒 Files selected for processing (7)
  • Core/include/Acts/Surfaces/BoundaryTolerance.hpp (4 hunks)
  • Core/src/Geometry/TrapezoidVolumeBounds.cpp (1 hunks)
  • Core/src/Surfaces/BoundaryTolerance.cpp (9 hunks)
  • Examples/Io/Root/src/RootAthenaDumpReader.cpp (1 hunks)
  • Tests/Benchmarks/AnnulusBoundsBenchmark.cpp (1 hunks)
  • Tests/UnitTests/Core/Surfaces/BoundaryToleranceTests.cpp (3 hunks)
  • Tests/UnitTests/Core/Surfaces/TrapezoidBoundsTests.cpp (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • Core/src/Geometry/TrapezoidVolumeBounds.cpp
  • Tests/UnitTests/Core/Surfaces/TrapezoidBoundsTests.cpp
  • Examples/Io/Root/src/RootAthenaDumpReader.cpp
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: merge-sentinel
🔇 Additional comments (5)
Core/include/Acts/Surfaces/BoundaryTolerance.hpp (2)

119-143: Clear and explicit, these factory methods are! Hmmmm.

A better way to create tolerance instances, this is. Self-documenting and intuitive, the interface has become.


168-177: Backward compatibility maintained while encapsulation improved, it has been.

Changed return types to parameter structs, yet stable interface preserved. Strong in the Force, this refactoring is!

Core/src/Surfaces/BoundaryTolerance.cpp (1)

22-31: Consistent with new parameter types, these changes are.

Simple and clear, the variant checks have become. Improved readability without sacrificing functionality, we have achieved.

Also applies to: 35-43

Tests/Benchmarks/AnnulusBoundsBenchmark.cpp (1)

59-62: More explicit and consistent, these initializations have become.

From brace to parentheses, the change flows. Explicit floating-point literals, clarity they bring.

Tests/UnitTests/Core/Surfaces/BoundaryToleranceTests.cpp (1)

42-46: Through accessor methods, the tests now flow. Hmmmm.

Properly validate the refactored implementation, these tests do. Strong test coverage, maintained it has been.

Also applies to: 59-62, 74-78, 94-101

Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

LGTM 👍

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants