Add Text.to_decimal #10874
Merged
Add Text.to_decimal #10874
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GregoryTravis
commented
Aug 22, 2024
| Convert this `Text` to a `Decimal`. | ||
|
|
||
| Arguments: | ||
| - scale: the optional Decimal scale to use. See `Decimal.set_scale` for more |
There was a problem hiding this comment.
Do we have a way to link directly to other parts of our documentation?
There was a problem hiding this comment.
Not really at the moment.
We should use the Markdown syntax and could pick up in the website version and then think about adding to the doc panel as well.
GregoryTravis
requested review from
jdunkerley,
radeusgd,
AdRiley and
marthasharkey
as code owners
jdunkerley
approved these changes
Aug 23, 2024
| Convert this `Text` to a `Decimal`. | ||
|
|
||
| Arguments: | ||
| - scale: the optional Decimal scale to use. See `Decimal.set_scale` for more |
There was a problem hiding this comment.
Not really at the moment.
We should use the Markdown syntax and could pick up in the website version and then think about adding to the doc panel as well.
radeusgd
approved these changes
Aug 23, 2024
radeusgd
reviewed
Aug 23, 2024
Comment on lines
+1161
to
+1206
| ## ADVANCED | ||
| GROUP Math | ||
| ICON math | ||
| Change the scale of a Decimal. | ||
|
|
||
| A `Decimal` value is represented internally by a Java `BigInteger` "unscaled | ||
| value" and a "scale value". The numerical value of the `Decimal` is | ||
| `(unscaledValue * 10^(-scale))`. Scale values are maintained automatically by | ||
| the constructors and numerical operations, but can also be set explicitly. | ||
|
|
||
| Scale values can allow distinctions between values that would be identical as | ||
| `Float`s. For example, the following values have different internal | ||
| representations: | ||
|
|
||
| a = Decimal.new "2.0" | ||
| b = Decimal.new "2.00" | ||
| a == b | ||
| # => True | ||
|
|
||
| These two values have different internal representations, but they are still | ||
| considered the same value by `==`. | ||
|
|
||
| ! Error Conditions | ||
|
|
||
| - If an explicit `scale` parameter is passed, and the scale is not | ||
| large enough to represent the number exactly, an `Arithmetic_Error` | ||
| is thrown. | ||
|
|
||
| > Example | ||
| Set the scale of a `Decimal` | ||
|
|
||
| d = dec "23.456" set_scale 4 | ||
| d.internal_representation | ||
| # => [234560, 6, 4] | ||
|
|
||
| > Example | ||
| Get an error when using a scale that is too small. | ||
| (A scale of 2 is not enough to represent three decimal places.) | ||
|
|
||
| dec "23.456" set_scale 2 | ||
| # => Arithmetic_Error | ||
| set_scale : Integer -> Decimal | ||
| set_scale self new_scale:Integer -> Decimal = | ||
| handle_java_exception <| | ||
| if self.scale == new_scale then self else | ||
| Decimal.Value (self.big_decimal.setScale new_scale) |
There was a problem hiding this comment.
Curious: what is the use-case for making set_scale public?
There was a problem hiding this comment.
Since Text.to_decimal exposes the scale parameter, it makes sense to be consistent and expose this as well.
GregoryTravis
added
the
CI: Ready to merge
GregoryTravis
added
CI: Ready to merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Add
Text.to_decimal.Also makes renames
Decimal.with_scaletoset_scaleand makes it public.Checklist
Please ensure that the following checklist has been satisfied before submitting the PR:
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.