GNU Radio 3.7.1 C++ API
vector_map.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_VECTOR_MAP_H
00024 #define INCLUDED_GR_VECTOR_MAP_H
00025 
00026 #include <gnuradio/blocks/api.h>
00027 #include <vector>
00028 #include <gnuradio/sync_block.h>
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Maps elements from a set of input vectors to a set of output vectors.
00035      * \ingroup stream_operators_blk
00036      *
00037      * \details
00038      * If in[i] is the input vector in the i'th stream then the output
00039      * vector in the j'th stream is:
00040      *
00041      * out[j][k] = in[mapping[j][k][0]][mapping[j][k][1]]
00042      *
00043      * That is mapping is of the form (out_stream1_mapping,
00044      * out_stream2_mapping, ...)  and out_stream1_mapping is of the
00045      * form (element1_mapping, element2_mapping, ...)  and
00046      * element1_mapping is of the form (in_stream, in_element).
00047      */
00048     class BLOCKS_API vector_map : virtual public sync_block
00049     {
00050     public:
00051       // gr::blocks::vector_map::sptr
00052       typedef boost::shared_ptr<vector_map> sptr;
00053 
00054       /*!
00055        * Build a vector map block.
00056        *
00057        * \param item_size (integer) size of vector elements
00058        * \param in_vlens (vector of integers) number of elements in each
00059        *                 input vector
00060        * \param mapping (vector of vectors of vectors of integers) how to
00061        *                map elements from input to output vectors
00062        */
00063       static sptr make(size_t item_size, std::vector<size_t> in_vlens,
00064                        std::vector< std::vector< std::vector<size_t> > > mapping);
00065 
00066       virtual void set_mapping(std::vector< std::vector< std::vector<size_t> > > mapping) = 0;
00067     };
00068 
00069   } /* namespace blocks */
00070 } /* namespace gr */
00071 
00072 #endif /* INCLUDED_GR_VECTOR_MAP_H */