perf(math): Significantly speedup Dec quo truncate and quo Roundup #20034

ValarDragon · 2024-04-13T11:32:53Z

Significantly speedsup Dec.QuoTruncate and Dec.QuoRoundUp.

This is state compatible, as Quo is always floor division. note that QuoRem is ~no overhead relative to Quo in the big.Int implementation for large words (which all Dec's in practice are) We have tested state compatability for this optimization on Osmosis' BigDec, which is the same implementation.

The speedup shown in the benchmark uses small values, the impact is much larger at larger values. (So a benchmark with bigger numbers would boast better speeds) (I also corrected the benchmark, before it would just be doing 0/b2 in the benchmark).

Performance on this small input (again impact much higher at real numbers we see) is already 33% improvement:
OLD perf on new benchmark code:

BenchmarkLegacyQuoTruncateMut-12         3642235               380.0 ns/op           152 B/op          3 allocs/op
BenchmarkLegacyQuoRoundupMut-12          3914364               387.6 ns/op           152 B/op          3 allocs/op

NEW:

BenchmarkLegacyQuoTruncateMut-12         6173737               216.9 ns/op            64 B/op          1 allocs/op
BenchmarkLegacyQuoRoundupMut-12          4863044               234.2 ns/op            64 B/op          1 allocs/op

Correctness of this is covered by existing tests. (And tested on Osmosis mainnet syncs for BigDecimal)

Summary by CodeRabbit

Refactor
- Enhanced precision and rounding logic in decimal operations for improved accuracy.
Tests
- Updated benchmarks in decimal operations to ensure accurate and independent calculations.

coderabbitai · 2024-04-13T11:32:59Z

Walkthrough

The recent updates focus on optimizing decimal operations by refining precision multiplication and rounding logic. Benchmark tests have also been enhanced for better accuracy and independence of calculations.

Changes

Files	Changes Summary
`math/dec.go`	Updated multiplication logic and rounding in `QuoTruncateMut` and `QuoRoundupMut` functions.
`math/dec_test.go`	Adjusted benchmarks to ensure independent calculations by using a base array for cloning in tests.
`math/CHANGELOG.md`	Implemented speedup for `LegacyDec.QuoTruncate` and `LegacyDec.QuoRoundUp` in the `cosmos-sdk`.

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 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

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

Actionable comments posted: 2

coderabbitai · 2024-04-13T11:41:50Z

math/CHANGELOG.md

@@ -36,6 +36,8 @@ Ref: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.j

 ## [Unreleased]

+* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speedup LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.


Correct the spelling of "speedup" to "speed up" as it should be two words when used as a verb.

- Significantly speedup LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp. + Significantly speed up LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speedup LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.

* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speed up LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.

Add a space after the period to separate the sentences properly.

- Significantly speed up LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.## [math/v1.3.0](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.3.0) - 2024-02-22 + Significantly speed up LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp. ## [math/v1.3.0](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.3.0) - 2024-02-22

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speedup LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.

* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speed up LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp. ## [math/v1.3.0](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.3.0) - 2024-02-22

alpe

Thanks for the PR! Very nice work but the behaviour in QuoRoundupMut is different now for negative numbers.

alpe · 2024-04-16T09:12:04Z

math/dec.go

-	// multiply precision twice
-	d.i.Mul(d.i, squaredPrecisionReuse)
+	// multiply precision once
+	d.i.Mul(d.i, precisionReuse)


Although it was using higher precision before, the additional numbers where just cropped. Good finding!

alpe · 2024-04-16T09:48:37Z

math/dec.go

@@ -418,10 +417,12 @@ func (d LegacyDec) QuoRoundUp(d2 LegacyDec) LegacyDec {
 // QuoRoundupMut mutable quotient, round up
 func (d LegacyDec) QuoRoundupMut(d2 LegacyDec) LegacyDec {
 	// multiply precision twice
-	d.i.Mul(d.i, squaredPrecisionReuse)
-	d.i.Quo(d.i, d2.i)
+	d.i.Mul(d.i, precisionReuse)


nit: the code comment is not correct anymore

math/dec.go

alpe · 2024-04-16T10:00:19Z

math/dec_test.go

 	b2 := math.LegacyNewDec(4371)
 	b.ReportAllocs()
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		sink = b1.QuoTruncateMut(b2)
+		sink = baseArr[i].QuoTruncateMut(b2)


good fix. Do you want to add more number examples to support your cases? You could run them via
b.Run("", func(b *testing.B) {}) like table tests

ValarDragon · 2024-04-16T11:25:21Z

Good catch for negative numbers!

tac0turtle · 2024-04-25T07:38:59Z

gentle ping @ValarDragon

github-actions · 2024-05-26T00:05:55Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

…undUp

alpe

I have added more test cases and coverage for QuoTruncateMut to the branch. All succeeded with the old version, too so that we have confidence that the changes don't break existing behaviour

testinginprod

LGTM!

* main: feat(server/v2): introduce cometbft v2 (#20483) refactor(x/upgrade): migrate to appmodule.VersionMap (#20485) docs: code guidelines changes (#20482) feat(cosmovisor): load cosmovisor configuration from toml file (#19995) perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034) fix: Bump CometBFT versions (#20481)

* main: (120 commits) chore: update protoc-gen-swagger to protoc-gen-openapiv2 (#20448) ci: Add GitHub Action for go mod tidy and mocks (#20501) chore: Address linter issues (#20486) fix: wrap errors in auto CLI service registration (#20493) chore: fix comment (#20498) chore: fix the note box syntax error (#20499) feat(server/v2): introduce cometbft v2 (#20483) refactor(x/upgrade): migrate to appmodule.VersionMap (#20485) docs: code guidelines changes (#20482) feat(cosmovisor): load cosmovisor configuration from toml file (#19995) perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034) fix: Bump CometBFT versions (#20481) refactor(core): remove redundant ExecMode (#20322) feat(store/v2): pruning manager (#20430) chore: force reload sonar cloud (#20480) refactor(x/accounts): reuse calculated sum in `func safeAdd` (#20458) refactor: remove `defer` in loop (#20223) ci: remove livness test (#20474) build(deps): Bump bufbuild/buf-setup-action from 1.32.1 to 1.32.2 (#20477) chore: migrate a few diagrams to mermaid (#20473) ...

Significantly speedup quo truncate and quo Roundup

7042594

ValarDragon requested a review from a team as a code owner April 13, 2024 11:32

This comment has been minimized.

Sign in to view

ValarDragon changed the title ~~Significantly speedup Dec quo truncate and quo Roundup~~ perf: Significantly speedup Dec quo truncate and quo Roundup Apr 13, 2024

Changelog

8112297

coderabbitai bot reviewed Apr 13, 2024

View reviewed changes

ValarDragon mentioned this pull request Apr 13, 2024

Remove duplicated one minus spread factor calculations osmosis-labs/osmosis#8040

Merged

tac0turtle assigned testinginprod Apr 14, 2024

julienrbrt changed the title ~~perf: Significantly speedup Dec quo truncate and quo Roundup~~ perf(math): Significantly speedup Dec quo truncate and quo Roundup Apr 15, 2024

alpe requested changes Apr 16, 2024

View reviewed changes

mergify bot mentioned this pull request Apr 17, 2024

Remove duplicated one minus spread factor calculations (backport #8040) osmosis-labs/osmosis#8066

Merged

github-actions bot added the Stale label May 26, 2024

tac0turtle removed the Stale label May 27, 2024

tac0turtle and others added 2 commits May 28, 2024 22:22

Merge branch 'main' into dev/significantly_speedup_quoTrunc_and_quoRo…

c4b9ccd

…undUp

address some comments

7c77d21

tac0turtle force-pushed the dev/significantly_speedup_quoTrunc_and_quoRoundUp branch from 809884a to 7c77d21 Compare May 28, 2024 20:30

tac0turtle and others added 2 commits May 29, 2024 10:40

fix error

354f9d4

Merge branch 'main' into dev/significantly_speedup_quoTrunc_and_quoRo…

78291ed

…undUp

tac0turtle requested a review from alpe May 29, 2024 13:25

tac0turtle assigned alpe May 29, 2024

alpe added 2 commits May 30, 2024 10:03

Add more test cases to quo

8afb2fa

Parallel test execution

b89d2a4

alpe approved these changes May 30, 2024

View reviewed changes

testinginprod approved these changes May 30, 2024

View reviewed changes

tac0turtle added this pull request to the merge queue May 30, 2024

Merged via the queue into main with commit 90cbb02 May 30, 2024
63 of 64 checks passed

tac0turtle deleted the dev/significantly_speedup_quoTrunc_and_quoRoundUp branch May 30, 2024 10:55

coderabbitai bot mentioned this pull request Jan 6, 2025

chore: prep collections v1 and api v0.8.0 #23198

Merged

12 tasks

This comment was marked as spam.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf(math): Significantly speedup Dec quo truncate and quo Roundup #20034

perf(math): Significantly speedup Dec quo truncate and quo Roundup #20034

ValarDragon commented Apr 13, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 13, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

This comment has been minimized.

coderabbitai bot left a comment

coderabbitai bot Apr 13, 2024

This comment was marked as spam.

alpe left a comment

alpe Apr 16, 2024

This comment was marked as spam.

alpe Apr 16, 2024

alpe Apr 16, 2024

ValarDragon commented Apr 16, 2024

tac0turtle commented Apr 25, 2024

github-actions bot commented May 26, 2024

alpe left a comment

testinginprod left a comment

This comment was marked as spam.

		@@ -36,6 +36,8 @@ Ref: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.j

		## [Unreleased]

		* [#20034](https://github.com/cosmos/cosmos-sdk/pull/20034) Significantly speedup LegacyDec.QuoTruncate and LegacyDec.QuoRoundUp.

perf(math): Significantly speedup Dec quo truncate and quo Roundup #20034

perf(math): Significantly speedup Dec quo truncate and quo Roundup #20034

Conversation

ValarDragon commented Apr 13, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 13, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

This comment has been minimized.

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 13, 2024

Choose a reason for hiding this comment

This comment was marked as spam.

alpe left a comment

Choose a reason for hiding this comment

alpe Apr 16, 2024

Choose a reason for hiding this comment

This comment was marked as spam.

alpe Apr 16, 2024

Choose a reason for hiding this comment

alpe Apr 16, 2024

Choose a reason for hiding this comment

ValarDragon commented Apr 16, 2024

tac0turtle commented Apr 25, 2024

github-actions bot commented May 26, 2024

alpe left a comment

Choose a reason for hiding this comment

testinginprod left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

ValarDragon commented Apr 13, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 13, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)