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

perf(math): Use Dec Bigintmut API #19479

Merged
merged 2 commits into from
Feb 19, 2024
Merged

perf(math): Use Dec Bigintmut API #19479

merged 2 commits into from
Feb 19, 2024

Conversation

ValarDragon
Copy link
Contributor

@ValarDragon ValarDragon commented Feb 19, 2024 •
edited by coderabbitai bot
Loading

Description

Minor speed improvements by using the BigIntMut API's, instead of Int.BigInt(), when safe.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Refactor
    • Optimized handling of large numbers by improving efficiency in mathematical operations within the app.

@ValarDragon ValarDragon requested a review from a team as a code owner February 19, 2024 14:49
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2024 •
edited
Loading

Walkthrough

Walkthrough

The update focuses on optimizing performance by shifting from immutable to mutable operations on big integers within the LegacyDec struct. This change aims to enhance efficiency by reducing the necessity of creating new instances during operations such as multiplication, division, rounding, and truncation.

Changes

File Summary
math/dec.go Replaced BigInt() calls with BigIntMut() in various methods of LegacyDec, impacting functions like LegacyNewDecFromIntWithPrec, MulIntMut, QuoIntMut, RoundInt, and TruncateInt. Optimized math.LegacyDec methods such as Ceil and MarshalTo, eliminating heap allocations involving math.Int. Improved overflow checks for math.Int and reduced heap allocations in math.NewLegacyDec. Notable optimizations in methods like Ceil, TruncateInt, and NewLegacyDecFromInt by eliminating heap allocations.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai bot reviewed Feb 19, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 52cca5f and f978fa5.
Files selected for processing (1)
  • math/dec.go (5 hunks)
Additional comments: 5
math/dec.go (5)
  • 135-135: The use of BigIntMut() in LegacyNewDecFromIntWithPrec introduces mutable behavior to the big integer operations. Ensure that the returned LegacyDec object is not unintentionally modified elsewhere in the code, as this could lead to hard-to-track bugs.
  • 354-354: Switching to BigIntMut() in MulIntMut for performance optimization is a good practice, assuming the LegacyDec object's mutability is well-documented and understood by users of this method. However, it's crucial to verify that this change does not introduce any unintended side effects, especially in concurrent environments.
  • 437-437: In QuoIntMut, replacing BigInt() with BigIntMut() could potentially improve performance. It's important to ensure that the mutable operation does not affect the integrity of the Int parameter's value in subsequent operations. Consider adding a comment to clarify that the Int parameter may be modified by this method.
  • 695-695: The use of BigIntMut() in RoundInt is appropriate for performance reasons. However, ensure that the non-mutative nature of chopPrecisionAndRoundNonMutative is clearly communicated to avoid confusion about the mutability of the operation.
  • 721-721: Similarly, in TruncateInt, employing BigIntMut() through chopPrecisionAndTruncateNonMutative is a sound optimization. It's essential to maintain clarity on the operation's non-mutative impact on the LegacyDec instance to prevent misuse.

coderabbitai[bot]
coderabbitai bot reviewed Feb 19, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between f978fa5 and 403ad99.
Files selected for processing (1)
  • math/CHANGELOG.md (1 hunks)
Additional comments: 1
math/CHANGELOG.md (1)
  • 48-48: The changelog entry for PR perf(math): Use Dec Bigintmut API #19479 is well-written and adheres to the guiding principles outlined at the beginning of the file. It clearly communicates the performance improvements made in the math.LegacyDec functions, enhancing readability and traceability for users and developers.

@julienrbrt julienrbrt changed the title perf: Use Dec Bigintmut API perf(math): Use Dec Bigintmut API Feb 19, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Feb 19, 2024
Merged via the queue into main with commit 72eae6d Feb 19, 2024
64 of 65 checks passed
@julienrbrt julienrbrt deleted the dev/dec_use_bigintmut_api branch February 19, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tac0turtle tac0turtle tac0turtle approved these changes

@alexanderbez alexanderbez alexanderbez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ValarDragon @alexanderbez @tac0turtle @julienrbrt