diff options
Diffstat (limited to 'gr-fec/include/gnuradio/fec/polar_decoder_common.h')
| -rw-r--r-- | gr-fec/include/gnuradio/fec/polar_decoder_common.h | 41 |
1 files changed, 25 insertions, 16 deletions
diff --git a/gr-fec/include/gnuradio/fec/polar_decoder_common.h b/gr-fec/include/gnuradio/fec/polar_decoder_common.h index 2376e8f089..7a18ba873c 100644 --- a/gr-fec/include/gnuradio/fec/polar_decoder_common.h +++ b/gr-fec/include/gnuradio/fec/polar_decoder_common.h @@ -1,19 +1,19 @@ /* -*- c++ -*- */ -/* +/* * Copyright 2015 Free Software Foundation, Inc. - * + * * This file is part of GNU Radio - * + * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. - * + * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, @@ -30,22 +30,31 @@ namespace gr { namespace fec { + namespace code { /*! - * \brief Class holds common methods and attributes for different decoder implementations - * - * \param block_size codeword size. MUST be a power of 2. - * \param num_info_bits represents the number of information bits in a block. Also called frame_size. <= block_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. - * \param 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. + * \brief Class holds common methods and attributes for different + * decoder implementations */ class FEC_API polar_decoder_common : public generic_decoder, public polar_common { public: - polar_decoder_common(int block_size, int num_info_bits, std::vector<int> frozen_bit_positions, std::vector<char> frozen_bit_values); + /*! + * + * \param block_size codeword size. MUST be a power of 2. + * \param num_info_bits represents the number of information bits + * in a block. Also called frame_size. <= block_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. + * \param 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. + */ + polar_decoder_common(int block_size, int num_info_bits, + std::vector<int> frozen_bit_positions, + std::vector<char> frozen_bit_values); ~polar_decoder_common(); // FECAPI @@ -84,8 +93,8 @@ namespace gr { }; + } // namespace code } // namespace fec } // namespace gr #endif /* INCLUDED_FEC_POLAR_DECODER_COMMON_H */ - |