sparsemat 0.2.0

A simple sparse matrix library
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
231
232

pub mod types;
pub mod indexlist;
#[macro_use]
pub mod sparsematrix;
pub mod sparsemat_indexlist;
pub mod sparsemat_crs;
pub mod sparsemat_rowvec;
pub mod sparsemat_par;
#[macro_use]
pub mod vector;
pub mod densevec;
pub mod sparsevec;
pub mod linearsolver;

pub use self::sparsematrix::*;
pub use self::sparsemat_indexlist::*;
pub use self::sparsemat_crs::*;
pub use self::sparsemat_rowvec::*;
pub use self::sparsevec::*;
pub use self::vector::*;
pub use self::densevec::*;

#[cfg(test)]
mod tests {
    use crate::sparsematrix::*;
    use crate::sparsemat_indexlist::*;
    use crate::sparsemat_crs::*;
    use crate::sparsemat_rowvec::*;
    use crate::sparsemat_par::*;
    use crate::indexlist::*;
    use crate::sparsevec::*;
    use crate::vector::*;
    use crate::densevec::*;
    use crate::linearsolver::*;

    #[test]
    fn check_cg<'a>() {
        let mut mat = SparseMatIndexList::<f64, u32>::new();
        mat.set(0, 0, 4.0);
        mat.set(0, 1, 1.0);
        mat.set(1, 0, 1.0);
        mat.set(1, 1, 3.0);
        let mut b = DenseVec::<f64>::new();
        b.set(0, 1.0);
        b.set(1, 2.0);
        let mut x = DenseVec::<f64>::new();
        x.set(0, 2.0);
        x.set(1, 1.0);
        let cg = ConjugateGradient::default();
        cg.solve(&mat, &b, &mut x);
        assert_eq!((x.get(0) * 10000f64).floor() / 10000f64, 0.0909);
    }

    #[test]
    fn check_sparsemat_indexlist() {
        //check_mat::<SparseMatIndexList<f32, u32>>();
        let mut sp = SparseMatIndexList::<f32, u32>::with_capacity(3);
        sp.add_to(0, 1, 4.2);
        sp.add_to(1, 2, 4.12);
        sp.add_to(2, 2, 2.12);
        sp.add_to(1, 1, 1.12);
        *sp.get_mut(1, 1) += 1.12;
        *sp.get_mut(0, 2) += 0.12;
        *sp.get_mut(0, 0) = 8.12;
        sp.set(0, 0, 7.12);
        assert_eq!(sp.get(0, 0), 7.12);
        let mut iter = sp.iter();
        assert_eq!(iter.next(), Some((0, 1, &4.2)));
        assert_eq!(iter.next(), Some((0, 2, &0.12)));
        assert_eq!(iter.next(), Some((0, 0, &7.12)));
        assert_eq!(iter.next(), Some((1, 2, &4.12)));
        let mut iter_row = sp.iter_row(2);
        assert_eq!(iter_row.next(), Some((&2, &2.12)));
        let sum = sp.clone() + sp.clone();
        assert_eq!(sum.get(0, 0), 14.24);
        let sub = sum.clone() - sp.clone();
        assert_eq!(sub.get(0, 0), sp.get(0, 0));
        let mul = sp.clone() * 2.0;
        assert_eq!(mul.get(0, 0), sum.get(0, 0));
        let v = DenseVec::from_vec(vec![2.0, 4.8, 1.2]);
        let mvp = sp.clone() * v;
        assert_eq!(mvp.get(0), 34.544);
        assert_eq!(sp.density(), 6.0 / 9.0);

        // Test column iter
        sp.assemble_column_info();
        let mut iter_col = sp.iter_col(2).unwrap();
        assert_eq!(iter_col.next(), Some((&1, &4.12)));
        assert_eq!(iter_col.next(), Some((&2, &2.12)));
        assert_eq!(iter_col.next(), Some((&0, &0.12)));
        assert_eq!(iter_col.next(), None);

        // Test sorting functionality and conversion to CRS
        let sp_crs = sp.to_crs();
        let row_str = sp.to_string_row(1);
        assert_eq!(row_str, "0 2.24 4.12 ");
        let row_str = sp_crs.to_string_row(1);
        assert_eq!(row_str, "0 2.24 4.12 ");

        // Test matrix product
        let mp = sp_crs.prod(&sp).unwrap();
        assert_eq!(mp.get(1, 2), 17.9632);

        // Add different matrix type
        sp.add(&sp_crs);
        let row_str = sp.to_string_row(1);
        assert_eq!(row_str, "0 4.48 8.24 ");

        sp.sort();
        sp.sort_row(1);
        sp.to_pbm("test.pbm".to_string());
    }

    #[test]
    fn check_sparsemat_crs() {
        let mut sp_crs = SparseMatCRS::<f32, u32>::with_capacity(3);
        sp_crs.add_to(0, 1, 4.2);
        sp_crs.add_to(2, 2, 2.12);
        sp_crs.add_to(1, 2, 4.12);
        sp_crs.add_to(3, 2, 1.12);
        sp_crs.add_to(3, 3, 5.12);
        let mut iter = sp_crs.iter();
        assert_eq!(iter.next(), Some((0, 1, &4.2)));
        assert_eq!(iter.next(), Some((1, 2, &4.12)));
        assert_eq!(iter.next(), Some((2, 2, &2.12)));
        assert_eq!(iter.next(), Some((3, 3, &5.12)));
        assert_eq!(iter.next(), Some((3, 2, &1.12)));
        assert_eq!(iter.next(), None);
        //let mut iter_all = sp_crs.iter_all();
        //assert_eq!(iter_all.next(), Some((0, 1, &4.2)));
        //assert_eq!(iter_all.next(), Some((1, 2, &4.12)));
        //assert_eq!(iter_all.next(), Some((2, 2, &2.12)));
        //assert_eq!(iter_all.next(), Some((3, 3, &5.12)));
        //assert_eq!(iter_all.next(), Some((3, 2, &1.12)));
        //assert_eq!(iter_all.next(), None);

        // Test column iter
        sp_crs.assemble_column_info();
        let mut iter_col = sp_crs.iter_col(2).unwrap();
        assert_eq!(iter_col.next(), Some((&1, &4.12)));
        assert_eq!(iter_col.next(), Some((&2, &2.12)));
        assert_eq!(iter_col.next(), Some((&3, &1.12)));
        assert_eq!(iter_col.next(), None);

        let mut iter_row = sp_crs.iter_row(0);
        assert_eq!(iter_row.next(), Some((&1, &4.2)));
        assert_eq!(iter_row.next(), None);
        let mut iter_row = sp_crs.iter_row(5);
        assert_eq!(iter_row.next(), None);
        let v = DenseVec::from_vec(vec![2.0, 4.8, 1.2, 3.4]);
        let mvp = sp_crs.clone() * v;
        assert_eq!(mvp.get(0), 20.16);
        assert_eq!(sp_crs.density(), 5.0 / 16.0);
    }

    #[test]
    fn check_sparsemat_rowvec() {
        let mut sp = SparseMatRowVec::<f32, u32>::with_capacity(3);
        sp.add_to(0, 1, 4.2);
        sp.add_to(1, 2, 4.12);
        sp.add_to(2, 2, 2.12);
        sp.add_to(1, 1, 1.12);
        *sp.get_mut(1, 1) += 1.12;
        *sp.get_mut(0, 2) += 0.12;
        *sp.get_mut(0, 0) = 8.12;
        sp.set(0, 0, 7.12);
        assert_eq!(sp.get(0, 0), 7.12);
        assert_eq!(sp.get(0, 1), 4.2);
        let mut iter = sp.iter();
        assert_eq!(iter.next(), Some((0, 1, &4.2)));
        assert_eq!(iter.next(), Some((0, 2, &0.12)));
        assert_eq!(iter.next(), Some((0, 0, &7.12)));
        assert_eq!(iter.next(), Some((1, 2, &4.12)));
        let v = DenseVec::from_vec(vec![2.0, 4.8, 1.2]);
        let mvp = sp.mvp(&v);
        assert_eq!(mvp.get(0), 34.544);
        assert_eq!(sp.density(), 6.0 / 9.0);
    }

    #[test]
    fn check_sparsemat_par() {
        let mut mat_par = SparseMatPar::<SparseMatIndexList::<f32, u32>>::with_sub_matrices(4, 16);
        mat_par.add_to(0, 1, 4.2);
        mat_par.add_to(1, 2, 4.12);
        mat_par.add_to(2, 2, 2.12);
        mat_par.add_to(1, 1, 1.12);
        *mat_par.get_mut(1, 1) += 1.12;
        *mat_par.get_mut(0, 2) += 0.12;
        *mat_par.get_mut(0, 0) = 8.12;
        mat_par.set(0, 0, 7.12);
        assert_eq!(mat_par.get(0, 0), 7.12);
        assert_eq!(mat_par.get(0, 1), 4.2);
        let mut iter = mat_par.iter();
        assert_eq!(iter.next(), Some((0, 1, &4.2)));
        assert_eq!(iter.next(), Some((0, 2, &0.12)));
        assert_eq!(iter.next(), Some((0, 0, &7.12)));
        assert_eq!(iter.next(), Some((1, 2, &4.12)));
        let v = DenseVec::from_vec(vec![2.0, 4.8, 1.2]);
        let mvp = mat_par.mvp(&v);
        assert_eq!(mvp.get(0), 34.544);
        assert_eq!(mat_par.density(), 6.0 / 9.0);
    }

    #[test]
    fn check_indexlist() {
        let mut list = IndexList::<u16>::new();
        list.push(1);
        list.push(1);
        list.push(2);
        list.push(4);
        list.push(1);
        assert_eq!(list.iter_row(0).next(), None);
        assert_eq!(list.n_entries(), 5);
        let mut iter = list.iter_row(1);
        assert_eq!(iter.next(), Some(0));
        assert_eq!(iter.next(), Some(1));
        assert_eq!(iter.next(), Some(4));
    }

    #[test]
    fn check_sparsevec() {
        let mut sv = SparseVec::<f64, u16>::new();
        sv.set(8, 6.0);
        sv.set(80, 6.4);
        sv.set(55, 8.2);
        sv.set(4, 4.0);
        let mut iter = sv.iter_sparse();
        assert_eq!(iter.next(), Some((&8, &6.0)));
        assert_eq!(iter.next(), Some((&80, &6.4)));
        assert_eq!(sv.get(4), 4.0);
    }
}