mathru 0.16.2

Fundamental algorithms for scientific computing in Rust
Documentation
use crate::algebra::{
    abstr::{Field, Scalar},
    linear::matrix::Diagonal,
};
use std::ops::Add;

impl<T> Add<Diagonal<T>> for Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = Diagonal<T>;

    /// Adds two matrices
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let a: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, -7.0].into();
    ///
    /// let b: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, 2.0].into();
    ///
    /// let sum: Diagonal<f64> = matrix![2.0, 0.0;
    ///                                  0.0, -5.0].into();
    ///
    /// let c: Diagonal<f64> = a + b;
    /// assert_eq!(sum, c);
    /// ```
    fn add(self, rhs: Self) -> Self::Output {
        self.matrix.add(rhs.matrix).into()
    }
}

///
///Adds two matrices
impl<'a, 'b, T> Add<&'b Diagonal<T>> for &'a Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = Diagonal<T>;

    /// Adds two matrices
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let a: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, -7.0].into();
    ///
    /// let b: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, 2.0].into();
    ///
    /// let sum: Diagonal<f64> = matrix![2.0, 0.0;
    ///                                  0.0, -5.0].into();
    ///
    /// let c: Diagonal<f64> = &b + &a;
    /// assert_eq!(sum, c)
    /// ```
    fn add(self, rhs: &'b Diagonal<T>) -> Self::Output {
        Add::add(&self.matrix, &rhs.matrix).into()
    }
}

///
///Adds two matrices
impl<'a, 'b, T> Add<&'b Diagonal<T>> for &'a mut Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = &'a mut Diagonal<T>;

    /// Adds two matrices
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let mut a: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                    0.0, -7.0].into();
    ///
    /// let b: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, 2.0].into();
    ///
    /// let sum: Diagonal<f64> = matrix![2.0, 0.0;
    ///                                  0.0, -5.0].into();
    ///
    /// let c = &mut a + &b;
    /// assert_eq!(&sum, c)
    /// ```
    fn add(self, rhs: &'b Diagonal<T>) -> Self::Output {
        let _ = Add::add(&mut self.matrix, &rhs.matrix);
        self
    }
}

///
/// Add scalar to matrix
impl<T> Add<T> for Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = Diagonal<T>;

    /// Add a scalar to the matrix
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let a: Diagonal<f64> = matrix![ 1.0, 0.0;
    ///                                 0.0, -7.0].into();
    ///
    /// let b: Diagonal<f64> = a + -4.0;
    /// ```
    fn add(mut self, rhs: T) -> Self::Output {
        let _ = (&mut self).add(&rhs);
        self
    }
}

///
/// Add scalar to matrix
impl<'a, 'b, T> Add<&'b T> for &'a Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = Diagonal<T>;

    /// Add a scalar to the matrix
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let a: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                0.0, -7.0].into();
    ///
    /// let b: Diagonal<f64> = &a + &-4.0;
    ///
    /// let sum: Diagonal<f64> = matrix![-3.0, 0.0;
    ///                                  0.0, -11.0].into();
    /// assert_eq!(b, sum);
    /// ```
    fn add(self, rhs: &T) -> Self::Output {
        self.apply(&|x: &T| -> T { *x + *rhs })
    }
}

///
/// Add scalar to matrix
impl<'a, 'b, T> Add<&'b T> for &'a mut Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = &'a mut Diagonal<T>;

    /// Add a scalar to the matrix
    ///
    /// # Example
    ///
    /// ```
    /// use mathru::algebra::linear::matrix::{Diagonal, General};
    /// use mathru::matrix;
    ///
    /// let mut a: Diagonal<f64> = matrix![1.0, 0.0;
    ///                                    0.0, -4.0].into();
    /// let b = &mut a + &-4.0;
    /// ```
    fn add(self, rhs: &T) -> Self::Output {
        let (m, n) = self.dim();
        let k = m.min(n);
        for i in 0..k {
            self[[i, i]] += *rhs
        }
        self
    }
}