akshually 0.2.3

The Library for Smart Boys
Documentation
use std::cmp::Ordering;

/// Rounds the `value` with the specified `granularity`.
///
/// # Examples
///
/// ```
/// assert_eq!(akshually::math::round_to(1.93333, 0.05), 1.95);
/// ```
pub fn round_to(value: f64, granularity: f64) -> f64 {
    let scale_factor = 1.0 / granularity;
    let scaled_up = value * scale_factor;
    let rounded = scaled_up.round();
    let scaled_down = rounded / scale_factor;
    scaled_down
}

/// Provides an Iterator for prime numbers.
///
/// # Examples
///
/// ```
/// let mut primes = akshually::math::PrimeIterator::new();
/// assert_eq!(primes.next(), Some(2));
/// assert_eq!(primes.next(), Some(3));
/// assert_eq!(primes.next(), Some(5));
/// ```
pub struct PrimeIterator {
    i: u64,
    primes: Vec<u64>,
}

impl PrimeIterator {
    /// Creates a new `PrimeIterator`.
    pub fn new() -> Self {
        PrimeIterator {
            i: 2,
            primes: Vec::new(),
        }
    }
}

impl Iterator for PrimeIterator {
    type Item = u64;

    /// Computes and returns the next prime number.
    fn next(&mut self) -> Option<u64> {
        let mut i = self.i;
        loop {
            if !self.primes.iter().any(|p| i % p == 0) {
                self.primes.push(i);
                self.i = i + 1;
                return Some(i);
            }
            i += 1;
        }
    }
}

/// Factorizes the given number into its prime factors.
///
/// # Examples
///
/// ```
/// assert_eq!(akshually::math::factorize(36), vec![2, 2, 3, 3]);
/// assert_eq!(akshually::math::factorize(64), vec![2, 2, 2, 2, 2, 2]);
/// assert_eq!(akshually::math::factorize(13), vec![13]);
/// ```
pub fn factorize(n: u64) -> Vec<u64> {
    let mut primes = PrimeIterator::new();
    let mut factors = Vec::new();
    let mut n = n;
    let mut prime = match primes.next() {
        Some(p) => p,
        None => {
            return vec![n];
        }
    };
    while n > 1 {
        if n % prime == 0 {
            factors.push(prime);
            n /= prime;
        } else {
            prime = match primes.next() {
                Some(p) => p,
                None => {
                    factors.push(n);
                    return factors;
                }
            }
        }
    }
    factors
}

/// Reduces the fraction `numerator`/`denominator` using their GCD.
///
/// Examples:
///
/// ```
/// assert_eq!(akshually::math::reduce_fraction(32, 64), (1, 2));
/// ```
pub fn reduce_fraction(numerator: u64, denominator: u64) -> (u64, u64) {
    let divider = gcd(numerator, denominator);
    (numerator / divider, denominator / divider)
}

/// Finds the GCD of `a` and `b`.
///
/// Examples:
///
/// ```
/// assert_eq!(akshually::math::gcd(48, 36), 12);
/// ```
pub fn gcd(a: u64, b: u64) -> u64 {
    let num_factors = factorize(a);
    let den_factors = factorize(b);
    let common = common_items(num_factors, den_factors);
    common.iter().fold(1, |x, acc| x * acc)
}

fn common_items(left: Vec<u64>, right: Vec<u64>) -> Vec<u64> {
    let mut common: Vec<u64> = Vec::new();
    let mut left = left.iter();
    let mut right = right.iter();
    let mut l = left.next();
    let mut r = right.next();
    loop {
        let x = match l {
            Some(n) => n,
            None => {
                break;
            }
        };
        let y = match r {
            Some(n) => n,
            None => {
                break;
            }
        };
        match x.cmp(y) {
            Ordering::Equal => {
                common.push(*x);
                l = left.next();
                r = right.next();
            }
            Ordering::Less => {
                l = left.next();
            }
            Ordering::Greater => {
                r = right.next();
            }
        }
    }
    common
}

#[cfg(test)]
mod tests {
    use crate::math::*;

    #[test]
    fn round_to_nickel() {
        let result = round_to(10.0 / 3.0, 0.05);
        assert_eq!(result, 3.35);
    }

    #[test]
    fn prime_numbers_up_to_20() {
        let mut primes = PrimeIterator::new();
        assert_eq!(primes.next(), Some(2));
        assert_eq!(primes.next(), Some(3));
        assert_eq!(primes.next(), Some(5));
        assert_eq!(primes.next(), Some(7));
        assert_eq!(primes.next(), Some(11));
        assert_eq!(primes.next(), Some(13));
        assert_eq!(primes.next(), Some(17));
        assert_eq!(primes.next(), Some(19));
    }

    #[test]
    fn factorize_1000000000() {
        let number = 1000000000;
        let expected = vec![2, 2, 2, 2, 2, 2, 2, 2, 2, 5, 5, 5, 5, 5, 5, 5, 5, 5];
        let factors = factorize(number);
        assert_eq!(factors, expected);
        assert_eq!(number, factors.iter().fold(1, |x, acc| x * acc));
    }

    #[test]
    fn factorize_1000000001() {
        let factors = factorize(1000000001);
        assert_eq!(factors, vec![7, 11, 13, 19, 52579]);
    }

    #[test]
    fn has_no_common_items() {
        let a = vec![1, 3, 5, 9];
        let b = vec![2, 4, 6, 8];
        assert_eq!(common_items(a, b), vec![])
    }

    #[test]
    fn has_common_items() {
        let a = vec![1, 2, 3, 4, 5, 6];
        let b = vec![1, 3, 5, 7, 9, 11];
        assert_eq!(common_items(a, b), vec![1, 3, 5])
    }

    #[test]
    fn reduce_18_over_6() {
        assert_eq!(reduce_fraction(18, 6), (3, 1));
    }

    #[test]
    fn reduce_136_over_150() {
        assert_eq!(reduce_fraction(136, 150), (68, 75));
    }

    #[test]
    fn no_gcd_of_primes() {
        assert_eq!(gcd(13, 17), 1);
    }

    #[test]
    fn gcd_of_same_number() {
        assert_eq!(gcd(13, 13), 13);
    }

    #[test]
    fn gcd_of_same_sequence() {
        assert_eq!(gcd(24, 36), 12);
    }
}