GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
polar_decoder_sc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2015 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23
24#ifndef INCLUDED_FEC_POLAR_DECODER_SC_H
25#define INCLUDED_FEC_POLAR_DECODER_SC_H
26
27#include <gnuradio/fec/api.h>
29
30
31namespace gr {
32namespace fec {
33namespace code {
34
35/*!
36 * \brief Standard successive cancellation (SC) decoder for POLAR codes
37 *
38 * \details
39 * It expects float input with bits mapped 1 --> 1, 0 --> -1
40 * Or: f = 2.0 * bit - 1.0
41 *
42 */
44{
45public:
46 /*!
47 * \param block_size codeword size. MUST be a power of 2.
48 * \param num_info_bits represents the number of information
49 * bits in a block. Also called frame_size. <= block_size
50 * \param frozen_bit_positions is an integer vector which
51 * defines the position of all frozen bits in a block.
52 * Its size MUST be equal to block_size - num_info_bits.
53 * Also it must be sorted and every position must only
54 * occur once.
55 * \param frozen_bit_values holds an unpacked byte for every
56 * frozen bit position. It defines if a frozen bit is
57 * fixed to '0' or '1'. Defaults to all ZERO.
58 */
59 static generic_decoder::sptr make(int block_size,
60 int num_info_bits,
61 std::vector<int> frozen_bit_positions,
62 std::vector<char> frozen_bit_values);
64
65 // FECAPI
66 void generic_work(void* in_buffer, void* out_buffer);
67
68private:
69 polar_decoder_sc(int block_size,
70 int num_info_bits,
71 std::vector<int> frozen_bit_positions,
72 std::vector<char> frozen_bit_values);
73
74 float* d_llr_vec;
75 unsigned char* d_u_hat_vec;
76
77 unsigned char retrieve_bit_from_llr(float llr, const int pos);
78 void sc_decode(float* llrs, unsigned char* u);
79};
80
81} // namespace code
82} // namespace fec
83} // namespace gr
84
85#endif /* INCLUDED_FEC_POLAR_DECODER_SC_H */
Class holds common methods and attributes for different decoder implementations.
Definition: polar_decoder_common.h:40
Standard successive cancellation (SC) decoder for POLAR codes.
Definition: polar_decoder_sc.h:44
static generic_decoder::sptr make(int block_size, int num_info_bits, std::vector< int > frozen_bit_positions, std::vector< char > frozen_bit_values)
void generic_work(void *in_buffer, void *out_buffer)
boost::shared_ptr< generic_decoder > sptr
Definition: generic_decoder.h:75
#define FEC_API
Definition: gr-fec/include/gnuradio/fec/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45