Skip to content

Ops: Implement Saturating operations #173

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

Closed
wants to merge 1 commit into from
Closed

Ops: Implement Saturating operations #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 30 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ use core::str::FromStr;
pub use num_traits::float::FloatCore;
use num_traits::{
AsPrimitive, Bounded, FloatConst, FromPrimitive, Num, NumCast, One, Signed, ToPrimitive, Zero,
SaturatingAdd,SaturatingSub,SaturatingMul,
};
#[cfg(any(feature = "std", feature = "libm"))]
pub use num_traits::{Float, Pow};
Expand Down Expand Up @@ -416,7 +417,7 @@ impl<T: FloatCore> DerefMut for OrderedFloat<T> {
impl<T: FloatCore> Eq for OrderedFloat<T> {}

macro_rules! impl_ordered_float_binop {
($imp:ident, $method:ident, $assign_imp:ident, $assign_method:ident) => {
($imp:ident, $method:ident) => {
impl<T: $imp> $imp for OrderedFloat<T> {
type Output = OrderedFloat<T::Output>;

Expand Down Expand Up @@ -504,7 +505,30 @@ macro_rules! impl_ordered_float_binop {
OrderedFloat((self.0).$method(other))
}
}
};
}
impl_ordered_float_binop! {Add, add}
impl_ordered_float_binop! {Sub, sub}
impl_ordered_float_binop! {Mul, mul}
impl_ordered_float_binop! {Div, div}
impl_ordered_float_binop! {Rem, rem}

macro_rules! impl_ordered_float_saturating_binop {
($imp:ident, $method:ident) => {
impl<T: $imp> $imp for OrderedFloat<T> {
#[inline]
fn $method(&self, other: &Self) -> Self {
OrderedFloat((self.0).$method(&other.0))
}
}
};
}
impl_ordered_float_saturating_binop! {SaturatingAdd, saturating_add}
impl_ordered_float_saturating_binop! {SaturatingSub, saturating_sub}
impl_ordered_float_saturating_binop! {SaturatingMul, saturating_mul}

macro_rules! impl_ordered_float_assign_binop {
($assign_imp:ident, $assign_method:ident) => {
impl<T: $assign_imp> $assign_imp<T> for OrderedFloat<T> {
#[inline]
fn $assign_method(&mut self, other: T) {
Expand Down Expand Up @@ -534,12 +558,11 @@ macro_rules! impl_ordered_float_binop {
}
};
}

impl_ordered_float_binop! {Add, add, AddAssign, add_assign}
impl_ordered_float_binop! {Sub, sub, SubAssign, sub_assign}
impl_ordered_float_binop! {Mul, mul, MulAssign, mul_assign}
impl_ordered_float_binop! {Div, div, DivAssign, div_assign}
impl_ordered_float_binop! {Rem, rem, RemAssign, rem_assign}
impl_ordered_float_assign_binop! {AddAssign, add_assign}
impl_ordered_float_assign_binop! {SubAssign, sub_assign}
impl_ordered_float_assign_binop! {MulAssign, mul_assign}
impl_ordered_float_assign_binop! {DivAssign, div_assign}
impl_ordered_float_assign_binop! {RemAssign, rem_assign}

macro_rules! impl_ordered_float_pow {
($inner:ty, $rhs:ty) => {
Expand Down
9 changes: 9 additions & 0 deletions tests/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,15 @@ fn add() {
assert_eq!(&OrderedFloat(0.0) + &0.0, 0.0);
}

#[test]
fn saturating_add() {
pub use num_traits::SaturatingAdd;

let a = OrderedFloat(0.0f32);
let inf = OrderedFloat(f32::INFINITY);
assert_eq!(a.saturating_add(inf), inf);
}

#[test]
fn ordered_f32_neg() {
assert_eq!(OrderedFloat(-7.0f32), -OrderedFloat(7.0f32));
Expand Down