Fix the data types for the function sq() #991
Open
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 current description states that the argument of
sq()
can have “any data type”, whereas only numeric types can be used.The current description states that the returned value is a “
double
”, but this is only true if the argument is itself adouble
.This pull request attempts to fix the types. It is, however, impossible to give a completely accurate description of the returned type without fully stating all the C++ rules of integral promotion, and this would be too much for the intended audience.
As a compromise, the proposed description is:
This captures the gist of integral promotion, and should be accurate on ILP32 (ARM). On IP16 (AVR), however, this simplified description implies that
sq(short_var)
is ashort
, whereas it is actually anint
. I deem the inaccuracy acceptable given that, on IP16,short
andint
are basically the same thing (they have the same underlying representation).