Float documentation and unit tests #455
Merged
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
|
+1 on having an equal with |
kentosugama
reviewed
Dec 15, 2022
kentosugama
reviewed
Dec 15, 2022
|
Woah that is a huge test file! :) |
Co-authored-by: Kento Sugama <[email protected]>
…ty/motoko-base into luc/improve_float_test_doc
crusso
approved these changes
Jan 2, 2023
| /// | ||
| /// Float.neq(1.23) // => -1.23 | ||
| /// ``` | ||
| public func neq(x : Float) : Float { -x }; // Typo: Should be changed to `neg` |
There was a problem hiding this comment.
indeed. I guess we could deprecate neq and add neg (but also in a separate PR)
There was a problem hiding this comment.
I will prepare that in a separate PR. Good idea to deprecate the misspelled function.
kentosugama
reviewed
Jan 3, 2023
|
LGTM! Super thorough |
Co-authored-by: Kento Sugama <[email protected]>
|
Thanks a lot @crusso and @kentosugama for the review of this PR (with this huge unit test file). |
ggreif
pushed a commit
that referenced
this pull request
Jan 5, 2023
Improve `Float.mo`: * Documentation * Unit tests Issues detected while refactoring: * dfinity/motoko#3646 * dfinity/motoko#3647 Other possible areas of improvements for `Float`: * `isNaN()` function is missing * `equals()` comparison should consider numerical errors, by requiring an epsilon argument. * Positive infinity and negative infinity constants are missing. * `compare` function does not have a total order and is inconsistent, e.g. `compare(NaN, NaN) == #greater`. * `neq` function has a typo. Rename to `neg` The suggestions for improvement are summarized in issue #456
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.
Improve
Float.mo:Issues detected while refactoring:
nan(not a number) floating point representation with a negative sign onwasmtime. motoko#3647Other possible areas of improvements for
Float:isNaN()function is missingequals()comparison should consider numerical errors, by requiring an epsilon argument.comparefunction does not have a total order and is inconsistent, e.g.compare(NaN, NaN) == #greater.neqfunction has a typo. Rename tonegThe suggestions for improvement are summarized in issue #456