Fixed inconsistency between the RealField::min_value docs and functionality. #65
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
The docs for the function state "The smallest finite positive value representable using this type.", but f32::MIN & f64::MIN are both the smallest values representable(and are thus negative). It appears impl_real! is only ever used for f32 and f64, both of which have the "::MIN_VALUE constant. This change makes the functionality of the ::min_value() method consistent with the docs.
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.
The docs for the function state "The smallest finite positive value representable using this type.", but f32::MIN & f64::MIN are both the smallest values representable(and are thus negative). The f32::MIN_POSITIVE & f64::MIN_POSITIVE are the constants with the smallest values for their respective types that are still positive.
This could also be an issue with the docs, and the RealField::min_value() function is actually meant to return the smallest value for the type, in which case this pull request would break projects depending on this function.