Struct believer::parity_check_matrix::Check

pub struct Check<'a> { /* fields omitted */ }

A wrapper over a check. It contains the positions of the bits in the check.

Methods

impl<'a> Check<'a>

pub fn dot(&self, other: &[GF2]) -> GF2

Returns the dot product between self and other. In that case, it corresponds to the parity of the overlap.

Example

let parity_check = ParityCheckMatrix::new(
    vec![
        vec![0, 1, 2, 4],
        vec![0, 1, 3, 5],
        vec![0, 2, 3, 6],
    ],
    7
);
let other = vec![GF2::B0, GF2::B1, GF2::B0, GF2::B1, GF2::B0, GF2::B1, GF2::B0];

assert_eq!(parity_check.check(0).unwrap().dot(&other), GF2::B1);
assert_eq!(parity_check.check(1).unwrap().dot(&other), GF2::B1);
assert_eq!(parity_check.check(2).unwrap().dot(&other), GF2::B1);

pub fn positions(&self) -> &[usize]

Returns the positions of the bits in self.

Example

let parity_check = ParityCheckMatrix::new(
    vec![
        vec![0, 1],
        vec![1, 2],
    ],
    3
);

assert_eq!(parity_check.check(0).unwrap().positions(), &[0, 1]);
assert_eq!(parity_check.check(1).unwrap().positions(), &[1, 2]);

Trait Implementations

impl<'a> PartialEq<Check<'a>> for Check<'a>

fn eq(&self, other: &Check<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Check<'a>) -> bool

This method tests for !=.

impl<'a> Debug for Check<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.