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.

Sign up for GitHub

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

Jump to bottom

ci: Add check for mathematical constants (no macros) #3774

Merged
merged 5 commits into from
Nov 11, 2024
Merged

ci: Add check for mathematical constants (no macros) #3774

merged 5 commits into from
Nov 11, 2024

Conversation

AJPfleger
Copy link
Contributor

@AJPfleger AJPfleger commented Oct 23, 2024 •
edited
Loading

The firstly intended clang tidy check modernize-use-std-numbers is not suited for us:

  • it doesn't flag macros like M_PI
  • it flags values in our tables that get close to constants, which have a different basis.

benefit would have been to detect cases like static_cast<float>(std::numbers::pi) instead of std::numbers::pi_v<float> or usages of std::sqrt(2.) instead of std::numbers::sqrt2.

The updated test now checks for the classical M_* macros that could be accidentally used.

blocked:

@AJPfleger AJPfleger added the 🚧 WIP Work-in-progress label Oct 23, 2024
@AJPfleger AJPfleger added this to the next milestone Oct 23, 2024
@github-actions github-actions bot added the Infrastructure Changes to build tools, continous integration, ... label Oct 23, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 23, 2024 •
edited
Loading

📊: Physics performance monitoring for 3fe1406

Full contents

physmon summary

@AJPfleger AJPfleger marked this pull request as draft October 23, 2024 12:52
@AJPfleger AJPfleger changed the title ci: Add clang-tidy check for mathematical constants ci: Add check for mathematical constants (no macros) Oct 24, 2024
@AJPfleger AJPfleger added 🛑 blocked This item is blocked by another item and removed 🚧 WIP Work-in-progress labels Oct 24, 2024
@AJPfleger AJPfleger mentioned this pull request Nov 5, 2024
Merged
@CarloVarni
Copy link
Collaborator

Hi @AJPfleger Is this test simply complaining or is it also trying to replace the code? In the latter case I have some concern since you may have to decide between (e.g.) std::numbers::pi_v<float> and std::numbers::pi_v<double> and std::numbers::pi

@AJPfleger
Copy link
Contributor Author

It has a way to fix misused macros. As everything in ACTS, no changes are made without a proper PR. Since we don't have any cases of the macros anymore, they could only be introduced over new PRs.

The author could attempt a quick fix using --fix. If it uses the wrong type, it would then need to slip by the author and the reviewer. In that case it is still a double, which would be the same type as the macro, which would also have slipped through.

So, I don't really see a worsening of the situation.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 11, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • coderabbit

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

@AJPfleger AJPfleger marked this pull request as ready for review November 11, 2024 06:22
@AJPfleger AJPfleger removed the 🛑 blocked This item is blocked by another item label Nov 11, 2024
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 11, 2024

Quality Gate Passed Quality Gate passed

Issues
0 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 SonarCloud

@kodiakhq kodiakhq bot merged commit 54d61d4 into acts-project:main Nov 11, 2024
47 checks passed
@acts-project-service
Copy link
Collaborator

✅ Athena integration test results [54d61d4]

✅ All tests successful

status job report
🟢 report_pull_request
🟢 run_art_test: test_run4_acts_vertex_PU200
🟢 run_art_test: test_run4_ttbar_PU200
🟢 run_art_test: test_data18_13TeV_1000evt
🟢 run_art_test: test_ttbarPU40_reco
🟢 run_workflow_tests_run4_mc
🟢 run_workflow_tests_run2_mc
🟢 run_workflow_tests_run2_data
🟢 run_workflow_tests_run3_mc
🟢 run_workflow_tests_run3_data
🟢 test_ActsDumpGeometryIdentifiers
🟢 test_ActsCheckObjectCountsCachedWorkflow
🟢 test_ActsCheckObjectCountsWorkflow
🟢 test_ActsEFTrackFit
🟢 test_ActsPersistifySeeds
🟢 test_ActsBenchmarkWithSpot
🟢 test_ActsAnalogueClustering
🟢 test_ActsWorkflowHeavyIons
🟢 test_ActsWorkflowFastTracking
🟢 test_ActsWorkflowCached
🟢 test_ActsWorkflow
🟢 test_ActsValidateAmbiguityResolution
🟢 test_ActsValidateResolvedTracks
🟢 test_ActsValidateTracks
🟢 test_ActsValidateActsCoreSpacePoints
🟢 test_ActsValidateActsSpacePoints
🟢 test_ActsValidateSeeds
🟢 test_ActsValidateOrthogonalSeeds
🟢 test_ActsValidateClusters
🟢 test_ActsPersistifyEDM
🟢 test_ActsGSFRefitting
🟢 test_ActsKfRefitting
🟢 test_ActsExtrapolationAlgTest
🟢 test_ActsITkTest
🟢 run_unit_tests

@AJPfleger AJPfleger deleted the clang-tidy-numbers branch November 11, 2024 15:18
Rosie-Hasan pushed a commit to Rosie-Hasan/acts that referenced this pull request Nov 13, 2024
@AJPfleger @Rosie-Hasan
ci: Add check for mathematical constants (no macros) (acts-project#3774)
c1593c5 
The firstly intended clang tidy check `modernize-use-std-numbers` is not suited for us:
- it doesn't flag macros like `M_PI`
- it flags values in our tables that get close to constants, which have a different basis.

benefit would have been to detect cases like `static_cast<float>(std::numbers::pi)` instead of `std::numbers::pi_v<float>` or usages of `std::sqrt(2.)` instead of `std::numbers::sqrt2`.

The updated test now checks for the classical `M_*` macros that could be accidentally used.

blocked:
- acts-project#3781
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CarloVarni CarloVarni CarloVarni approved these changes

Assignees
No one assigned
Labels
Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Milestone
next
Development

Successfully merging this pull request may close these issues.
3 participants
@AJPfleger @CarloVarni @acts-project-service