Struct believer::decoders::simulation_results::SimulationResult

pub struct SimulationResult { /* fields omitted */ }

An interface for simulation result.

Methods

impl SimulationResult

pub fn new() -> Self

Creates a new empty SimulationResult.

pub fn with_n_successes_and_failures(n_successes: u64, n_failures: u64) -> Self

Creates a new SimulationResult from the number of successes and failures.

pub fn worse_result() -> Self

Creates the worse SimulationResult. That is, a simulation with failure rate 1.

pub fn add_decoding_result<D: DecodingResult>(&mut self, result: D)

pub fn has_not_at_least_one_success_and_one_failure(&self) -> bool

pub fn is_better_than(&self, other: &Self) -> bool

Checks if self has better performance than other.

pub fn combine_with(&self, other: SimulationResult) -> Self

pub fn get_effective_failure_rate_for_code_dimension(
    &self,
    dimension: u32
) -> f64

Get the effective failure rate of self for a given code dimension.

This is the equivalent failure rate per bit if dimension similar bits without error correction where used.

Example

use believer::SimulationResult;
let result = SimulationResult::with_n_successes_and_failures(9, 16);
assert_eq!(result.get_effective_failure_rate_for_code_dimension(2), 0.4);

pub fn get_effective_success_rate_for_code_dimension(
    &self,
    dimension: u32
) -> f64

Get the effective success rate of self for a given code dimension.

This is the equivalent success rate per bit if dimension similar bits without error correction where used.

Example

use believer::SimulationResult;
let result = SimulationResult::with_n_successes_and_failures(9, 16);
assert_eq!(result.get_effective_success_rate_for_code_dimension(2), 0.6);

pub fn get_failure_rate(&self) -> f64

Get the failure rate of self.

Example

use believer::SimulationResult;
let result = SimulationResult::with_n_successes_and_failures(9, 16);
assert_eq!(result.get_failure_rate(), 0.64);

pub fn get_success_rate(&self) -> f64

Get the success rate of self.

Example

use believer::SimulationResult;
let result = SimulationResult::with_n_successes_and_failures(9, 16);
assert_eq!(result.get_success_rate(), 0.36);

pub fn get_n_iterations(&self) -> u64

pub fn get_n_failures(&self) -> u64

pub fn get_n_successes(&self) -> u64

Trait Implementations

impl Clone for SimulationResult

fn clone(&self) -> SimulationResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for SimulationResult

impl Eq for SimulationResult

impl PartialEq<SimulationResult> for SimulationResult

fn eq(&self, other: &SimulationResult) -> bool

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

fn ne(&self, other: &SimulationResult) -> bool

This method tests for !=.

impl Debug for SimulationResult

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

Formats the value using the given formatter.

impl StructuralPartialEq for SimulationResult

impl StructuralEq for SimulationResult