Struct NrLdpc 

pub struct NrLdpc { /* private fields */ }

The LDPC code of 5G NR for one code block (see the module).

Implementations

impl NrLdpc

pub fn new(k_info: usize, e: usize) -> Result<NrLdpc>

The code of k_info information bits rate-matched to e bits, redundancy version 0, without bit interleaving.

Errors

As NrLdpc::with_options.

pub fn with_options( k_info: usize, e: usize, base_graph_override: Option<u8>, rv: u8, qm: usize, ) -> Result<NrLdpc>

The code of k_info information bits rate-matched to e bits, the base graph chosen as in Sec. 7.2.2 or forced by base_graph, the redundancy version rv and the bit interleaver of qm bits per symbol (1: none).

Errors

comnum_core::Error::Config for a block larger than one code block (8448 bits for base graph 1, 3840 for base graph 2), e not a multiple of qm, an rv above 3, or a base graph other than 1 or 2.

pub fn base_graph(&self) -> u8

The base graph, 1 or 2.

pub fn lifting_size(&self) -> usize

The lifting size $Z_{c}$.

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

The bit of the full codeword carried by every output bit.

pub fn code(&self) -> &LdpcCode

The code of the lifted parity-check matrix.

pub fn decoder_mut(&mut self) -> &mut LdpcDecoder

The settings of the decoder, which can change without changing the code.

pub fn combine(&self, llr: &[f64], buffer: &mut [f64]) -> Result<()>

Add the e LLRs of one transmission to the soft buffer buffer of the full codeword (code().n() values, zeros before the first transmission): the soft combining of the transmissions of a HARQ process (chase combining of the same redundancy version, incremental redundancy of the others), every redundancy version of the same $K’$, $E$ and base graph sharing the buffer.

Errors

comnum_core::Error::Shape unless llr has $E$ values and buffer code().n().

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

Decode the soft buffer of NrLdpc::combine: the $K’$ information bits.

Errors

comnum_core::Error::Shape unless buffer has code().n() values.

Trait Implementations

impl BlockCode for NrLdpc

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 NrLdpc

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 NrLdpc

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

Formats the value using the given formatter.

impl Decode for NrLdpc

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 NrLdpc

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 SoftDecode for NrLdpc

fn app_into( &self, llr: &[f64], apriori: Option<&[f64]>, out: &mut [f64], ) -> Result<usize>

The a posteriori LLRs of the $K’$ information bits after the belief propagation of the full codeword (the a priori LLRs added to theirs).

fn app(&self, llr: &[f64], apriori: Option<&[f64]>) -> Result<Vec<f64>>

SoftDecode::app_into into a new vector.