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

refactor!: Use double for material #3862

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

refactor!: Use double for material #3862

wants to merge 7 commits into from
+427 −434

Conversation

andiwand
Copy link
Contributor

There is no good reason to use float for material properties and calculations, we just end up doing a bunch of float double conversions. The only good reason for float is to keep the storage low which is still the case with this PR.

@andiwand andiwand added this to the next milestone Nov 15, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 15, 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.

@github-actions github-actions bot added the Component - Core Affects the Core module label Nov 15, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 15, 2024 •
edited
Loading

📊: Physics performance monitoring for f3eba4e

Full contents

physmon summary

@andiwand andiwand marked this pull request as ready for review November 15, 2024 19:55
@andiwand
Copy link
Contributor Author

This seems to have some CPU implications
image
image

@andiwand
Copy link
Contributor Author

image image

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 17, 2024

Quality Gate Passed Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
80.6% Coverage on New Code
6.2% Duplication on New Code

See analysis details on SonarQube Cloud

@AJPfleger
Copy link
Contributor

I started to work on the same topic in

In a first attempt, I changed all instances as well but it messed up the tests. To understand, where the problem comes from, I believe it is necessary, to do it in smaller steps. (What I tried above, but still too course.)

Of course the problem lies in some rounding, since a lot of calculations are done in double but then stored as float. We need to understand which steps cause the changes in the output, since it is very likely, that we are doing some comparisons between floats which lead to different behaviour when looking at more digits. Therefore, we probably need to reintroduce some comparison operators or understand if we actually need to do those comparisons.

@andiwand
Copy link
Contributor Author

andiwand commented Nov 17, 2024 •
edited
Loading

I already adapted the tests here. I don't think we should change any == operators. Changing them breaks the interface. I would rather remove them as they are not very useful anyways.

@AJPfleger
Copy link
Contributor

Most of the unit tests are not an issue - that we need to compare to a double instead of a float is straight forward. But the physmon changes are complicated. Have you had time to analyse them?

Just a few examples:
Here we have shifts:
image
image
image

Here a lot of stuff going on:
image

We don't need to change the ==-operator, we could also change the place where it is used incorrectly. But I don't know if there is an actual case, where we use it, since I didn't get that far in my analysis yet :( Before changing anything, we need to understand, why it isfailing.

@andiwand
Copy link
Contributor Author

I don't think it is worth looking into these physmon changes in detail as there is no structure to it. They all look consistent to low stat fluctuations. We change how material interactions are numerically represented so such changes in physmon are expected.

I can check how easy it is to remove the == operators.

@andiwand andiwand mentioned this pull request Nov 23, 2024
Merged
@paulgessinger paulgessinger modified the milestones: next, v38.0.0 Nov 25, 2024
kodiakhq bot pushed a commit that referenced this pull request Nov 25, 2024
@andiwand
chore!: Clean some Material code (#3897)
c5391be 
Accumulated changed from #3862

- use namespaces in source files
- remove operator overloads (breaking)
- move some implementations to source
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AJPfleger AJPfleger Awaiting requested review from AJPfleger

Assignees
No one assigned
Labels
Component - Core Affects the Core module
Projects
None yet
Milestone
v38.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@andiwand @AJPfleger @paulgessinger