Struct believer::decoders::erasure::ErasureDecoder

pub struct ErasureDecoder { /* fields omitted */ }

Decoder for classical erasure channel.

Example

let code = ParityCheckMatrix::with_n_bits(3).with_checks(vec![vec![0, 1], vec![1, 2]]);
let decoder = ErasureDecoder::with_prob(0.25).for_code(code);
decoder.decode(&decoder.get_random_error());

Methods

impl ErasureDecoder

pub fn with_prob(erasure_prob: f64) -> Self

Creates an erasure decoder.

Panic

Panics if erasure_prob is not between 0.0 and 1.0.

Trait Implementations

impl Decoder for ErasureDecoder

type Error = Vec<usize>

The type of error that the decoder can decode.

type Result = ErasureResult

The type of result the decoder is returning.

type Code = ParityCheckMatrix

The type of code the decoder is using.

fn for_code(self, code: Self::Code) -> Self

Creates a new decoder similar to self that use code without changing the other parameter. This consume code.

fn take_code(&mut self) -> Self::Code

Takes the code out of the decoder leaving an empty set of code instead.

fn decode(&self, error: &Self::Error) -> Self::Result

Tries to decode a given error.

fn get_random_error_with_rng<R: Rng>(&self, rng: &mut R) -> Self::Error

Generates a random error with random number generator rng.

fn get_random_error(&self) -> Self::Error

Generates a random error with the default random number generator.

fn decode_random_error_with_rng<R: Rng>(&self, rng: &mut R) -> Self::Result

Generates and decodes a random error.

fn decode_random_error(&self) -> Self::Result

Generates and decodes a random error.

fn simulate_n_iterations_with_rng<R: Rng>(
    &self,
    n_iterations: usize,
    rng: &mut R
) -> SimulationResult

Simulates decoding random error using self for n_iterations with random number generator rng.

fn simulate_n_iterations(&self, n_iterations: usize) -> SimulationResult

Simulates decoding random error using self for n_iterations using the thread random number generator rng.

fn simulate_until_n_events_are_found_with_rng<R: Rng>(
    &self,
    n_events: usize,
    rng: &mut R
) -> SimulationResult

Simulates the decoder until n_events are found with random number generator rng.

fn simulate_until_n_events_are_found(&self, n_events: usize) -> SimulationResult

Simulates the decoder until n_events are found with the thread random number generator rng.

impl Debug for ErasureDecoder

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

Formats the value using the given formatter.