mtl 0.1.5

Matrix template library. Dense2D matrix, SparseMatrix.
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

use std::iter;
use std::fmt;

use super::coo::CooMatrix;

/// Compressed Sparse Column matrix
#[derive(Clone, PartialEq, Eq)]
pub struct CscMatrix<T> {
    shape: (usize, usize),
    data: Vec<T>,           // Data array of the matrix
    indices: Vec<usize>,    // CSC format index array
    indptr: Vec<usize>      // CSC format index pointer array
}


impl<T: Copy> CscMatrix<T> {
    pub fn empty(shape: (usize,usize)) -> Self {
        let n = shape.1;
        CscMatrix {
            shape: shape,
            data: vec![],
            indices: vec![],
            indptr: iter::repeat(0).take(n).collect()
        }
    }

    #[inline]
    pub fn nnz(&self) -> usize {
        self.data.len()
    }

    #[inline]
    pub fn shape(&self) -> (usize,usize) {
        self.shape
    }

    /// Returns the element of the given index, or None if not exists
    pub fn get(&self, index: (usize, usize)) -> Option<&T> {
        let (row, col) = index;
        assert!(row < self.shape.0);
        assert!(col < self.shape.1);

        let col_start_idx = self.indptr[col];
        let col_end_idx = self.indptr[col+1];

        for i in col_start_idx .. col_end_idx {
            if self.indices[i] == row {
                return self.data.get(i);
            }
        }
        None
    }

    /// Returns mutable ref of the element of the given index, None if not exists
    pub fn get_mut(&mut self, index: (usize, usize)) -> Option<&mut T> {
        let (row, col) = index;
        assert!(row < self.shape.0);
        assert!(col < self.shape.1);

        let col_start_idx = self.indptr[col];
        let col_end_idx = self.indptr[col+1];

        for i in col_start_idx .. col_end_idx {
            if self.indices[i] == row {
                return self.data.get_mut(i);
            }
        }
        None
    }

    pub fn set(&mut self, index: (usize, usize), it: T) {
        let (row, col) = index;
        assert!(row < self.shape.0);
        assert!(col < self.shape.1);

        let col_start_idx = self.indptr[col];
        let col_end_idx = self.indptr[col+1];

        let mut data_insert_pos = col_start_idx;
        for i in col_start_idx .. col_end_idx {
            if self.indices[i] == row {
                self.data[i] = it;
                return;
            } else if self.indices[i] > row {
                data_insert_pos = i;
                break;
            }
        }

        println!("WARNING: Changing the sparsity structure of a CSC matrix is expensive.");
        self.data.insert(data_insert_pos, it);
        for (i, idx) in self.indptr.iter_mut().enumerate() {
            if i > col {
                *idx += 1;
            }
        }
        self.indices.insert(data_insert_pos, row);
    }

    // convertion
    pub fn to_bsr(&self) -> () {
        unimplemented!()
    }

    pub fn to_coo(&self) -> CooMatrix<T> {
        let mut data = Vec::new();
        let mut row = vec![];
        let mut col = vec![];
        for (j, &ptr) in self.indptr.iter().take(self.shape.1).enumerate() {
            for (off, val) in self.data[ptr .. self.indptr[j+1]].iter().enumerate() {
                let i = self.indices[ptr + off];
                data.push(*val);
                row.push(i);
                col.push(j);
            }
        }
        CooMatrix {
            shape: self.shape(),
            data: data,
            row: row,
            col: col
        }
    }

    pub fn to_csc(&self) -> CscMatrix<T> {
        self.clone()
    }
}

impl<T: Copy + fmt::Display> fmt::Display for CscMatrix<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        for (j, &ptr) in self.indptr.iter().take(self.shape.1).enumerate() {
            for (off, val) in self.data[ptr .. self.indptr[j+1]].iter().enumerate() {
                let i = self.indices[ptr + off];
                try!(writeln!(f, "  {:?}\t{}", (i, j), val));
            }
        }
        Ok(())
    }
}


#[test]
fn test_csc() {
    let mut mat = CscMatrix {
        shape: (6, 6),
        data: vec![10, 45, 40, 2, 4, 3, 3, 9, 19, 7],
        indptr: vec![0, 3, 5, 8, 8, 8, 10],
        indices: vec![0, 1, 3, 0, 2, 0, 1, 2, 0, 5]
    };

    assert_eq!(format!("{}", mat).lines().count(), 10);
    mat.set((3, 4), 20);
    assert_eq!(format!("{}", mat).lines().count(), 11);

}