1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
//! Provides number theory utility functions
/// Provides a trait for the canonical modulus operation since % is technically
/// the remainder operation
pub trait Modulus {
/// Performs a canonical modulus operation between `self` and `divisor`.
///
/// # Examples
///
/// ```
/// use statrs::euclid::Modulus;
///
/// let x = 4i64.modulus(5);
/// assert_eq!(x, 4);
///
/// let y = -4i64.modulus(5);
/// assert_eq!(x, 4);
/// ```
fn modulus(self, divisor: Self) -> Self;
}
impl Modulus for f64 {
fn modulus(self, divisor: f64) -> f64 {
((self % divisor) + divisor) % divisor
}
}
impl Modulus for f32 {
fn modulus(self, divisor: f32) -> f32 {
((self % divisor) + divisor) % divisor
}
}
impl Modulus for i64 {
fn modulus(self, divisor: i64) -> i64 {
((self % divisor) + divisor) % divisor
}
}
impl Modulus for i32 {
fn modulus(self, divisor: i32) -> i32 {
((self % divisor) + divisor) % divisor
}
}
impl Modulus for u64 {
fn modulus(self, divisor: u64) -> u64 {
((self % divisor) + divisor) % divisor
}
}
impl Modulus for u32 {
fn modulus(self, divisor: u32) -> u32 {
((self % divisor) + divisor) % divisor
}
}