Struct Interleaver 

pub struct Interleaver { /* private fields */ }

A permutation of the positions of a block.

Implementations

impl Interleaver

pub fn from_permutation(perm: Vec<usize>) -> Result<Interleaver>

The interleaver of the permutation perm: output position $i$ takes input position perm[i].

Errors

comnum_core::Error::Config if perm is not a permutation of $0, \dots, n - 1$.

Examples

use comnum_fec::interleaving::Interleaver;
let p = Interleaver::from_permutation(vec![2, 0, 1])?;
assert_eq!(p.interleave(&['a', 'b', 'c']), ['c', 'a', 'b']);
assert!(Interleaver::from_permutation(vec![0, 0, 1]).is_err());

pub fn perm(&self) -> &[usize]

$\pi$: output position $i$ takes input position perm()[i].

pub fn block(rows: usize, cols: usize) -> Interleaver

Write row by row into rows × cols, read column by column.

pub fn random(n: usize, seed: u64) -> Interleaver

A uniform random permutation of n positions (seeded).

pub fn qpp(k: usize, f1: usize, f2: usize) -> Result<Interleaver>

The quadratic permutation polynomial $\pi(i) = (f_{1} i + f_{2} i^{2}) \bmod K$.

Errors

comnum_core::Error::Config if the polynomial is not a permutation.

pub fn from_name(name: &str, k: usize) -> Result<Interleaver>

The interleaver of a standard by name, for blocks of k bits: lte, the QPP interleaver of the LTE turbo code (crate::turbo::lte_qpp, TS 36.212, Table 5.1.3-3), case-insensitive.

Errors

comnum_core::Error::Config for another name, or a size k outside the table.

pub fn len(&self) -> usize

Length of the block.

pub fn is_empty(&self) -> bool

Whether the block is empty.

pub fn interleave<T: Copy>(&self, x: &[T]) -> Vec<T>

$y_{i} = x_{\pi(i)}$.

Panics

If x is shorter than the permutation.

pub fn deinterleave<T: Copy + Default>(&self, y: &[T]) -> Vec<T>

The inverse permutation.

Panics

If y is shorter than the permutation.

Trait Implementations

impl Clone for Interleaver

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interleaver

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

Formats the value using the given formatter.

impl Eq for Interleaver

impl PartialEq for Interleaver

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Interleaver