diff options
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/deinterleave.h')
-rw-r--r-- | gr-blocks/include/gnuradio/blocks/deinterleave.h | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/deinterleave.h b/gr-blocks/include/gnuradio/blocks/deinterleave.h index a3b5480089..1589ebae16 100644 --- a/gr-blocks/include/gnuradio/blocks/deinterleave.h +++ b/gr-blocks/include/gnuradio/blocks/deinterleave.h @@ -27,51 +27,51 @@ #include <gnuradio/block.h> namespace gr { - namespace blocks { +namespace blocks { + +/*! + * \brief deinterleave an input block of samples into N outputs. + * \ingroup stream_operators_blk + * + * \details + * This block deinterleaves blocks of samples. For each output + * connection, the input stream will be deinterleaved successively + * to the output connections. By default, the block deinterleaves + * a single input to each output unless blocksize is given in the + * constructor. + * + * \code + * blocksize = 1 + * connections = 2 + * input = [a, b, c, d, e, f, g, h] + * output[0] = [a, c, e, g] + * output[1] = [b, d, f, h] + * \endcode + * + * \code + * blocksize = 2 + * connections = 2 + * input = [a, b, c, d, e, f, g, h] + * output[0] = [a, b, e, f] + * output[1] = [c, d, g, h] + * \endcode + */ +class BLOCKS_API deinterleave : virtual public block +{ +public: + // gr::blocks::deinterleave::sptr + typedef boost::shared_ptr<deinterleave> sptr; /*! - * \brief deinterleave an input block of samples into N outputs. - * \ingroup stream_operators_blk - * - * \details - * This block deinterleaves blocks of samples. For each output - * connection, the input stream will be deinterleaved successively - * to the output connections. By default, the block deinterleaves - * a single input to each output unless blocksize is given in the - * constructor. + * Make a deinterleave block. * - * \code - * blocksize = 1 - * connections = 2 - * input = [a, b, c, d, e, f, g, h] - * output[0] = [a, c, e, g] - * output[1] = [b, d, f, h] - * \endcode - * - * \code - * blocksize = 2 - * connections = 2 - * input = [a, b, c, d, e, f, g, h] - * output[0] = [a, b, e, f] - * output[1] = [c, d, g, h] - * \endcode + * \param itemsize stream itemsize + * \param blocksize size of block to deinterleave */ - class BLOCKS_API deinterleave : virtual public block - { - public: - // gr::blocks::deinterleave::sptr - typedef boost::shared_ptr<deinterleave> sptr; - - /*! - * Make a deinterleave block. - * - * \param itemsize stream itemsize - * \param blocksize size of block to deinterleave - */ - static sptr make(size_t itemsize, unsigned int blocksize = 1); - }; + static sptr make(size_t itemsize, unsigned int blocksize = 1); +}; - } /* namespace blocks */ +} /* namespace blocks */ } /* namespace gr */ #endif /* INCLUDED_BLOCKS_DEINTERLEAVE_H */ |