Struct BerTest

Source
pub struct BerTest<Mod: Modulation, Dec = DecoderImplementation> { /* private fields */ }
Expand description

BER test.

This struct is used to configure and run a BER test.

Implementations§

Source§

impl<Mod: Modulation, Dec: DecoderFactory> BerTest<Mod, Dec>

Source

pub fn new( h: SparseMatrix, decoder_implementation: Dec, puncturing_pattern: Option<&[bool]>, interleaving_columns: Option<isize>, max_frame_errors: u64, max_iterations: usize, ebn0s_db: &[f32], reporter: Option<Reporter>, bch_max_errors: u64, ) -> Result<BerTest<Mod, Dec>, Error>

Creates a new BER test.

The parameters required to define the test are the parity check matrix h, an optional puncturing pattern (which uses the semantics of Puncturer), an optional interleaving pattern, the maximum number of frame errors at which to stop the simulation for each Eb/N0, the maximum number of iterations of the LDPC decoder, a list of Eb/N0’s in dB units, and an optional Reporter to send messages about the test progress.

This function only defines the BER test. To run it it is necessary to call the BerTest::run method.

Source

pub fn run(self) -> Result<Vec<Statistics>, Box<dyn Error>>

Runs the BER test.

This function runs the BER test until completion. It returns a list of statistics for each Eb/N0, or an error.

Trait Implementations§

Source§

impl<Mod: Modulation, Dec: DecoderFactory> Ber for BerTest<Mod, Dec>

Source§

fn run(self: Box<Self>) -> Result<Vec<Statistics>, Box<dyn Error>>

Runs the BER test. Read more
Source§

fn n(&self) -> usize

Returns the frame size of the code. Read more
Source§

fn n_cw(&self) -> usize

Returns the codeword size of the code. Read more
Source§

fn k(&self) -> usize

Returns the number of information bits of the code.
Source§

fn rate(&self) -> f64

Returns the rate of the code.
Source§

impl<Mod: Debug + Modulation, Dec: Debug> Debug for BerTest<Mod, Dec>
where Mod::Modulator: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Mod, Dec> Freeze for BerTest<Mod, Dec>
where Dec: Freeze, <Mod as Modulation>::Modulator: Freeze,

§

impl<Mod, Dec> RefUnwindSafe for BerTest<Mod, Dec>

§

impl<Mod, Dec> Send for BerTest<Mod, Dec>
where Dec: Send,

§

impl<Mod, Dec> Sync for BerTest<Mod, Dec>
where Dec: Sync, <Mod as Modulation>::Modulator: Sync,

§

impl<Mod, Dec> Unpin for BerTest<Mod, Dec>
where Dec: Unpin, <Mod as Modulation>::Modulator: Unpin,

§

impl<Mod, Dec> UnwindSafe for BerTest<Mod, Dec>
where Dec: UnwindSafe, <Mod as Modulation>::Modulator: UnwindSafe,

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V