acts icon indicating copy to clipboard operation
acts copied to clipboard

refactor: modernise map utils

Open AJPfleger opened this issue 1 year ago • 2 comments

AJPfleger avatar Sep 16 '24 18:09 AJPfleger

📊: Physics performance monitoring for 5344454a278d79b77501a074ee811a4f914ff31c

Full contents

physmon summary

github-actions[bot] avatar Sep 16 '24 18:09 github-actions[bot]

Walkthrough

Enhance const-correctness and efficiency, the changes do. In BFieldMapUtils.hpp, function signatures updated, they were, to accept constant references, reducing unnecessary copies. A new function, getMinMaxAndBinCount, added to Helpers.hpp, it was, streamlining calculations of minimum and maximum values and unique bin counts. Refactoring in BFieldMapUtils.cpp and MaterialMapUtils.cpp replaced manual calculations with calls to this new utility function, improving code clarity and maintainability without altering core functionalities.

Changes

File Path Change Summary
Core/include/Acts/MagneticField/BFieldMapUtils.hpp Function signatures updated to use const references for parameters in fieldMapRZ, fieldMapXYZ, and solenoidFieldMap, enhancing const-correctness.
Core/include/Acts/Utilities/Helpers.hpp New inline function getMinMaxAndBinCount added in namespace detail to compute minimum, maximum, and unique bin counts from a vector of doubles.
Core/src/MagneticField/BFieldMapUtils.cpp Refactored to use detail::getMinMaxAndBinCount for calculating min/max values and bin counts. Replaced Acts::Vector2 and Acts::Vector3 with Vector2 and Vector3. Simplified logic for grid creation and error handling, improving code clarity while maintaining functionality.
Core/src/Material/MaterialMapUtils.cpp Refactored materialMapperRZ and materialMapperXYZ to use detail::getMinMaxAndBinCount for min/max and bin count calculations. Declared nIndices outside loops for clarity. Adjusted comments for clarity without changing overall logic.

Poem

In the code where functions dwell,
Const-correctness rings a bell.
With min and max now calculated,
Clarity and ease celebrated.
Refactored paths, a joyful sight,
Efficiency shines, oh what delight! 🌟


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.

coderabbitai[bot] avatar Nov 10 '24 07:11 coderabbitai[bot]

:white_check_mark: Athena integration test results [bf997eb640537c9d91f0ee7f54e95216a680a98a]

:white_check_mark: All tests successful

status job report
:green_circle: report_pull_request
:green_circle: run_workflow_tests_run4_mc
:green_circle: run_workflow_tests_run2_mc
:green_circle: run_workflow_tests_run2_data
:green_circle: run_workflow_tests_run3_mc
:green_circle: run_workflow_tests_run3_data
:green_circle: test_ActsDumpGeometryIdentifiers
:green_circle: test_ActsCheckObjectCountsWorkflowHgtd
:green_circle: test_ActsCheckObjectCountsCachedWorkflow
:green_circle: test_ActsCheckObjectCountsWorkflow
:green_circle: test_ActsEFTrackFit
:green_circle: test_ActsPersistifySeeds
:green_circle: test_ActsBenchmarkWithSpot
:green_circle: test_ActsAnalogueClustering
:green_circle: test_ActsWorkflowHeavyIons
:green_circle: test_ActsWorkflowFastTracking
:green_circle: test_ActsWorkflowCached
:green_circle: test_ActsWorkflow
:green_circle: test_ActsValidateAmbiguityResolution
:green_circle: test_ActsValidateResolvedTracks
:green_circle: test_ActsValidateTracks
:green_circle: test_ActsValidateActsCoreSpacePoints
:green_circle: test_ActsValidateActsSpacePoints
:green_circle: test_ActsValidateSeeds
:green_circle: test_ActsValidateOrthogonalSeeds
:green_circle: test_ActsValidateClusters
:green_circle: test_ActsPersistifyEDM
:green_circle: test_ActsGSFRefitting
:green_circle: test_ActsKfRefitting
:green_circle: test_ActsExtrapolationAlgTest
:green_circle: test_ActsITkTest

acts-project-service avatar Dec 02 '24 15:12 acts-project-service