ldpc 0.7.0

A toolbox for classical and quantum LDPC codes.
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

use super::LinearCode;
use sparse_bin_mat::NonTrivialElements;

#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub struct Edge {
    pub bit: usize,
    pub check: usize,
}

#[derive(Debug, Clone)]
pub struct Edges<'code> {
    elements: NonTrivialElements<'code>,
}

impl<'code> Edges<'code> {
    pub(super) fn new(code: &'code LinearCode) -> Self {
        Self {
            elements: code.parity_check_matrix().non_trivial_elements(),
        }
    }
}

impl<'code> Iterator for Edges<'code> {
    type Item = Edge;

    fn next(&mut self) -> Option<Self::Item> {
        self.elements.next().map(|(check, bit)| Edge { bit, check })
    }
}

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

    #[test]
    fn edges_of_hamming_code() {
        let code = LinearCode::hamming_code();
        let mut edges = code.edges();

        assert_eq!(edges.next(), Some(Edge { bit: 3, check: 0 }));
        assert_eq!(edges.next(), Some(Edge { bit: 4, check: 0 }));
        assert_eq!(edges.next(), Some(Edge { bit: 5, check: 0 }));
        assert_eq!(edges.next(), Some(Edge { bit: 6, check: 0 }));

        assert_eq!(edges.next(), Some(Edge { bit: 1, check: 1 }));
        assert_eq!(edges.next(), Some(Edge { bit: 2, check: 1 }));
        assert_eq!(edges.next(), Some(Edge { bit: 5, check: 1 }));
        assert_eq!(edges.next(), Some(Edge { bit: 6, check: 1 }));

        assert_eq!(edges.next(), Some(Edge { bit: 0, check: 2 }));
        assert_eq!(edges.next(), Some(Edge { bit: 2, check: 2 }));
        assert_eq!(edges.next(), Some(Edge { bit: 4, check: 2 }));
        assert_eq!(edges.next(), Some(Edge { bit: 6, check: 2 }));

        assert_eq!(edges.next(), None);
    }
}