Made requested changes.

This commit is contained in:
Jacob Kiesel 2017-02-07 13:02:32 -07:00
parent 182e08a091
commit f8dcec366b
2 changed files with 30 additions and 13 deletions

View File

@ -81,7 +81,7 @@ pub use num_traits::{Num, Zero, One, Signed, Unsigned, Bounded,
one, zero, abs, abs_sub, signum, one, zero, abs, abs_sub, signum,
Saturating, CheckedAdd, CheckedSub, CheckedMul, CheckedDiv, Saturating, CheckedAdd, CheckedSub, CheckedMul, CheckedDiv,
PrimInt, Float, ToPrimitive, FromPrimitive, NumCast, cast, PrimInt, Float, ToPrimitive, FromPrimitive, NumCast, cast,
pow, checked_pow}; pow, checked_pow, clamp};
#[cfg(feature = "num-bigint")] #[cfg(feature = "num-bigint")]
pub mod bigint { pub mod bigint {
@ -109,15 +109,3 @@ pub mod traits {
pub mod rational { pub mod rational {
pub use num_rational::*; pub use num_rational::*;
} }
/// A value bounded by a minimum and a maximum
///
/// If input is less than min then min is returned, if input is greater than max then max is
/// returned. Otherwise input is returned.
#[inline]
pub fn clamp<T: PartialOrd + Copy>(input: T, min: T, max: T) -> T {
debug_assert!(min < max, "min must be less than max");
if input <= min {min}
else if input >= max {max}
else {input}
}

View File

@ -241,6 +241,35 @@ macro_rules! float_trait_impl {
} }
float_trait_impl!(Num for f32 f64); float_trait_impl!(Num for f32 f64);
/// A value bounded by a minimum and a maximum
///
/// If input is less than min then min is returned, if input is greater than max then max is
/// returned. Otherwise input is returned.
#[inline]
pub fn clamp<T: PartialOrd>(input: T, min: T, max: T) -> T {
debug_assert!(min <= max, "min must be less than max");
if input < min {
min
} else if input > max {
max
} else {
input
}
}
#[test]
fn clamp_test() {
// Int test
assert_eq!(1, clamp(1, -1, 2));
assert_eq!(-1, clamp(-2, -1, 2));
assert_eq!(2, clamp(3, -1, 2));
// Float test
assert_eq!(1.0, clamp(1.0, -1.0, 2.0));
assert_eq!(-1.0, clamp(-2.0, -1.0, 2.0));
assert_eq!(2.0, clamp(3.0, -1.0, 2.0));
}
#[test] #[test]
fn from_str_radix_unwrap() { fn from_str_radix_unwrap() {
// The Result error must impl Debug to allow unwrap() // The Result error must impl Debug to allow unwrap()