Struct believer::parity_check_matrix::check_view::CheckView

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

A view over a check of a parity check matrix.

Methods

impl<'a> CheckView<'a>

pub fn iter(&self) -> Iter<usize>

An iterator over the bits in self.

pub fn compute_syndrome(&self, message: &[GF2]) -> GF2

Returns the syndrome of a given message. That is, returns the dot product between self and message.

Example

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

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

pub fn has_non_zero_syndrome(&self, message: &[GF2]) -> bool

Returns true if the syndrome of message is GF2::B1.

pub fn has_zero_syndrome(&self, message: &[GF2]) -> bool

Returns true if the syndrome of message is GF2::B0.

pub fn get_n_bits(&self) -> usize

Returns the number of bits connected to self.

pub fn spread(&self) -> usize

Returns the spread of self.

Example

let parity_check = ParityCheckMatrix::with_n_bits(6).with_checks(
    vec![
        vec![0, 1],
        vec![1, 2, 5],
        vec![3],
        vec![0, 4],
    ]
);

assert_eq!(parity_check.get_check(0).unwrap().spread(), 2);
assert_eq!(parity_check.get_check(1).unwrap().spread(), 5);
assert_eq!(parity_check.get_check(2).unwrap().spread(), 1);
assert_eq!(parity_check.get_check(3).unwrap().spread(), 5);

pub fn max(&self) -> usize

Returns the bit connected to self with maximal index.

Example

let parity_check = ParityCheckMatrix::with_n_bits(6).with_checks(
    vec![
        vec![0, 1],
        vec![1, 2, 5],
        vec![3],
        vec![0, 4],
    ]
);

assert_eq!(parity_check.get_check(0).unwrap().max(), 1);
assert_eq!(parity_check.get_check(1).unwrap().max(), 5);
assert_eq!(parity_check.get_check(2).unwrap().max(), 3);
assert_eq!(parity_check.get_check(3).unwrap().max(), 4);

pub fn min(&self) -> usize

Returns the bit connected to self with minimal index if self

Example

let parity_check = ParityCheckMatrix::with_n_bits(6).with_checks(
    vec![
        vec![0, 1],
        vec![1, 2, 5],
        vec![3],
        vec![0, 4],
    ]
);

assert_eq!(parity_check.get_check(0).unwrap().min(), 0);
assert_eq!(parity_check.get_check(1).unwrap().min(), 1);
assert_eq!(parity_check.get_check(2).unwrap().min(), 3);
assert_eq!(parity_check.get_check(3).unwrap().min(), 0);

pub fn to_vec(&self) -> Vec<usize>

Copies self into a new Vec.

Trait Implementations

impl<'a> AsRef<[usize]> for CheckView<'a>

fn as_ref(&self) -> &[usize]

Returns the indices of the bits connected to self as a slice.

impl<'a> PartialEq<CheckView<'a>> for CheckView<'a>

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

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

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

This method tests for !=.

impl<'a> Debug for CheckView<'a>

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

Formats the value using the given formatter.

impl<'a> StructuralPartialEq for CheckView<'a>