GNU Radio C++ API Reference: gr::fec::code::polar_decoder_common Class Reference

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
gr::fec::code::polar_decoder_common Class Reference

Class holds common methods and attributes for different decoder implementations. More...

`#include <gnuradio/fec/polar_decoder_common.h>`

## Public Member Functions
| polar_decoder_common (int block_size, int num_info_bits, std::vector< int > frozen_bit_positions, std::vector< uint8_t > frozen_bit_values)
| ~polar_decoder_common () override
double | rate () override
int | get_input_size () override
int | get_output_size () override
bool | set_frame_size (unsigned int frame_size) override
Public Member Functions inherited from gr::fec::generic_decoder
virtual void | generic_work (const void *inbuffer, void *outbuffer)=0
int | unique_id ()
std::string | alias ()
| generic_decoder (void)
| generic_decoder (std::string name)
virtual | ~generic_decoder ()
virtual int | get_history ()
virtual float | get_shift ()
virtual int | get_input_item_size ()
virtual int | get_output_item_size ()
virtual const char * | get_input_conversion ()
virtual const char * | get_output_conversion ()
virtual float | get_iterations ()
Public Member Functions inherited from gr::fec::code::polar_common
| polar_common (int block_size, int num_info_bits, std::vector< int > frozen_bit_positions, std::vector< uint8_t > frozen_bit_values)
| ~polar_common ()

## Protected Member Functions
float | llr_odd (const float la, const float lb) const
float | llr_even (const float la, const float lb, const unsigned char f) const
unsigned char | llr_bit_decision (const float llr) const
bool | is_frozen_bit (const int u_num) const
unsigned char | next_frozen_bit ()
void | initialize_decoder (unsigned char *u, float *llrs, const float *input)
void | butterfly (float *llrs, unsigned char *u, const int stage, const int u_num, const int row)
void | butterfly_volk (float *llrs, unsigned char *u, const int stage, const int u_num, const int row)
void | butterfly_generic (float *llrs, unsigned char *u, const int stage, const int u_num, const int row)
void | even_u_values (unsigned char *u_even, const unsigned char *u, const int u_num)
void | odd_xor_even_values (unsigned char *u_xor, const unsigned char *u, const int u_num)
void | extract_info_bits (unsigned char *output, const unsigned char *input) const
void | print_pretty_llr_vector (const float *llr_vec) const
Protected Member Functions inherited from gr::fec::code::polar_common
int | block_size () const
int | block_power () const
int | num_info_bits () const
long | bit_reverse (long value, int active_bits) const
void | print_packed_bit_array (const unsigned char *printed_array, const int num_bytes) const
void | print_unpacked_bit_array (const unsigned char *bits, const unsigned int num_bytes) const
void | setup_info_bit_positions_reversed ()
void | setup_volk_vectors ()
void | volk_encode (unsigned char *out_buf, const unsigned char *in_buf)
void | volk_encode_block (unsigned char *out_buf, unsigned char *in_buf)

## Additional Inherited Members
Public Types inherited from gr::fec::generic_decoder
typedef std::shared_ptr< generic_decoder > | sptr
Public Attributes inherited from gr::fec::generic_decoder
int | my_id
std::string | d_name
Static Public Attributes inherited from gr::fec::generic_decoder
static int | base_unique_id
Protected Attributes inherited from gr::fec::generic_decoder
gr::logger_ptr | d_logger
Protected Attributes inherited from gr::fec::code::polar_common
std::vector< int > | d_frozen_bit_positions
std::vector< uint8_t > | d_frozen_bit_values
std::vector< int > | d_info_bit_positions
std::vector< int > | d_info_bit_positions_reversed
volk::vector< unsigned char > | d_volk_temp
volk::vector< unsigned char > | d_volk_frozen_bit_mask
volk::vector< unsigned char > | d_volk_frozen_bits

## Detailed Description

Class holds common methods and attributes for different decoder implementations.

## Constructor & Destructor Documentation

## ◆ polar_decoder_common()

gr::fec::code::polar_decoder_common::polar_decoder_common | ( | int | block_size,
|  | int | num_info_bits,
|  | std::vector< int > | frozen_bit_positions,
|  | std::vector< uint8_t > | frozen_bit_values )

Parameters

  block_size | codeword size. MUST be a power of 2.
  num_info_bits | represents the number of information bits in a block. Also called frame_size. <= block_size
  frozen_bit_positions | is an integer vector which defines the position of all frozen bits in a block. Its size MUST be equal to block_size - num_info_bits. Also it must be sorted and every position must only occur once.
  frozen_bit_values | holds an unpacked byte for every frozen bit position. It defines if a frozen bit is fixed to '0' or '1'. Defaults to all ZERO.

References gr::fec::code::polar_common::block_size(), and gr::fec::code::polar_common::num_info_bits().

## ◆ ~polar_decoder_common()

gr::fec::code::polar_decoder_common::~polar_decoder_common | ( |  | ) |
| override

## Member Function Documentation

## ◆ butterfly()

void gr::fec::code::polar_decoder_common::butterfly | ( | float * | llrs,
|  | unsigned char * | u,
|  | const int | stage,
|  | const int | u_num,
|  | const int | row )
| protected

## ◆ butterfly_generic()

void gr::fec::code::polar_decoder_common::butterfly_generic | ( | float * | llrs,
|  | unsigned char * | u,
|  | const int | stage,
|  | const int | u_num,
|  | const int | row )
| protected

## ◆ butterfly_volk()

void gr::fec::code::polar_decoder_common::butterfly_volk | ( | float * | llrs,
|  | unsigned char * | u,
|  | const int | stage,
|  | const int | u_num,
|  | const int | row )
| protected

## ◆ even_u_values()

void gr::fec::code::polar_decoder_common::even_u_values | ( | unsigned char * | u_even,
|  | const unsigned char * | u,
|  | const int | u_num )
| protected

## ◆ extract_info_bits()

void gr::fec::code::polar_decoder_common::extract_info_bits | ( | unsigned char * | output,
|  | const unsigned char * | input ) const
| protected

## ◆ get_input_size()

int gr::fec::code::polar_decoder_common::get_input_size | ( |  | ) |
| inlineoverridevirtual

Returns the input size in items that the decoder object uses to decode a full frame. Often, this number is the number of bits per frame if the input format is unpacked. If the block expects packed bytes, then this value should be the number of bytes (number of bits / 8) per input frame.

The child class MUST implement this function.

Implements gr::fec::generic_decoder.

References gr::fec::code::polar_common::block_size().

Referenced by rate().

## ◆ get_output_size()

int gr::fec::code::polar_decoder_common::get_output_size | ( |  | ) |
| inlineoverridevirtual

Returns the output size in items that the decoder object produces after decoding a full frame. Often, this number is the number of bits in the outputted frame if the input format is unpacked. If the block produces packed bytes, then this value should be the number of bytes (number of bits / 8) per frame produced. This value is generally something like get_input_size()/R for a 1/R rate code.

The child class MUST implement this function.

Implements gr::fec::generic_decoder.

References gr::fec::code::polar_common::num_info_bits().

Referenced by rate().

## ◆ initialize_decoder()

void gr::fec::code::polar_decoder_common::initialize_decoder | ( | unsigned char * | u,
|  | float * | llrs,
|  | const float * | input )
| protected

## ◆ is_frozen_bit()

bool gr::fec::code::polar_decoder_common::is_frozen_bit | ( | const int | u_num | ) | const
| protected

## ◆ llr_bit_decision()

unsigned char gr::fec::code::polar_decoder_common::llr_bit_decision | ( | const float | llr | ) | const
| inlineprotected

## ◆ llr_even()

float gr::fec::code::polar_decoder_common::llr_even | ( | const float | la,
|  | const float | lb,
|  | const unsigned char | f ) const
| protected

## ◆ llr_odd()

float gr::fec::code::polar_decoder_common::llr_odd | ( | const float | la,
|  | const float | lb ) const
| protected

## ◆ next_frozen_bit()

unsigned char gr::fec::code::polar_decoder_common::next_frozen_bit | ( |  | ) |
| protected

## ◆ odd_xor_even_values()

void gr::fec::code::polar_decoder_common::odd_xor_even_values | ( | unsigned char * | u_xor,
|  | const unsigned char * | u,
|  | const int | u_num )
| protected

## ◆ print_pretty_llr_vector()

void gr::fec::code::polar_decoder_common::print_pretty_llr_vector | ( | const float * | llr_vec | ) | const
| protected

## ◆ rate()

double gr::fec::code::polar_decoder_common::rate | ( |  | ) |
| inlineoverridevirtual

Returns the rate of the code. For every r input bits, there is 1 output bit, so the rate is 1/r. Used for setting things like the encoder block's relative rate.

This function MUST be reimplemented by the child class.

Implements gr::fec::generic_decoder.

References get_input_size(), and get_output_size().

## ◆ set_frame_size()

bool gr::fec::code::polar_decoder_common::set_frame_size | ( | unsigned int | frame_size | ) |
| inlineoverridevirtual

Updates the size of a decoded frame.

The child class MUST implement this function and interpret how the `frame_size` information affects the block's behavior. It should also provide bounds checks.

Implements gr::fec::generic_decoder.

The documentation for this class was generated from the following file:

- polar_decoder_common.h