Struct Interleaver

pub struct Interleaver { /* private fields */ }

Interleaver for sequences of a given length

Implementations

impl Interleaver

pub fn new(perm: &[usize]) -> Result<Self, Error>

Returns interleaver corresponding to a given permutation.

Parameters

• perm: Permutation of integers in [0, L) for some positive integer L. If the interleaver input is the sequence x[0], x[1], ..., x[L-1], then its output is the sequence x[perm[0]], x[perm[1]], ..., x[perm[L-1]].

Errors

Returns an error if perm is not a permutation of the integers in [0, L) for some positive integer L.

Examples

use pccc::Interleaver;

let perm = [0, 3, 2, 5, 4, 7, 6, 1];
let interleaver = Interleaver::new(&perm)?;

pub fn random(length: usize, rng: &mut ThreadRng) -> Result<Self, Error>

Returns random interleaver for sequences of a given length.

Parameters

• length: Length of input/output sequence.

• rng: Random number generator to be used.

Errors

Returns an error if length is 0.

Examples

use pccc::Interleaver;

let mut rng = rand::thread_rng();
let length = 8;
let interleaver = Interleaver::random(length, &mut rng)?;

pub fn interleave<T: Copy>( &self, input: &[T], output: &mut Vec<T>, ) -> Result<(), Error>

Generates interleaver output given its input.

Parameters

• input: Interleaver input.

• output: Buffer for interleaver output (any pre-existing contents will be cleared).

Errors

Returns an error if input.len() is not equal to self.length.

Examples

use pccc::Interleaver;

let perm = [0, 3, 2, 5, 4, 7, 6, 1];
let interleaver = Interleaver::new(&perm)?;
let input = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'];
let mut output = Vec::new();
interleaver.interleave(&input, &mut output)?;
assert_eq!(output, ['a', 'd', 'c', 'f', 'e', 'h', 'g', 'b']);

pub fn deinterleave<T: Copy>( &self, output: &[T], input: &mut Vec<T>, ) -> Result<(), Error>

Generates interleaver input given its output.

Parameters

• output: Interleaver output.

• input: Buffer for interleaver input (any pre-existing contents will be cleared).

Errors

Returns an error if output.len() is not equal to self.length.

Examples

use pccc::Interleaver;

let perm = [0, 3, 2, 5, 4, 7, 6, 1];
let interleaver = Interleaver::new(&perm)?;
let output = ['a', 'd', 'c', 'f', 'e', 'h', 'g', 'b'];
let mut input = Vec::new();
interleaver.deinterleave(&output, &mut input)?;
assert_eq!(input, ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h']);

Trait Implementations

impl Debug for Interleaver

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

Formats the value using the given formatter.

impl PartialEq for Interleaver

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Interleaver

impl StructuralPartialEq for Interleaver