-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add non-panicking abs() functions to all signed integer types. #1678
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
Closed
Closed
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| - Feature Name: no_panic_abs | ||
| - Start Date: 2016-07-14 | ||
| - RFC PR: (leave this empty) | ||
| - Rust Issue: (leave this empty) | ||
|
|
||
| # Summary | ||
| [summary]: #summary | ||
|
|
||
| Add the non-panicking `checked_abs`, `overflowing_abs` and `wrapping_abs` | ||
| functions to all signed integer types. | ||
|
|
||
| # Motivation | ||
| [motivation]: #motivation | ||
|
|
||
| Currently, calling `abs()` on one of the signed integer types might panic (in | ||
| debug mode at least) because the absolute value of the largest negative value | ||
| can not be represented in that signed type. Unlike all other integer | ||
| operations, there is currently not a non-panicking version on this function. | ||
|
|
||
| # Detailed design | ||
| [design]: #detailed-design | ||
|
|
||
| This is the current implementation of `abs()`: | ||
|
|
||
| ```rust | ||
| pub fn abs(self) -> Self { | ||
| if self.is_negative() { | ||
| -self | ||
| } else { | ||
| self | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This RFC proposes to add the following: | ||
|
|
||
| ```rust | ||
| pub fn checking_abs(self) -> Option<Self> { | ||
| if self.is_negative() { | ||
| self.checked_neg() | ||
| } else { | ||
| Some(self) | ||
| } | ||
| } | ||
|
|
||
| pub fn overflowing_abs(self) -> (Self,bool) { | ||
| if self.is_negative() { | ||
| self.overflowing_neg() | ||
| } else { | ||
| (self,false) | ||
| } | ||
| } | ||
|
|
||
| pub fn wrapping_abs(self) -> Self { | ||
| if self.is_negative() { | ||
| self.wrapping_neg() | ||
| } else { | ||
| self | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| # Drawbacks | ||
| [drawbacks]: #drawbacks | ||
|
|
||
| Can't think of any. | ||
|
|
||
| # Alternatives | ||
| [alternatives]: #alternatives | ||
|
|
||
| * The absolute value of the largest negative value this number could be | ||
| represented correctly when converting to an unsigned type of the same size. | ||
| One could make a function that returns the unsigned type directly. This RFC | ||
| does not propose that because the author could not think of a good name for | ||
| that function. In retrospect, this is probably what the `abs()` function should | ||
| have done. With the proposed new set of functions, the user can then cast the | ||
| return value of `wrapping_abs` to the appropriate unsigned type and use that | ||
| absolute value. | ||
|
|
||
| * Do nothing, requiring people to implement the functionality manually when | ||
| needed. | ||
|
|
||
| # Unresolved questions | ||
| [unresolved]: #unresolved-questions | ||
|
|
||
| Should there be a similar function on the `Wrapping` wrapper as well? | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
checked_abs, notchecking, would seem to be more consistent with existing conventions.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, of course.