Struct ldpc_toolbox::simulation::puncturing::Puncturer

pub struct Puncturer { /* private fields */ }

Puncturer.

This struct is used to perform puncturing on codewords to be transmitted, and “depuncturing” on demodulated LLRs.

Implementations

impl Puncturer

pub fn new(pattern: &[bool]) -> Puncturer

Creates a new puncturer.

The puncturing pattern is defined by blocks. For example [true, true, true, false] means that the first 3/4 of the codeword bits are preserved, and the last 1/4 is punctured.

Panics

This function panics if the pattern is empty.

pub fn puncture<S, A>( &self, codeword: &ArrayBase<S, Ix1> ) -> Result<Array1<A>, Error>where S: Data<Elem = A>, A: Clone,

Puncture a codeword.

Given a codeword, returns the punctured codeword. An error is returned if the length of the codeword is not divisible by the length of the puncturing pattern.

pub fn depuncture<T: Copy + Default>(&self, llrs: &[T]) -> Result<Vec<T>, Error>

Depuncture LLRs.

This function depunctures demodulated LLRs by inserting zeros (which indicate erasures) in the positions of the codeword that were punctured. The input length must correspond to the punctured codeword, while the output length is equal to the codeword length. An error is returned if the length of input is not divisible by the number of true elements in the pattern.

pub fn rate(&self) -> f64

Returns the rate of the puncturer.

The rate is defined as the length of the original codeword divided by the length of the punctured codeword, and so it is always greater or equal to one.

Trait Implementations

impl Clone for Puncturer

fn clone(&self) -> Puncturer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Puncturer

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

Formats the value using the given formatter.