qfall-math 0.1.1

// Copyright © 2023 Phil Milewski
//
// This file is part of qFALL-math.
//
// qFALL-math is free software: you can redistribute it and/or modify it under
// the terms of the Mozilla Public License Version 2.0 as published by the
// Mozilla Foundation. See <https://mozilla.org/en-US/MPL/2.0/>.

//! Implementation of the [`Add`] trait for [`Q`] values.

use super::super::Q;
use crate::{
    integer::Z,
    macros::arithmetics::{
        arithmetic_assign_between_types, arithmetic_assign_trait_borrowed_to_owned,
        arithmetic_between_types, arithmetic_trait_borrowed_to_owned,
        arithmetic_trait_mixed_borrowed_owned,
    },
};
use flint_sys::fmpq::{fmpq_add, fmpq_add_fmpz, fmpq_add_si, fmpq_add_ui};
use std::ops::{Add, AddAssign};

impl AddAssign<&Q> for Q {
    /// Computes the addition of `self` and `other` reusing
    /// the memory of `self`.
    /// [`AddAssign`] can be used on [`Q`] in combination with
    /// [`Q`], [`Z`], [`f64`], [`f32`], [`i64`], [`i32`], [`i16`], [`i8`], [`u64`], [`u32`], [`u16`] and [`u8`].
    ///
    /// Parameters:
    ///  - `other`: specifies the value to add to `self`
    ///
    /// Returns the sum of both rationals as a [`Q`].
    ///
    /// # Examples
    /// ```
    /// use qfall_math::{rational::Q, integer::Z};
    ///
    /// let mut a: Q = Q::from(42);
    /// let b: Q = Q::from((-42, 2));
    /// let c: Z = Z::from(5);
    ///
    /// a += &b;
    /// a += b;
    /// a += 5;
    /// a += c;
    /// a += 5.0;
    /// ```
    fn add_assign(&mut self, other: &Self) {
        unsafe { fmpq_add(&mut self.value, &self.value, &other.value) };
    }
}
impl AddAssign<&Z> for Q {
    /// Documentation at [`Q::add_assign`].
    fn add_assign(&mut self, other: &Z) {
        unsafe { fmpq_add_fmpz(&mut self.value, &self.value, &other.value) };
    }
}
impl AddAssign<i64> for Q {
    /// Documentation at [`Q::add_assign`].
    fn add_assign(&mut self, other: i64) {
        unsafe { fmpq_add_si(&mut self.value, &self.value, other) };
    }
}
impl AddAssign<u64> for Q {
    /// Documentation at [`Q::add_assign`].
    fn add_assign(&mut self, other: u64) {
        unsafe { fmpq_add_ui(&mut self.value, &self.value, other) };
    }
}
impl AddAssign<f64> for Q {
    /// Documentation at [`Q::add_assign`].
    fn add_assign(&mut self, other: f64) {
        let other = Q::from(other);

        unsafe { fmpq_add(&mut self.value, &self.value, &other.value) };
    }
}

arithmetic_assign_trait_borrowed_to_owned!(AddAssign, add_assign, Q, Q);
arithmetic_assign_trait_borrowed_to_owned!(AddAssign, add_assign, Q, Z);
arithmetic_assign_between_types!(AddAssign, add_assign, Q, i64, i32 i16 i8);
arithmetic_assign_between_types!(AddAssign, add_assign, Q, u64, u32 u16 u8);
arithmetic_assign_between_types!(AddAssign, add_assign, Q, f64, f32);

impl Add for &Q {
    type Output = Q;

    /// Implements the [`Add`] trait for two [`Q`] values.
    /// [`Add`] is implemented for any combination of [`Q`] and borrowed [`Q`].
    ///
    /// Parameters:
    ///  - `other`: specifies the value to add to `self`
    ///
    /// Returns the sum of both rationals as a [`Q`].
    ///
    /// # Examples
    /// ```
    /// use qfall_math::rational::Q;
    /// use std::str::FromStr;
    ///
    /// let a: Q = Q::from(42);
    /// let b: Q = Q::from((-42, 2));
    ///
    /// let c: Q = &a + &b;
    /// let d: Q = a + b;
    /// let e: Q = &c + d;
    /// let f: Q = c + &e;
    /// ```
    fn add(self, other: Self) -> Self::Output {
        let mut out = Q::default();
        unsafe {
            fmpq_add(&mut out.value, &self.value, &other.value);
        }
        out
    }
}

arithmetic_trait_borrowed_to_owned!(Add, add, Q, Q, Q);
arithmetic_trait_mixed_borrowed_owned!(Add, add, Q, Q, Q);
arithmetic_between_types!(Add, add, Q, Q, i64 i32 i16 i8 u64 u32 u16 u8 f32 f64);

impl Add<&Z> for &Q {
    type Output = Q;

    /// Implements the [`Add`] trait for [`Q`] and [`Z`] values.
    /// [`Add`] is implemented for any combination of owned and borrowed values.
    ///
    /// Parameters:
    ///  - `other`: specifies the value to add to `self`
    ///
    /// Returns the sum of both numbers as a [`Q`].
    ///
    /// # Examples
    /// ```
    /// use qfall_math::rational::Q;
    /// use qfall_math::integer::Z;
    /// use std::str::FromStr;
    ///
    /// let a: Q = Q::from((42, 19));
    /// let b: Z = Z::from(-42);
    ///
    /// let c: Q = &a + &b;
    /// let d: Q = a + b;
    /// let e: Q = &c + Z::from(42);
    /// let f: Q = c + &Z::from(42);
    /// ```
    fn add(self, other: &Z) -> Self::Output {
        let mut out = Q::default();
        unsafe {
            fmpq_add_fmpz(&mut out.value, &self.value, &other.value);
        }
        out
    }
}

arithmetic_trait_borrowed_to_owned!(Add, add, Q, Z, Q);
arithmetic_trait_mixed_borrowed_owned!(Add, add, Q, Z, Q);

#[cfg(test)]
mod test_add_assign {
    use crate::{integer::Z, rational::Q};

    /// Ensure that `add_assign` works for small numbers.
    #[test]
    fn correct_small() {
        let mut a = Q::MINUS_ONE;
        let b = Q::MINUS_ONE;
        let c = Q::ONE;
        let d = Q::from((1, 2));

        a += &b;
        assert_eq!(-2, a);
        a += &c;
        assert_eq!(-1, a);
        a += &c;
        assert_eq!(0, a);
        a += &c;
        assert_eq!(1, a);
        a += &c;
        assert_eq!(2, a);
        a += 2 * b;
        assert_eq!(0, a);
        a += d;
        assert_eq!(Q::from((1, 2)), a);
    }

    /// Ensure that `add_assign` works for large numbers.
    #[test]
    fn correct_large() {
        let mut a = Q::from(i64::MAX);
        let b = Q::from(i64::MIN);
        let c = Q::from(u64::MAX);

        a += b;
        assert_eq!(-1, a);
        a += c;
        assert_eq!(u64::MAX - 1, a);
    }

    /// Ensure that `add_assign` is available for all types.
    #[test]
    fn availability() {
        let mut a = Q::from((1, 2));
        let b = Q::from((4, 5));
        let c = Z::ONE;

        a += &b;
        a += b;
        a += &c;
        a += c;
        a += 0.5_f64;
        a += 0.5_f32;
        a += 1_u8;
        a += 1_u16;
        a += 1_u32;
        a += 1_u64;
        a += 1_i8;
        a += 1_i16;
        a += 1_i32;
        a += 1_i64;
    }
}

#[cfg(test)]
mod test_add {
    use super::Q;
    use std::str::FromStr;

    /// Testing addition for two [`Q`]
    #[test]
    fn add() {
        let a: Q = Q::from(42);
        let b: Q = Q::from((42, 2));
        let c: Q = a + b;
        assert_eq!(c, Q::from(63));
    }

    /// Testing addition for two borrowed [`Q`]
    #[test]
    fn add_borrow() {
        let a: Q = Q::from(42);
        let b: Q = Q::from((42, 2));
        let c: Q = &a + &b;
        assert_eq!(c, Q::from(63));
    }

    /// Testing addition for borrowed [`Q`] and [`Q`]
    #[test]
    fn add_first_borrowed() {
        let a: Q = Q::from((42, 5));
        let b: Q = Q::from((42, 10));
        let c: Q = &a + b;
        assert_eq!(c, Q::from((63, 5)));
    }

    /// Testing addition for [`Q`] and borrowed [`Q`]
    #[test]
    fn add_second_borrowed() {
        let a: Q = Q::from(42);
        let b: Q = Q::from((42, 2));
        let c: Q = a + &b;
        assert_eq!(c, Q::from(63));
    }

    /// Testing addition for large numerators and divisors
    #[test]
    fn add_large() {
        let a: Q = Q::from(i64::MAX);
        let b: Q = Q::from(u64::MAX - 1);
        let c: Q = Q::from((1, i32::MAX));
        let d: Q = Q::from((1, u32::MAX));
        let e: Q = &a + &a;
        let f: Q = c + d;
        assert_eq!(e, b);
        assert_eq!(
            f,
            Q::from_str(&format!(
                "{}/{}",
                u64::from(u32::MAX) + u64::from((u32::MAX - 1) / 2),
                u64::from(u32::MAX) * u64::from((u32::MAX - 1) / 2)
            ))
            .unwrap()
        );
    }
}

#[cfg(test)]
mod test_add_between_q_and_z {
    use crate::integer::Z;
    use crate::rational::Q;

    /// Testing addition for [`Q`] and [`Z`]
    #[test]
    fn add() {
        let a: Q = Q::from((5, 7));
        let b: Z = Z::from(4);
        let c: Q = a + b;
        assert_eq!(c, Q::from((33, 7)));
    }

    /// Testing addition for both borrowed [`Q`] and [`Z`]
    #[test]
    fn add_borrow() {
        let a: Q = Q::from((5, 7));
        let b: Z = Z::from(4);
        let c: Q = &a + &b;
        assert_eq!(c, Q::from((33, 7)));
    }

    /// Testing addition for borrowed [`Q`] and [`Z`]
    #[test]
    fn add_first_borrowed() {
        let a: Q = Q::from((5, 7));
        let b: Z = Z::from(4);
        let c: Q = &a + b;
        assert_eq!(c, Q::from((33, 7)));
    }

    /// Testing addition for [`Q`] and borrowed [`Z`]
    #[test]
    fn add_second_borrowed() {
        let a: Q = Q::from((5, 7));
        let b: Z = Z::from(4);
        let c: Q = a + &b;
        assert_eq!(c, Q::from((33, 7)));
    }

    /// Testing addition for large numbers
    #[test]
    fn add_large_numbers() {
        let a: Q = Q::from((u64::MAX, 2));
        let b: Q = Q::from((1, u64::MAX));
        let c: Z = Z::from(u64::MAX);
        let d: Q = a + &c;
        let e: Q = b + c;
        assert_eq!(d, Q::from(u64::MAX) + Q::from((u64::MAX, 2)));
        assert_eq!(e, Q::from((1, u64::MAX)) + Q::from(u64::MAX));
    }
}

#[cfg(test)]
mod test_add_between_types {

    use crate::rational::Q;

    /// Testing addition between different types
    #[test]
    #[allow(clippy::op_ref)]
    fn add() {
        let a: Q = Q::from(42);
        let b: u64 = 1;
        let c: u32 = 1;
        let d: u16 = 1;
        let e: u8 = 1;
        let f: i64 = 1;
        let g: i32 = 1;
        let h: i16 = 1;
        let i: i8 = 1;
        let j: f32 = 0.3;
        let k: f64 = 0.3;
        let _: Q = &a + &b;
        let _: Q = &a + &c;
        let _: Q = &a + &d;
        let _: Q = &a + &e;
        let _: Q = &a + &f;
        let _: Q = &a + &g;
        let _: Q = &a + &h;
        let _: Q = &a + &i;
        let _: Q = &a + &j;
        let _: Q = &a + &k;

        let _: Q = &b + &a;
        let _: Q = &c + &a;
        let _: Q = &d + &a;
        let _: Q = &e + &a;
        let _: Q = &f + &a;
        let _: Q = &g + &a;
        let _: Q = &h + &a;
        let _: Q = &i + &a;
        let _: Q = &j + &a;
        let _: Q = &k + &a;

        let _: Q = &a + b;
        let _: Q = &a + c;
        let _: Q = &a + d;
        let _: Q = &a + e;
        let _: Q = &a + f;
        let _: Q = &a + g;
        let _: Q = &a + h;
        let _: Q = &a + i;
        let _: Q = &a + j;
        let _: Q = &a + k;

        let _: Q = &b + Q::from(42);
        let _: Q = &c + Q::from(42);
        let _: Q = &d + Q::from(42);
        let _: Q = &e + Q::from(42);
        let _: Q = &f + Q::from(42);
        let _: Q = &g + Q::from(42);
        let _: Q = &h + Q::from(42);
        let _: Q = &i + Q::from(42);
        let _: Q = &j + Q::from(42);
        let _: Q = &k + Q::from(42);

        let _: Q = Q::from(42) + &b;
        let _: Q = Q::from(42) + &c;
        let _: Q = Q::from(42) + &d;
        let _: Q = Q::from(42) + &e;
        let _: Q = Q::from(42) + &f;
        let _: Q = Q::from(42) + &g;
        let _: Q = Q::from(42) + &h;
        let _: Q = Q::from(42) + &i;
        let _: Q = Q::from(42) + &j;
        let _: Q = Q::from(42) + &k;

        let _: Q = b + &a;
        let _: Q = c + &a;
        let _: Q = d + &a;
        let _: Q = e + &a;
        let _: Q = f + &a;
        let _: Q = g + &a;
        let _: Q = h + &a;
        let _: Q = i + &a;
        let _: Q = j + &a;
        let _: Q = k + &a;

        let _: Q = Q::from(42) + b;
        let _: Q = Q::from(42) + c;
        let _: Q = Q::from(42) + d;
        let _: Q = Q::from(42) + e;
        let _: Q = Q::from(42) + f;
        let _: Q = Q::from(42) + g;
        let _: Q = Q::from(42) + h;
        let _: Q = Q::from(42) + i;
        let _: Q = Q::from(42) + j;
        let _: Q = Q::from(42) + k;

        let _: Q = b + Q::from(42);
        let _: Q = c + Q::from(42);
        let _: Q = d + Q::from(42);
        let _: Q = e + Q::from(42);
        let _: Q = f + Q::from(42);
        let _: Q = g + Q::from(42);
        let _: Q = h + Q::from(42);
        let _: Q = i + Q::from(42);
        let _: Q = j + Q::from(42);
        let _: Q = k + Q::from(42);
    }
}