Loading...
Searching...
No Matches
polar_encoder_systematic.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2015 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_FEC_POLAR_ENCODER_SYSTEMATIC_H
#define INCLUDED_FEC_POLAR_ENCODER_SYSTEMATIC_H
#include <gnuradio/fec/api.h>
#include <gnuradio/fec/generic_encoder.h>
#include <gnuradio/fec/polar_common.h>
namespace gr {
namespace fec {
namespace code {
/*!
* \brief systematic POLAR encoder
* for basic details see 'polar_common' class.
* \ingroup error_coding_blk
*
* \details
* 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.
*/
class FEC_API polar_encoder_systematic : public generic_encoder, public polar_common
{
public:
/*!
* Factory for a polar code encoder object.
*
* \param block_size defines the codeword size. It MUST be a
* power of 2.
* \param num_info_bits represents the number of information
* bits in a block. Also called frame_size.
* \param 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!
*/
static generic_encoder::sptr
make(int block_size, int num_info_bits, std::vector<int> frozen_bit_positions);
// FECAPI
void generic_work(void* in_buffer, void* out_buffer) override;
double rate() override { return (1.0 * get_input_size() / get_output_size()); };
int get_input_size() override { return num_info_bits(); };
int get_output_size() override { return block_size(); };
bool set_frame_size(unsigned int frame_size) override { return false; };
~polar_encoder_systematic() override;
private:
polar_encoder_systematic(int block_size,
int num_info_bits,
std::vector<int> frozen_bit_positions);
void bit_reverse_and_reset_frozen_bits(unsigned char* outbuf,
const unsigned char* inbuf);
volk::vector<unsigned char> d_volk_syst_intermediate;
};
} // namespace code
} // namespace fec
} // namespace gr
#endif /* INCLUDED_FEC_POLAR_ENCODER_SYSTEMATIC_H */
gr::fec::code::polar_common
POLAR code common operations and attributes.
Definition polar_common.h:50
gr::fec::code::polar_encoder_systematic
systematic POLAR encoder for basic details see 'polar_common' class.
Definition polar_encoder_systematic.h:39
gr::fec::code::polar_encoder_systematic::get_input_size
int get_input_size() override
Definition polar_encoder_systematic.h:60
gr::fec::code::polar_encoder_systematic::rate
double rate() override
Definition polar_encoder_systematic.h:59
gr::fec::code::polar_encoder_systematic::generic_work
void generic_work(void *in_buffer, void *out_buffer) override
gr::fec::code::polar_encoder_systematic::set_frame_size
bool set_frame_size(unsigned int frame_size) override
Definition polar_encoder_systematic.h:62
gr::fec::code::polar_encoder_systematic::get_output_size
int get_output_size() override
Definition polar_encoder_systematic.h:61
gr::fec::code::polar_encoder_systematic::make
static generic_encoder::sptr make(int block_size, int num_info_bits, std::vector< int > frozen_bit_positions)
gr::fec::code::polar_encoder_systematic::~polar_encoder_systematic
~polar_encoder_systematic() override
gr::fec::generic_encoder
Definition generic_encoder.h:23
gr::fec::generic_encoder::sptr
std::shared_ptr< generic_encoder > sptr
Definition generic_encoder.h:37
std::vector
STL class.
Definition vector_docstub.h:11
generic_encoder.h
api.h
FEC_API
#define FEC_API
Definition gr-fec/include/gnuradio/fec/api.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
polar_common.h