feat(math): Upstream GDA based decimal type #21982

alpe · 2024-09-30T11:33:00Z

Description

Rebased #20536
See: #11783

Rename (old legacy-) dec type to legacy_dec.go
Add new dec type based on github.com/cockroachdb/apd/v3

Left to do:

marshal/ unmarshal. See internal discussion
changelog
examples/ doc

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, you can find examples of the prefixes below:
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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

coderabbitai · 2024-09-30T11:33:12Z

Important

Review skipped

Draft detected.

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.

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.

math/dec_legacy.go

math/legacy_dec.go

+// get the precision multiplier, do not mutate result
+func precisionMultiplier(prec int64) *big.Int {
+	if prec < 0 {
+		panic(fmt.Sprintf("negative precision %v", prec))


math/legacy_dec.go

+	}
+
+	if prec > LegacyPrecision {
+		panic(fmt.Sprintf("too much precision, maximum %v, provided %v", LegacyPrecision, prec))


math/legacy_dec.go

+func (d LegacyDec) RoundInt64() int64 {
+	chopped := chopPrecisionAndRoundNonMutative(d.i)
+	if !chopped.IsInt64() {
+		panic("Int64() out of bound")


…20726)

Co-authored-by: Alexander Peters <[email protected]>

(cherry picked from commit bd4c5cb)

(cherry picked from commit 15fc0ef)

(cherry picked from commit 16f5b25)

(cherry picked from commit bf25586)

(cherry picked from commit 7ede82f)

github-actions bot added the C:x/group label Sep 30, 2024

alpe force-pushed the alex/sam/dec-type branch from 26f16eb to 40082ff Compare September 30, 2024 11:33

alpe changed the title ~~Alex/sam/dec type~~ feat(math): Upstream GDA based decimal type Sep 30, 2024

alpe force-pushed the alex/sam/dec-type branch from 40082ff to 7cae678 Compare September 30, 2024 11:44

github-advanced-security bot found potential problems Sep 30, 2024

View reviewed changes

math/dec_legacy.go Fixed Show fixed Hide fixed

math/dec_legacy.go Fixed Show fixed Hide fixed

math/dec_legacy.go Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Sep 30, 2024

View reviewed changes

samricotta and others added 23 commits October 27, 2024 10:14

update dec w benchmark testing

c4c8b95

fix version

8d22233

Update go.mod

cd60637

Create 18-decimal-handling.md

34b2fad

Update 18-decimal-handling.md

d14ccf0

update tests and convert func

61f9911

Update 18-decimal-handling.md

ed40cb7

Refactor constructors

6bdaf12

Add more numbers to quo benchmark

dee23ab

Apd v3 + sum benchmark

16e8812

More benchs

720e32b

Marshal/unmarshal

0e79c63

Fix test

a5fd0bc

x

0db4f9e

ip

346ab50

wip

c14cad0

quo, quo exact, table tests, multiply tests

720c7aa

feat(math): Testing Sub for GDA Dec Type (#20626)

e7113b3

feat(math): Upstream GDA based decimal type - Add function coverage (#…

1642e5c

…20726)

feat(math): Upstream GDA based decimal type testing (#20763)

a863f2f

feat(math): Upstream GDA based decimal type - errors (#20827)

7625193

Fix tests and minor refactoring (#20861)

eb13bab

feat(math): Upstream GDA based decimal type (docs) (#20950)

1672dcd

Co-authored-by: Alexander Peters <[email protected]>

samricotta and others added 14 commits October 27, 2024 10:14

Update 18-decimal-handling.md

1e0b1fc

Minor updates

863a99d

go mod tidy all

98bf126

Review comment

8939a9e

Rename legacy dec files

b751459

Linter only

3374cde

ip

c308720

Minor updates

04897a7

Minor updates

1a7440a

marshall/unmarshall

f6edee4

(cherry picked from commit bd4c5cb)

remove tests that are from deleted constraints

98bcf28

(cherry picked from commit 15fc0ef)

update godocs and add more tests

fa2d04a

(cherry picked from commit 16f5b25)

pure decimal changes

13c2a6e

(cherry picked from commit bf25586)

updates on using scientific notation

db76742

(cherry picked from commit 7ede82f)

alpe force-pushed the alex/sam/dec-type branch 3 times, most recently from f568601 to c28f9e8 Compare October 27, 2024 10:15

Godoc, refactorings, exclude un-/marshalling

26c746a

alpe force-pushed the alex/sam/dec-type branch from c28f9e8 to 26c746a Compare October 27, 2024 10:51

This was referenced Oct 27, 2024

feat (math): scientific notation un-/marshal format for the GDA dec type. #22379

Draft

feat (math): hybrid un-/marshal format for the GDA dec type. #22378

Draft

feat (math): binary un-/marshal format for the GDA dec type. #22377

Draft

alpe requested a review from aaronc October 30, 2024 09:15

github-prbot assigned aaronc Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(math): Upstream GDA based decimal type #21982

feat(math): Upstream GDA based decimal type #21982

alpe commented Sep 30, 2024 •

edited

Loading

coderabbitai bot commented Sep 30, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

feat(math): Upstream GDA based decimal type #21982

Are you sure you want to change the base?

feat(math): Upstream GDA based decimal type #21982

Conversation

alpe commented Sep 30, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Sep 30, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

alpe commented Sep 30, 2024 •

edited

Loading