Skip to content

Add Saturating type (based on Wrapping type) #87921

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.

Sign up for GitHub

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

Merged
merged 20 commits into from
Aug 29, 2021
Merged

Add Saturating type (based on Wrapping type) #87921

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
709a6c9
Add Saturating type (based on Wrapping type)
kellerkindt Aug 10, 2021
8841155
Remove unused macros
kellerkindt Aug 10, 2021
cdc90f9
Rustfmt
kellerkindt Aug 10, 2021
d4c9f76
Fix missed tests
kellerkindt Aug 10, 2021
631766c
Make all the impls for Staturating unstable saturating_int_impl
kellerkindt Aug 12, 2021
6cf4dd9
Remove mentioning of modular arithmetic
kellerkindt Aug 12, 2021
57dacfe
Like in Wrapping use shift in doctest
kellerkindt Aug 12, 2021
e240853
Replace doc test with doc macro call
kellerkindt Aug 12, 2021
3f7d2ce
Add naive shift implementation to Saturating
kellerkindt Aug 12, 2021
7861121
Add naive remainder impl to Saturating
kellerkindt Aug 12, 2021
f136eea
Implement Neg only for signed Saturating types
kellerkindt Aug 12, 2021
8049230
Saturate negative division
kellerkindt Aug 19, 2021
742d450
Add and use saturating_div instead of impl inside Saturating
kellerkindt Aug 19, 2021
6bb3aca
Add doctests to and fix saturating_div for signed integer types
kellerkindt Aug 19, 2021
a0e61e2
Add saturating_div to unsigned integer types
kellerkindt Aug 19, 2021
5ca6993
Simplify Div impl for Saturating by using saturating_div
kellerkindt Aug 19, 2021
2b5970f
Simplify saturating_div
kellerkindt Aug 19, 2021
acf0a0c
Use wrapping shift for unsigned types
kellerkindt Aug 28, 2021
977ae5a
Fix mentions of wrapping operations
kellerkindt Aug 28, 2021
ce636f2
Unimpl Shl{Assign} for signed Saturating types until the correct impl…
kellerkindt Aug 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 31 additions & 37 deletions library/core/src/num/saturating.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,37 @@ macro_rules! saturating_impl {
}
forward_ref_op_assign! { impl MulAssign, mul_assign for Saturating<$t>, Saturating<$t> }

/// # Examples
///
/// Basic usage:
///
/// ```
/// #![feature(saturating_int_impl, saturating_div)]
/// use std::num::Saturating;
///
#[doc = concat!("assert_eq!(Saturating(2", stringify!($t), "), Saturating(5", stringify!($t), ") / Saturating(2));")]
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MAX), Saturating(", stringify!($t), "::MAX) / Saturating(1));")]
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN), Saturating(", stringify!($t), "::MIN) / Saturating(1));")]
/// ```
///
/// ```should_panic
/// #![feature(saturating_int_impl, saturating_div)]
/// use std::num::Saturating;
///
#[doc = concat!("let _ = Saturating(0", stringify!($t), ") / Saturating(0);")]
/// ```
#[unstable(feature = "saturating_int_impl", issue = "87920")]
Comment on lines +271 to +290
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure whether to keep this doc(-tests)

impl Div for Saturating<$t> {
type Output = Saturating<$t>;

#[inline]
fn div(self, other: Saturating<$t>) -> Saturating<$t> {
Saturating(self.0.saturating_div(other.0))
}
}
forward_ref_binop! { impl Div, div for Saturating<$t>, Saturating<$t>,
#[unstable(feature = "saturating_int_impl", issue = "87920")] }

#[unstable(feature = "saturating_int_impl", issue = "87920")]
impl DivAssign for Saturating<$t> {
#[inline]
Expand Down Expand Up @@ -851,31 +882,6 @@ macro_rules! saturating_int_impl_signed {
}
forward_ref_unop! { impl Neg, neg for Saturating<$t>,
#[unstable(feature = "saturating_int_impl", issue = "87920")] }

/// # Examples
///
/// Basic usage:
///
/// ```
/// #![feature(saturating_int_impl)]
/// use std::num::Saturating;
///
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN + 1), Saturating(", stringify!($t), "::MAX) / Saturating(-1));")]
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MAX), Saturating(", stringify!($t), "::MIN) / Saturating(-1));")]
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MAX), Saturating(", stringify!($t), "::MAX) / Saturating(1));")]
#[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN), Saturating(", stringify!($t), "::MIN) / Saturating(1));")]
/// ```
#[unstable(feature = "saturating_int_impl", issue = "87920")]
impl Div for Saturating<$t> {
type Output = Saturating<$t>;

#[inline]
fn div(self, other: Saturating<$t>) -> Saturating<$t> {
Saturating(self.0.saturating_div(other.0))
}
}
forward_ref_binop! { impl Div, div for Saturating<$t>, Saturating<$t>,
#[unstable(feature = "saturating_int_impl", issue = "87920")] }
)*)
}

Expand Down Expand Up @@ -924,18 +930,6 @@ macro_rules! saturating_int_impl_unsigned {
}

}

#[unstable(feature = "saturating_int_impl", issue = "87920")]
impl Div for Saturating<$t> {
type Output = Saturating<$t>;

#[inline]
fn div(self, other: Saturating<$t>) -> Saturating<$t> {
Saturating(self.0.div(other.0))
}
}
forward_ref_binop! { impl Div, div for Saturating<$t>, Saturating<$t>,
#[unstable(feature = "saturating_int_impl", issue = "87920")] }
)*)
}

Expand Down