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: Ensure correct order of uniform distribution limits #3976

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

benjaminhuth
Copy link
Member

@benjaminhuth benjaminhuth commented Dec 11, 2024

Pulled out of #3759

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced validation for direction generation parameters to ensure they are within acceptable ranges.
    • Adjusted calculations for cosine and eta values to align with the properties of the cosine function.
  • Tests

    • Modified random distribution ranges in unit tests for the CylinderVolumeBuilder to improve test coverage and accuracy.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

Changes made to GenerateParameters.hpp enhance the generateBoundDirection function by adding assertions for thetaMin and thetaMax, ensuring they are within valid ranges. The calculations for cosThetaMin, cosThetaMax, etaMin, and etaMax have been reversed to align with the properties of the cosine function. In CylinderVolumeBuilderTests.cpp, adjustments to random distribution ranges in unit tests were made, preserving the overall test structure while altering specific parameters.

Changes

File Path Change Summary
Core/include/Acts/EventData/detail/GenerateParameters.hpp Added assertions for thetaMin and thetaMax; reversed calculations for cosThetaMin, cosThetaMax, etaMin, and etaMax.
Tests/UnitTests/Core/Geometry/CylinderVolumeBuilderTests.cpp Altered ranges of random distributions in several unit tests, maintaining overall test structure.

Possibly related PRs

  • refactor: FPE safe eta/theta conversion #3788: The changes in this PR involve modifications to the etaFromTheta and thetaFromEta functions, which are directly related to the adjustments made in the generateBoundDirection function in the main PR, as both involve the handling of theta and eta parameters.

Suggested labels

Component - Core, automerge

In the depths of code, a change was made,
Bound directions refined, no need to be afraid.
With assertions in place, and logic anew,
The tests now dance with distributions true.
A journey of parameters, in harmony they flow,
In the realm of coding, watch the brilliance grow! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6c910a6 and d01c142.

📒 Files selected for processing (2)
  • Core/include/Acts/EventData/detail/GenerateParameters.hpp (1 hunks)
  • Tests/UnitTests/Core/Geometry/CylinderVolumeBuilderTests.cpp (3 hunks)
🔇 Additional comments (3)
Core/include/Acts/EventData/detail/GenerateParameters.hpp (2)

105-118: Correct, the order of cosine bounds is, hmm!

Wise changes these are! For monotonically decreasing cosine function between [0,π], reversed the bounds we have. Prevent incorrect sampling from uniform distribution, this does. Strong with the Force, these assertions are!


121-122: Balanced, the eta calculations now are!

Reversed the eta bounds we have, maintaining harmony with theta they do. Inverse relationship between eta and theta, respected it is!

Tests/UnitTests/Core/Geometry/CylinderVolumeBuilderTests.cpp (1)

25-25: Fixed, the order of distribution bounds is!

In all test cases, corrected the uniform distribution ranges we have. From (-11., -15.) to (-15., -11.) they changed, ensuring valid sampling they do. Follows the ways of mathematics, this does, where lower bound must precede upper bound.

Also applies to: 117-117, 288-288


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. (Experiment)
  • @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 11, 2024
@github-actions github-actions bot added Component - Core Affects the Core module Event Data Model labels Dec 11, 2024
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.

Nice catch - Thanks!

Copy link

📊: Physics performance monitoring for d01c142

Full contents

physmon summary

@kodiakhq kodiakhq bot merged commit 08a3953 into acts-project:main Dec 11, 2024
46 checks passed
@acts-project-service acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Dec 11, 2024
@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 Event Data Model Fails Athena tests This PR causes a failure in the Athena tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants