gpurs 0.4.0

GPU acceleration/linear algebra crate for scientific computing
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

use crate::IsFloat;
use crate::Result;
use crate::Jeeperr;
use crate::linalg::Matrix;

/// Trait containing reference based arithmatic operations for the Matrix struct.
pub trait ReferenceOperations<T: IsFloat + std::fmt::Debug + Copy + Clone> {
    /// Add one matrix to another matrix.
    /// Inputs are immutable references unlike the basic addition operator.
    fn ref_add(left: &Matrix<T>, right: &Matrix<T>) -> Result<Matrix<T>>;
    /// Negate a matrix.
    /// Input is an immutable reference unlike the basic negation operator.
    fn ref_neg(mat: &Matrix<T>) -> Matrix<T>;
    /// Subtract one matrix from another matrix.
    /// Inputs are immutable references unlike the basic subtraction operator.
    fn ref_sub(left: &Matrix<T>, right: &Matrix<T>) -> Result<Matrix<T>>;
    /// Multiply one matrix by another matrix.
    /// Inputs are immutable references unlike the basic multiplication operator.
    fn ref_mul(left: &Matrix<T>, right: &Matrix<T>) -> Result<Matrix<T>>;
    /// Multiply two matrices elementwise. 
    /// Inputs are immutable references unlike the basic elementwise function.
    fn ref_ewm(left: &Matrix<T>, right: &Matrix<T>) -> Result<Matrix<T>>;
    /// Divide two matrices elementwise.
    /// Inputs are immutable references unlike the basic elementwise_divide function.
    fn ref_ewd(left: &Matrix<T>, right: &Matrix<T>) -> Result<Matrix<T>>;
}

impl ReferenceOperations<f32> for Matrix<f32> {
    /// Add one matrix to another matrix.
    /// Inputs are immutable references unlike the basic addition operator.
    fn ref_add(left: &Matrix<f32>, right: &Matrix<f32>) -> Result<Matrix<f32>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f32> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) + right.lindex(idx))
            .collect::<Vec<f32>>();

        let output_mat: Matrix<f32> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Negate a matrix.
    /// Input is an immutable reference unlike the basic negation operator.
    fn ref_neg(mat: &Matrix<f32>) -> Matrix<f32> {
        let n_elements: usize = mat.get_rows() * mat.get_cols();
        let output_data: Vec<f32> = (0..n_elements).into_iter()
            .map(|idx| -mat.lindex(idx))
            .collect::<Vec<f32>>();

        let output_mat: Matrix<f32> = Matrix::new(output_data, mat.get_rows(), mat.get_cols()).unwrap();
        return output_mat
    }

    /// Subtract one matrix from another matrix.
    /// Inputs are immutable references unlike the basic subtraction operator.
    fn ref_sub(left: &Matrix<f32>, right: &Matrix<f32>) -> Result<Matrix<f32>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f32> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) - right.lindex(idx))
            .collect::<Vec<f32>>();

        let output_mat: Matrix<f32> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Multiply one matrix by another matrix.
    /// Inputs are immutable references unlike the basic multiplication operator.
    fn ref_mul(left: &Matrix<f32>, right: &Matrix<f32>) -> Result<Matrix<f32>> {
        if left.get_cols() != right.get_rows() {
            return Err(Jeeperr::DimensionError)
        }

        let new_n_elements: usize = left.get_rows() * right.get_cols();
        let mut output_data: Vec<f32> = Vec::with_capacity(new_n_elements);

        for lhs_row in 0..left.get_rows() {
            for rhs_col in 0..right.get_cols() {
                let dot_prod: f32 = (0..left.get_cols()).into_iter()
                    .map(|idx| left[[lhs_row, idx]] * right[[idx, rhs_col]])
                    .sum();

                output_data.push(dot_prod);
            }
        }

        let output_mat: Matrix<f32> = Matrix::new(output_data, left.get_rows(), right.get_cols())?;
        Ok(output_mat)
    }

    /// Multiply two matrices elementwise. 
    /// Inputs are immutable references unlike the basic elementwise function.
    fn ref_ewm(left: &Matrix<f32>, right: &Matrix<f32>) -> Result<Matrix<f32>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f32> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) * right.lindex(idx))
            .collect::<Vec<f32>>();

        let output_mat: Matrix<f32> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Divide two matrices elementwise.
    /// Inputs are immutable references unlike the basic elementwise_divide function.
    fn ref_ewd(left: &Matrix<f32>, right: &Matrix<f32>) -> Result<Matrix<f32>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f32> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) / right.lindex(idx))
            .collect::<Vec<f32>>();

        let output_mat: Matrix<f32> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }
}

impl ReferenceOperations<f64> for Matrix<f64> {
    /// Add one matrix to another matrix.
    /// Inputs are immutable references unlike the basic addition operator.
    fn ref_add(left: &Matrix<f64>, right: &Matrix<f64>) -> Result<Matrix<f64>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f64> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) + right.lindex(idx))
            .collect::<Vec<f64>>();

        let output_mat: Matrix<f64> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Negate a matrix.
    /// Input is an immutable reference unlike the basic negation operator.
    fn ref_neg(mat: &Matrix<f64>) -> Matrix<f64> {
        let n_elements: usize = mat.get_rows() * mat.get_cols();
        let output_data: Vec<f64> = (0..n_elements).into_iter()
            .map(|idx| -mat.lindex(idx))
            .collect::<Vec<f64>>();

        let output_mat: Matrix<f64> = Matrix::new(output_data, mat.get_rows(), mat.get_cols()).unwrap();
        return output_mat
    }

    /// Subtract one matrix from another matrix.
    /// Inputs are immutable references unlike the basic subtraction operator.
    fn ref_sub(left: &Matrix<f64>, right: &Matrix<f64>) -> Result<Matrix<f64>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f64> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) - right.lindex(idx))
            .collect::<Vec<f64>>();

        let output_mat: Matrix<f64> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Multiply one matrix by another matrix.
    /// Inputs are immutable references unlike the basic multiplication operator.
    fn ref_mul(left: &Matrix<f64>, right: &Matrix<f64>) -> Result<Matrix<f64>> {
        if left.get_cols() != right.get_rows() {
            return Err(Jeeperr::DimensionError)
        }

        let new_n_elements: usize = left.get_rows() * right.get_cols();
        let mut output_data: Vec<f64> = Vec::with_capacity(new_n_elements);

        for lhs_row in 0..left.get_rows() {
            for rhs_col in 0..right.get_cols() {
                let dot_prod: f64 = (0..left.get_cols()).into_iter()
                    .map(|idx| left[[lhs_row, idx]] * right[[idx, rhs_col]])
                    .sum();

                output_data.push(dot_prod);
            }
        }

        let output_mat: Matrix<f64> = Matrix::new(output_data, left.get_rows(), right.get_cols())?;
        Ok(output_mat)
    }

    /// Multiply two matrices elementwise. 
    /// Inputs are immutable references unlike the basic elementwise function.
    fn ref_ewm(left: &Matrix<f64>, right: &Matrix<f64>) -> Result<Matrix<f64>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f64> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) * right.lindex(idx))
            .collect::<Vec<f64>>();

        let output_mat: Matrix<f64> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }

    /// Divide two matrices elementwise.
    /// Inputs are immutable references unlike the basic elementwise_divide function.
    fn ref_ewd(left: &Matrix<f64>, right: &Matrix<f64>) -> Result<Matrix<f64>> {
        if (left.get_rows() != right.get_rows()) || (left.get_cols() != right.get_cols()) {
            return Err(Jeeperr::DimensionError)
        }

        let n_elements: usize = left.get_rows() * left.get_cols();
        let output_data: Vec<f64> = (0..n_elements).into_iter()
            .map(|idx| left.lindex(idx) / right.lindex(idx))
            .collect::<Vec<f64>>();

        let output_mat: Matrix<f64> = Matrix::new(output_data, left.get_rows(), left.get_cols()).unwrap();
        Ok(output_mat)
    }
}