Skip to main content

BitOutcome

Enum BitOutcome 

Source
#[repr(u8)]
pub enum BitOutcome { Clean = 0, Corrected = 1, Uncorrected = 2, Introduced = 3, }
Expand description

What the channel and the inner decoder each did to one coded bit.

Derived by comparing three bit-streams in the coded-bit index space — what the transmitter sent, what arrived at the demapper, and what the inner decoder’s own output re-encodes to:

Statearrived correctdecoder agreesMeaning
Cleanyesyesthe channel did not touch it
Correctednoyesthe inner code fixed it
Uncorrectednonoarrived wrong, still wrong — the outer code’s problem now
Introducedyesnoarrived right, the decoder broke it

Introduced is not padding for the fourth cell. A belief-propagation decoder that fails to converge flips correct bits, and one that does so at high SNR is broken. Having the state means the map can show that; folding it into Uncorrected would hide the symptom in with its opposite.

Variants§

§

Clean = 0

Arrived correct and the decoder left it correct.

§

Corrected = 1

Arrived wrong; the inner decoder fixed it.

§

Uncorrected = 2

Arrived wrong and the inner decoder did not fix it.

§

Introduced = 3

Arrived correct and the inner decoder broke it.

Implementations§

Source§

impl BitOutcome

Source

pub fn arrived_wrong(self) -> bool

Whether the channel corrupted this bit — i.e. anything but Clean or Introduced.

Counting these over a frame and dividing by its coded-bit count reproduces channel_ber exactly: the map is that rate’s per-bit expansion, not a second measurement of it.

This says nothing about the decoder. Both states it matches mean “arrived wrong”; whether the decoder then fixed it is the other half of the map, and decoder_disagreed is how to ask. A consumer checking only this one is blind to the estimate stream entirely — see that method’s note.

Source

pub fn decoder_disagreed(self) -> bool

Whether the inner decoder’s output still disagrees with the truth at this bit — i.e. Uncorrected or Introduced.

The dual of arrived_wrong: that one is the channel’s half of the map, this is the decoder’s. Both halves need a name, because this predicate is the map’s whole meaning and a consumer that spells it out by hand can get it subtly wrong with nothing to say so.

The two are independent, not complementary. Corrected is arrived_wrong && !decoder_disagreed; Introduced is the reverse; a bit can be both (Uncorrected) or neither (Clean).

Trait Implementations§

Source§

impl Clone for BitOutcome

Source§

fn clone(&self) -> BitOutcome

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BitOutcome

Source§

impl Debug for BitOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BitOutcome

Source§

fn default() -> BitOutcome

Returns the “default value” for a type. Read more
Source§

impl Eq for BitOutcome

Source§

impl PartialEq for BitOutcome

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BitOutcome

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.