Rename "modulo" to "remainder" #350
Merged
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.
When negative numbers are involved, "modulo" typically refers to an operation that has the same sign as the second operand, whereas "remainder" has the sign of the first (this distinction is clear e.g. in the Ada language, which has both
mod
andrem
operators). Specifically, the standard refers to the result of%
as "remainder", not "modulo".In Python, for example,
(-11) % 10
is 9, but in C and C++ it is -1). This can be a problem if%
is being used to restrict an array index to a range (e.g. to implement a circular buffer), if said index can be negative.I have replaced all occurrences of "modulo" with "remainder" in
modulo.adoc
, and provided two examples of what happens when you use%
with negative operands. However I have left the file name as "modulo.adoc
" (because honestly I have no idea what happens if you mess with the file names).