refact: Color.gammaToLinearSpace to improve performance, speed increased by 7 times.

chenyunda218 commented 1 month ago

Please check if the PR fulfills these requirements

[x] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

refactor function for enhance performance.

What is the current behavior? (You can also link to an open issue here)

Color.gammaToLinearSpace is so many branch cause break cpu Branch predictor.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

There is about 3e-11 in the precision of floating point numbers between two version.

Summary by CodeRabbit

New Features
- Introduced new static properties for improved color calculations.
- Added a sigmoid method for normalizing values between 0 and 1.
Improvements
- Enhanced the gammaToLinearSpace method for more efficient calculations, eliminating previous conditional checks.

coderabbitai[bot] commented 1 month ago

Walkthrough

The Color class in packages/math/src/Color.ts has been updated to include three new static properties and a static method. The properties store sigmoid function results, while the gammaToLinearSpace method has been restructured to use these properties for calculations instead of previous conditional logic. A new static method, sigmoid, normalizes input values using the sigmoid function, enhancing the functionality of the gammaToLinearSpace method without altering existing method signatures or class structure.

Changes

File Path	Change Summary
packages/math/src/Color.ts	- Added static properties: `gammaToLinearSpaceBranchNumber_0`, `gammaToLinearSpaceBranchNumber_0_04045`, `gammaToLinearSpaceBranchNumber_1` - Added static method: `sigmoid(num: number): number` - Restructured `gammaToLinearSpace` method to utilize new properties and method.

Possibly related PRs

2389: This PR modifies the Color class in Color.ts, specifically affecting the gammaToLinearSpace method, which is also a focus of the main PR's changes.

Suggested reviewers

luzhuang
GuoLei1990

Poem

In the realm of colors bright,
New properties take flight,
With sigmoid's gentle grace,
Transforming every space.
Math's magic, clear and true,
A vibrant world anew! 🌈✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between c43841545a47a2d603de92f919526f0062948dfd and c2e7613c4439d2bf1a773dee460f33892c16975a.

📒 Files selected for processing (1)

* packages/math/src/Color.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* packages/math/src/Color.ts

--- 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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.49%. Comparing base (e8e8090) to head (c2e7613).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2406 +/- ## ========================================== + Coverage 69.48% 69.49% +0.01% ========================================== Files 522 522 Lines 27356 27362 +6 Branches 4096 4093 -3 ========================================== + Hits 19009 19016 +7 + Misses 6847 6846 -1 Partials 1500 1500 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2406/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/galacean/engine/pull/2406/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `69.49% <100.00%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

GuoLei1990 commented 1 month ago

The PR has lint errors, you can fix them with lint --fix

chenyunda218 commented 4 weeks ago

The PR has lint errors, you can fix them with lint --fix

Thanks, I've fixed it.

GuoLei1990 commented 3 weeks ago

After detailed testing, it was found that this PR actually caused performance degradation. The case is as follows: https://jsbench.me/vqm2u50u6r/1 Can you confirm whether it can be improved?

We are happy for you to submit PRs and hope you can continue to contribute！

chenyunda218 commented 3 weeks ago

After my testing. it depending on runtime. In nodejs the new one faster. In chrome same. Other runtime is slower. So i think it is not a good refactor. Apologize for my negligence.

GuoLei1990 commented 3 weeks ago

After my testing. it depending on runtime. In nodejs the new one faster. In chrome same. Other runtime is slower. So i think it is not a good refactor. Apologize for my negligence.

The impact of the environment on performance is indeed complex! Welcome to join us, we can keep in touch with issues and PRs!

galacean / engine