Struct PolarCode 

pub struct PolarCode { /* private fields */ }

A polar code of length $N$ with $K$ information bits.

Implementations

impl PolarCode

pub fn new(n: usize, k: usize, design_ebn0_db: f64) -> Result<PolarCode>

The code of length n (a power of two) with k information bits, built by the Gaussian approximation at the design $E_{b}/N_{0}$ design_ebn0_db.

Errors

comnum_core::Error::Config unless $N$ is a power of two, $0 < K \le N$ and the design $E_{b}/N_{0}$ is finite.

pub fn with_crc(self, crc: Crc) -> Result<PolarCode>

The same code with a CRC appended to the information bits (the information set grows by its degree, $K$ is kept; CA-SCL keeps the path that passes it). A second call replaces the CRC of the first.

Errors

comnum_core::Error::Config if the information bits and the CRC exceed the block, or for a code built by PolarCode::with_positions, whose information set is fixed by its table (a standard with a CRC checks it outside the code, as crate::nr::NrPolar with PolarCode::decode_list).

pub fn with_list(self, list: usize) -> Result<PolarCode>

The same code decoded by SC list with list paths (1: successive cancellation).

Errors

comnum_core::Error::Config for list = 0.

pub fn crc(&self) -> Option<&Crc>

The CRC appended to the information bits (CA-SCL), if any (PolarCode::with_crc).

pub fn list(&self) -> usize

The list size $L$ of the decoder (1: successive cancellation).

pub fn with_positions( n: usize, info_positions: &[usize], pc_positions: &[usize], ) -> Result<PolarCode>

The code of length n (a power of two) whose information (and CRC) bits sit at info_positions and parity-check bits at pc_positions, all other positions frozen to zero: the codes of a standard whose construction is a table (5G NR, crate::nr::NrPolar). A parity-check bit is the first cell of a cyclic register of length 5 that every information bit before it updates (TS 38.212, Sec. 5.3.1.2); the list decoder sets it from the decisions of its path.

Errors

comnum_core::Error::Config unless $N$ is a power of two and the positions are distinct and below $N$.

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

The positions carrying information and CRC bits.

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

The parity-check positions (empty but for PolarCode::with_positions).

pub fn decode_list(&self, llr: &[f64]) -> Result<Vec<Vec<u8>>>

The information (and CRC) bits of the surviving paths of the list decoder, the most likely first, for a CRC checked outside the code (after a deinterleaver).

Errors

comnum_core::Error::Shape if llr does not have $N$ values.

Trait Implementations

impl BlockCode for PolarCode

fn k(&self) -> usize

Information bits per block.

fn n(&self) -> usize

Coded bits per block.

fn encode_block(&self, info: &[u8]) -> Result<Vec<u8>>

Encode one block of $k$ bits.

fn decode_block(&self, llr: &[f64]) -> Result<Vec<u8>>

Decode one block of $n$ LLRs into $k$ bits.

fn encode_block_into(&self, info: &[u8], out: &mut [u8]) -> Result<()>

Encode one block of $k$ bits into the $n$ values of out (ADR 0011: the default copies BlockCode::encode_block; a code overrides it when a profile shows the copy).

fn decode_block_into(&self, llr: &[f64], out: &mut [u8]) -> Result<()>

Decode one block of $n$ LLRs into the $k$ values of out (as BlockCode::encode_block_into).

fn code_rate(&self) -> f64

Code rate $k/n$.

fn encode_stream(&self, info: &[u8]) -> Result<Vec<u8>>

Encode whole blocks.

fn decode_stream(&self, llr: &[f64]) -> Result<Vec<u8>>

Decode whole blocks.

impl Clone for PolarCode

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 PolarCode

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

Formats the value using the given formatter.

impl Decode for PolarCode

fn decode_into(&mut self, llr: &Llr, out: &mut Bits) -> Result<()>

Decode llr into out.

fn decode(&mut self, llr: &Llr) -> Result<Bits, Error>

Decode llr (allocates, calls Decode::decode_into).

impl Encode for PolarCode

fn rate(&self) -> f64

Code rate k/n.

fn encode_into(&self, info: &Bits, out: &mut Bits) -> Result<()>

Encode info into out.

fn encode(&self, info: &Bits) -> Result<Bits, Error>

Encode info (allocates, calls Encode::encode_into).

impl PartialEq for PolarCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolarCode