believer 0.2.1

A toolbox to simulate error correcting code performance.
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

//! An iterator over the checks of a parity check matrix.

use super::{CheckView, ParityCheckMatrix};

/// An iterator over the checks of a parity check matrix.
///
/// Returns a `CheckView` at each iteration.
pub struct ChecksIter<'a> {
    matrix: &'a ParityCheckMatrix,
    active_check: usize,
}

impl<'a> ChecksIter<'a> {
    pub(super) fn from(matrix: &'a ParityCheckMatrix) -> Self {
        Self {
            matrix,
            active_check: 0,
        }
    }
}

impl<'a> Iterator for ChecksIter<'a> {
    type Item = CheckView<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        let slice = self.matrix.get_check(self.active_check);
        self.active_check += 1;
        slice
    }
}

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

    #[test]
    fn checks_iterator() {
        let checks = vec![vec![0, 1, 2], vec![2, 3], vec![0, 3], vec![1, 2, 3]];
        let matrix = ParityCheckMatrix::with_n_bits(4).with_checks(checks);
        let mut iter = ChecksIter::from(&matrix);

        assert_eq!(iter.next(), Some(CheckView::from_slice(&[0, 1, 2])));
        assert_eq!(iter.next(), Some(CheckView::from_slice(&[2, 3])));
        assert_eq!(iter.next(), Some(CheckView::from_slice(&[0, 3])));
        assert_eq!(iter.next(), Some(CheckView::from_slice(&[1, 2, 3])));
        assert_eq!(iter.next(), None);
    }

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