sparse-bin-mat 0.7.0

A sparse implementation of a binary matrix optimized for row operations
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

use super::SparseBinMat;
use crate::SparseBinSlice;

/// An iterator over the rows of matrix.
///
/// See the [`rows`](SparseBinMat::rows) method.
#[derive(Debug, Clone, PartialEq)]
pub struct Rows<'a> {
    matrix: &'a SparseBinMat,
    front: usize,
    back: usize,
}

impl<'a> Rows<'a> {
    pub(super) fn from(matrix: &'a SparseBinMat) -> Self {
        Self {
            matrix,
            front: 0,
            back: matrix.number_of_rows(),
        }
    }
}

impl<'a> Iterator for Rows<'a> {
    type Item = SparseBinSlice<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.front < self.back {
            let row = self.matrix.row(self.front);
            self.front += 1;
            row
        } else {
            None
        }
    }
}

impl<'a> DoubleEndedIterator for Rows<'a> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if self.back > self.front {
            self.back -= 1;
            self.matrix.row(self.back)
        } else {
            None
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn checks_iterator() {
        let rows = vec![vec![0, 1, 2], vec![2, 3], vec![0, 3], vec![1, 2, 3]];
        let matrix = SparseBinMat::new(4, rows.clone());
        let mut iter = Rows::from(&matrix);

        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[0])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[1])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[2])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[3])));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn checks_iterator_for_empty_matrix() {
        let matrix = SparseBinMat::empty();
        let mut iter = Rows::from(&matrix);
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn reverse_checks_iterator() {
        let rows = vec![vec![0, 1, 2], vec![2, 3], vec![0, 3], vec![1, 2, 3]];
        let matrix = SparseBinMat::new(4, rows.clone());
        let mut iter = Rows::from(&matrix).rev();

        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[3])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[2])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[1])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[0])));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn bothway_checks_iterator() {
        let rows = vec![vec![0, 1, 2], vec![2, 3], vec![0, 3], vec![1, 2, 3]];
        let matrix = SparseBinMat::new(4, rows.clone());
        let mut iter = Rows::from(&matrix);

        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[0])));
        assert_eq!(iter.next_back(), Some(SparseBinSlice::new(4, &rows[3])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[1])));
        assert_eq!(iter.next(), Some(SparseBinSlice::new(4, &rows[2])));
        assert_eq!(iter.next_back(), None);
        assert_eq!(iter.next(), None);
    }
}