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

document Grisu #27808

Merged
merged 1 commit into from
Jul 2, 2018
Merged

document Grisu #27808

merged 1 commit into from
Jul 2, 2018

Conversation

simonbyrne
Copy link
Contributor

No description provided.

@simonbyrne simonbyrne added the docs This change adds or pertains to documentation label Jun 26, 2018
@simonbyrne simonbyrne requested a review from quinnj June 27, 2018 15:49
@@ -26,6 +26,29 @@ include("grisu/bignum.jl")

const BIGNUMS = [Bignums.Bignum(),Bignums.Bignum(),Bignums.Bignum(),Bignums.Bignum()]

"""
(len, point, neg) = Grisu.grisu(v::AbstractFloat, mode, requested_digits,
buffer=DIGITSs[Threads.threadid()], bignums=BIGNUMS)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be updated for #27826?

- `Grisu.FIXED`: round to `requested_digits` digits.
- `Grisu.PRECISION`: round to `requested_digits` significant digits.

`bignums` are used internally as part of the correction step.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

buffer and bignums?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mention above that buffer is used to output the digits

@simonbyrne
Copy link
Contributor Author

I tweaked the documentation order to be inputs then outputs.

@simonbyrne simonbyrne merged commit 72bfe8b into master Jul 2, 2018
@simonbyrne simonbyrne deleted the sb/grisu-doc branch July 2, 2018 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants