GNU Radio C++ API Reference: gr::fec::code::polar_encoder_systematic 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_encoder_systematic Class Reference
GNU Radio C++ Signal Processing Blocks » Error Coding and Decoding

systematic POLAR encoder for basic details see 'polar_common' class. More...

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

## Public Member Functions
void | generic_work (const void *in_buffer, void *out_buffer) override
double | rate () override
int | get_input_size () override
int | get_output_size () override
bool | set_frame_size (unsigned int frame_size) override
| ~polar_encoder_systematic () override
Public Member Functions inherited from gr::fec::generic_encoder
int | unique_id ()
std::string | alias ()
virtual const char * | get_input_conversion ()
virtual const char * | get_output_conversion ()
| generic_encoder (void)
| generic_encoder (std::string name)
virtual | ~generic_encoder ()
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 ()

## Static Public Member Functions
static generic_encoder::sptr | make (int block_size, int num_info_bits, std::vector< int > frozen_bit_positions)

## Additional Inherited Members
Public Types inherited from gr::fec::generic_encoder
typedef std::shared_ptr< generic_encoder > | sptr
Public Attributes inherited from gr::fec::generic_encoder
int | my_id
std::string | d_name
Static Public Attributes inherited from gr::fec::generic_encoder
static int | base_unique_id
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)
Protected Attributes inherited from gr::fec::generic_encoder
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

systematic POLAR encoder for basic details see 'polar_common' class.

expects values with MSB first. It needs a full information word and encodes it in one pass. Output is a codeword of block_size.

Systematic encoding indicates that the info bit values are present in the codeword. 'info_bit_positions' may be obtained by ordering all non frozen_bit_positions in increasing order. One may extract them at their positions after a bit reversal operation. encoder -> decoder chain would need additional bit-reversal after encoding + before decoding. This is unnecessary.

## Constructor & Destructor Documentation

## ◆ ~polar_encoder_systematic()

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

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

## Member Function Documentation

## ◆ generic_work()

void gr::fec::code::polar_encoder_systematic::generic_work | ( | const void * | in_buffer,
|  | void * | out_buffer )
| overridevirtual

Implements gr::fec::generic_encoder.

## ◆ get_input_size()

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

Returns the input size in items that the encoder object uses to encode 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_encoder.

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

Referenced by rate().

## ◆ get_output_size()

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

Returns the output size in items that the encoder object produces after encoding 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 R*get_input_size() for a 1/R rate code.

The child class MUST implement this function.

Implements gr::fec::generic_encoder.

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

Referenced by rate().

## ◆ make()

generic_encoder::sptr gr::fec::code::polar_encoder_systematic::make | ( | int | block_size,
|  | int | num_info_bits,
|  | std::vector< int > | frozen_bit_positions )
| static

Factory for a polar code encoder object.

Parameters

  block_size | defines the codeword size. It MUST be a power of 2.
  num_info_bits | represents the number of information bits in a block. Also called frame_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 will be set to ZERO!

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

## ◆ rate()

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

Returns the rate of the code. For every 1 input bit, there are r output bits, 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_encoder.

References get_input_size(), and get_output_size().

## ◆ set_frame_size()

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

Updates the size of the frame to encode.

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_encoder.

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

- polar_encoder_systematic.h