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.

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

toBigInt should round identically for Double and BigDecimal (backport #3921) #3925

Open
wants to merge 1 commit into
base: 3.6.x
Choose a base branch
from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 12, 2024

This is an automatic backport of pull request #3921 done by Mergify.
Cherry-pick of b9f5703 has failed:

On branch mergify/bp/3.6.x/pr-3921
Your branch is up to date with 'origin/3.6.x'.

You are currently cherry-picking commit b9f57032b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   core/src/main/scala/chisel3/Num.scala
	both modified:   src/test/scala/chiselTests/LiteralExtractorSpec.scala

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com


Original PR Body

This very minor PR fixes a bug in Num.toBigInt(x: BigDecimal, binaryPoint: Int).

The current function gives the impression to round the input BigDecimal:

val result = (x * multiplier).rounded.toBigInt

However:

BigDecimal(1.4).rounded.toBigInt // : BigInt = 1
BigDecimal(1.5).rounded.toBigInt // : BigInt = 1
BigDecimal(1.6).rounded.toBigInt // : BigInt = 1

I'm assuming this is not the intended behaviour.

The underlying issue is with the rounded function which uses the BigDecimal's MathContext. I changed this to use setScale(0) instead.

I added a testcase for rounding positive numbers. I would've added a testcase for negative ones, but as far as I know there is no RoundingMode that replicates the rounding of Doubles there (round half to positive infinity).

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Bugfix

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
(cherry picked from commit b9f5703)

# Conflicts:
#	core/src/main/scala/chisel3/Num.scala
#	src/test/scala/chiselTests/LiteralExtractorSpec.scala
@mergify mergify bot added Backport Automated backport, please consider for minor release bp-conflict labels Mar 12, 2024
Copy link
Contributor Author

mergify bot commented Mar 12, 2024

Cherry-pick of b9f5703 has failed:

On branch mergify/bp/3.6.x/pr-3921
Your branch is up to date with 'origin/3.6.x'.

You are currently cherry-picking commit b9f57032b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   core/src/main/scala/chisel3/Num.scala
	both modified:   src/test/scala/chiselTests/LiteralExtractorSpec.scala

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@github-actions github-actions bot added the Bugfix Fixes a bug, will be included in release notes label Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport Automated backport, please consider for minor release bp-conflict Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant