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
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

use crate::ParityCheckMatrix;
use itertools::Itertools;
use std::cmp::Ordering;

#[derive(Debug)]
pub(crate) struct SparseMatrix<'a> {
    values: Vec<f64>,
    row_ranges: &'a [usize],
    column_indices: &'a [usize],
}

impl<'a> SparseMatrix<'a> {
    pub(crate) fn from_parity_check(parity_check: &'a ParityCheckMatrix, values: Vec<f64>) -> Self {
        if parity_check.get_n_edges() != values.len() {
            panic!("wrong number of values");
        }
        Self {
            values,
            row_ranges: parity_check.check_ranges(),
            column_indices: parity_check.bit_indices(),
        }
    }

    pub(crate) fn rows_iter(&self) -> RowsIter {
        RowsIter {
            matrix: &self,
            active_row: 0,
        }
    }

    pub(crate) fn row_slice(&self, row: usize) -> Option<RowSlice> {
        self.row_ranges.get(row).and_then(|&row_start| {
            self.row_ranges.get(row + 1).map(|&row_end| RowSlice {
                values: &self.values[row_start..row_end],
                positions: &self.column_indices[row_start..row_end],
                active: 0,
            })
        })
    }

    pub(crate) fn values(&self) -> &[f64] {
        &self.values
    }
}

pub(crate) struct RowsIter<'a> {
    matrix: &'a SparseMatrix<'a>,
    active_row: usize,
}

impl<'a> Iterator for RowsIter<'a> {
    type Item = RowSlice<'a>;

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

#[derive(Debug)]
pub(crate) struct RowSlice<'a> {
    values: &'a [f64],
    positions: &'a [usize],
    active: usize,
}

impl<'a> Iterator for RowSlice<'a> {
    type Item = (&'a f64, &'a usize);

    fn next(&mut self) -> Option<Self::Item> {
        let val_pos = self
            .values
            .get(self.active)
            .and_then(|val| self.positions.get(self.active).map(|pos| (val, pos)));
        self.active += 1;
        val_pos
    }
}

pub(crate) struct Transposer {
    indices: Vec<usize>,
    row_ranges: Vec<usize>,
    column_indices: Vec<usize>,
}

impl Transposer {
    pub(crate) fn new(parity_check: &ParityCheckMatrix) -> Self {
        let mut indices = Vec::with_capacity(parity_check.get_n_bits());
        let mut column_indices = Vec::with_capacity(parity_check.get_n_bits());
        let mut row_ranges = Vec::new();
        row_ranges.push(0);

        let mut active_col = 0;
        let mut row_lenght = 0;

        parity_check
            .edges_iter()
            .enumerate()
            .sorted_by(|(_, (r_0, c_0)), (_, (r_1, c_1))| match c_0.cmp(c_1) {
                Ordering::Equal => r_0.cmp(r_1),
                otherwise => otherwise,
            })
            .for_each(|(idx, (row, col))| {
                if col == active_col {
                    row_lenght += 1;
                } else {
                    while active_col < col {
                        active_col += 1;
                        row_ranges.push(*row_ranges.last().unwrap_or(&0) + row_lenght);
                    }
                    row_lenght = 1;
                }
                column_indices.push(row);
                indices.push(idx);
            });

        row_ranges.push(*row_ranges.last().unwrap_or(&0) + row_lenght);

        Transposer {
            indices,
            row_ranges,
            column_indices,
        }
    }

    pub(crate) fn transpose(&self, matrix: &SparseMatrix) -> SparseMatrix {
        SparseMatrix {
            values: self
                .indices
                .iter()
                .map(|idx| matrix.values()[*idx])
                .collect(),
            row_ranges: &self.row_ranges,
            column_indices: &self.column_indices,
        }
    }
}