mathru 0.16.2

Fundamental algorithms for scientific computing in Rust
Documentation 
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use crate::algebra::{
    abstr::{Field, Scalar},
    linear::matrix::Diagonal,
};
use std::ops::Sub;

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

    /// Subtracts 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![0.0, 0.0;
    ///                                  0.0, -9.0].into();
    ///
    /// let c: Diagonal<f64> = a - b;
    /// assert_eq!(sum, c);
    /// ```
    fn sub(self, rhs: Self) -> Self::Output {
        self.matrix.sub(rhs.matrix).into()
    }
}

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

    /// Subtracts 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![0.0, 0.0;
    ///                                  0.0, -9.0].into();
    ///
    /// let c: Diagonal<f64> = &a - &b;
    /// assert_eq!(sum, c)
    /// ```
    fn sub(self, rhs: &'b Diagonal<T>) -> Self::Output {
        Sub::sub(&self.matrix, &rhs.matrix).into()
    }
}

impl<'a, 'b, T> Sub<&'b Diagonal<T>> for &'a mut Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = &'a mut Diagonal<T>;

    /// Subtracts 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![0.0, 0.0;
    ///                                  0.0, -9.0].into();
    ///
    /// let c = &a - &b;
    /// assert_eq!(sum, c)
    /// ```
    fn sub(self, rhs: &'b Diagonal<T>) -> Self::Output {
        let _ = Sub::sub(&mut self.matrix, &rhs.matrix);
        self
    }
}

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

    /// Subtracts a scalar to all diagonal matrix elements
    ///
    /// # 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 sub(self, rhs: T) -> Self::Output {
        Sub::sub(self.matrix, rhs).into()
    }
}

impl<'a, 'b, T> Sub<&'b T> for &'a Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = Diagonal<T>;

    /// Subtracts a scalar value to all diagonal elements
    ///
    /// # 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![5.0, 0.0;
    ///                                  0.0, -3.0].into();
    /// assert_eq!(b, sum);
    /// ```
    fn sub(self, rhs: &T) -> Self::Output {
        self.apply(&|x: &T| -> T { *x - *rhs })
    }
}

impl<'a, 'b, T> Sub<&'b T> for &'a mut Diagonal<T>
where
    T: Field + Scalar,
{
    type Output = &'a mut Diagonal<T>;

    /// Sub 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, -7.0].into();
    /// let b = &mut a - &-4.0;
    /// ```
    fn sub(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
    }
}