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

samricotta · 2024-06-11T16:10:24Z

Description

Due to the large amount of tests for Dec I've split up the PR into each function for #20536

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-06-11T16:10:29Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Base branches to auto review (1)

main

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

alpe

Good progress. You found a lot of good test cases. Especially at the upper/lower exp borders.
I would love to remove the constraints at this stage to have simpler method signatures. Also rounding should be handled.
Not an easy task 💪

math/dec_test.go

math/dec.go

alpe

Good progress. 💪
We should change the notation to either 10^exp or use the 1e notation to be correct

math/dec_test.go

alpe · 2024-06-14T08:22:55Z

math/dec_test.go

 			require.NoError(t, gotErr)
-			assert.Equal(t, spec.exp, got)
+			assert.True(t, spec.exp.Equal(got))


👍 easier to read

math/dec.go

alpe

Very nice!
It would be good to remove the debug output and replace all 1^ by 1e notation.

alpe · 2024-06-14T11:59:37Z

math/dec_test.go

 	}
 	for name, spec := range specs {
 		t.Run(name, func(t *testing.T) {
 			got, gotErr := spec.x.Sub(spec.y)
-			if name == "precision too high: src exponent below limit" {
-				fmt.Println(spec.x, spec.y, spec.exp, got, gotErr)
+			if name == "1^-100000 - -1 -> 0.000..01" {


no debug output please. If you need more verbose failure messages, then it is is the best to add them to the assert lines.

TestSub for Dec

bb95ce4

samricotta assigned alpe Jun 11, 2024

samricotta requested a review from a team as a code owner June 11, 2024 16:10

samricotta changed the title ~~TestSub for Dec~~ feat(math):TestSub for Dec Jun 11, 2024

samricotta changed the title ~~feat(math):TestSub for Dec~~ feat(math): Testing Sub for GDA Dec Type Jun 11, 2024

alpe reviewed Jun 12, 2024

View reviewed changes

remove contraints

73d5fbc

alpe reviewed Jun 14, 2024

View reviewed changes

final updates

f126cff

alpe approved these changes Jun 14, 2024

View reviewed changes

samricotta added 2 commits June 14, 2024 18:06

Update dec_test.go

2f186be

remove debug

f9d113e

samricotta merged commit a67083e into sam/dec-type Jun 17, 2024
45 of 62 checks passed

samricotta deleted the sam/sub branch June 17, 2024 11:29

samricotta added a commit that referenced this pull request Jul 19, 2024

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

ed8ad41

alpe pushed a commit that referenced this pull request Sep 30, 2024

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

b6761ba

alpe pushed a commit that referenced this pull request Oct 27, 2024

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

e7113b3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

samricotta commented Jun 11, 2024 •

edited

Loading

coderabbitai bot commented Jun 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

alpe left a comment

alpe left a comment

alpe Jun 14, 2024

alpe left a comment

alpe Jun 14, 2024

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

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

Conversation

samricotta commented Jun 11, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Jun 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

alpe left a comment

Choose a reason for hiding this comment

alpe left a comment

Choose a reason for hiding this comment

alpe Jun 14, 2024

Choose a reason for hiding this comment

alpe left a comment

Choose a reason for hiding this comment

alpe Jun 14, 2024

Choose a reason for hiding this comment

samricotta commented Jun 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)