<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.3.0 C++ API: convolutional_interleaver.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<h1>convolutional_interleaver.h</h1><a href="convolutional__interleaver_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2002 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _CONVOLUTIONAL_INTERLEAVER_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _CONVOLUTIONAL_INTERLEAVER_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <vector></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="interleaver__fifo_8h.html">interleaver_fifo.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <assert.h></span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/*!</span>
<a name="l00031"></a>00031 <span class="comment"> * \brief template class for generic convolutional interleaver</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type>
<a name="l00035"></a><a class="code" href="classconvolutional__interleaver.html">00035</a> <span class="keyword">class </span><a class="code" href="classconvolutional__interleaver.html" title="template class for generic convolutional interleaver">convolutional_interleaver</a> {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <a class="code" href="classconvolutional__interleaver.html#ac01f306da38de29b1282f1e5cc5e51c7">convolutional_interleaver</a> (<span class="keywordtype">bool</span> interleave_p, <span class="keywordtype">int</span> nbanks, <span class="keywordtype">int</span> fifo_size_incr);
<a name="l00039"></a>00039 <span class="keyword">virtual</span> <a class="code" href="classconvolutional__interleaver.html#a4fb48a3b97910049994ea2be0bc91c40">~convolutional_interleaver</a> ();
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"> //! reset interleaver (flushes contents and resets commutator)</span>
<a name="l00042"></a>00042 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classconvolutional__interleaver.html#a758195fcfe60037184a30e39e718126a" title="reset interleaver (flushes contents and resets commutator)">reset</a> ();
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> //! sync interleaver (resets commutator, but doesn't flush fifos)</span>
<a name="l00045"></a><a class="code" href="classconvolutional__interleaver.html#ad47cdb2855d94872bea06fec637b82eb">00045</a> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classconvolutional__interleaver.html#ad47cdb2855d94872bea06fec637b82eb" title="sync interleaver (resets commutator, but doesn&#39;t flush fifos)">sync</a> () { <a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a> = 0; }
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> //! return end to end delay in symbols (delay through concatenated interleaver / deinterleaver)</span>
<a name="l00048"></a>00048 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classconvolutional__interleaver.html#a95147618a994510cdc46db6f0ee23e27" title="return end to end delay in symbols (delay through concatenated interleaver / deinterleaver)...">end_to_end_delay</a> ();
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> //! transform a single symbol</span>
<a name="l00051"></a><a class="code" href="classconvolutional__interleaver.html#af49e21b50b9b59f0faf0d08d447dd67a">00051</a> <span class="comment"></span> symbol_type <a class="code" href="classconvolutional__interleaver.html#af49e21b50b9b59f0faf0d08d447dd67a" title="transform a single symbol">transform</a> (symbol_type input){
<a name="l00052"></a>00052 symbol_type <a class="code" href="gc__spu__macs_8h.html#a696b31d3fc8a0a0f24948f98d0e4a4d1">retval</a> = <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>[<a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a>]->stuff (input);
<a name="l00053"></a>00053 <a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a>++;
<a name="l00054"></a>00054 <span class="keywordflow">if</span> (<a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a> >= <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a>)
<a name="l00055"></a>00055 <a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a> = 0;
<a name="l00056"></a>00056 <span class="keywordflow">return</span> retval;
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> //! transform a bunch of symbols</span>
<a name="l00060"></a>00060 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classconvolutional__interleaver.html#af49e21b50b9b59f0faf0d08d447dd67a" title="transform a single symbol">transform</a> (symbol_type *out, <span class="keyword">const</span> symbol_type *in, <span class="keywordtype">int</span> nsymbols);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">protected</span>:
<a name="l00063"></a><a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">00063</a> <span class="keywordtype">int</span> <a class="code" href="classconvolutional__interleaver.html#a0ad9833447e269c5e527c4bfdf6ec252">m_commutator</a>;
<a name="l00064"></a><a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">00064</a> <span class="keywordtype">int</span> <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a>;
<a name="l00065"></a><a class="code" href="classconvolutional__interleaver.html#a64583ae8484756fba1845db8adee1bc7">00065</a> <span class="keywordtype">int</span> <a class="code" href="classconvolutional__interleaver.html#a64583ae8484756fba1845db8adee1bc7">m_fifo_size_incr</a>;
<a name="l00066"></a><a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">00066</a> <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<interleaver_fifo<symbol_type></a> *> <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>;
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type>
<a name="l00070"></a><a class="code" href="classconvolutional__interleaver.html#ac01f306da38de29b1282f1e5cc5e51c7">00070</a> <a class="code" href="classconvolutional__interleaver.html#ac01f306da38de29b1282f1e5cc5e51c7">convolutional_interleaver<symbol_type>::convolutional_interleaver</a> (
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> interleave_p,
<a name="l00072"></a>00072 <span class="keywordtype">int</span> nbanks,
<a name="l00073"></a>00073 <span class="keywordtype">int</span> fifo_size_incr)
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 assert (nbanks >= 1);
<a name="l00076"></a>00076 assert (fifo_size_incr >= 1);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a> = nbanks;
<a name="l00079"></a>00079 <a class="code" href="classconvolutional__interleaver.html#a64583ae8484756fba1845db8adee1bc7">m_fifo_size_incr</a> = fifo_size_incr;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>.resize (nbanks);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordflow">if</span> (interleave_p){ <span class="comment">// configure as interleaver</span>
<a name="l00084"></a>00084 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < nbanks; i++)
<a name="l00085"></a>00085 <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>[i] = <span class="keyword">new</span> <a class="code" href="classinterleaver__fifo.html" title="template class for interleaver fifo">interleaver_fifo<symbol_type></a>(i * fifo_size_incr);
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 <span class="keywordflow">else</span> { <span class="comment">// configure as de-interleaver</span>
<a name="l00088"></a>00088 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < nbanks; i++)
<a name="l00089"></a>00089 <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>[nbanks - 1 - i] = <span class="keyword">new</span> <a class="code" href="classinterleaver__fifo.html" title="template class for interleaver fifo">interleaver_fifo<symbol_type></a>(i * fifo_size_incr);
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 <a class="code" href="classconvolutional__interleaver.html#ad47cdb2855d94872bea06fec637b82eb" title="sync interleaver (resets commutator, but doesn&#39;t flush fifos)">sync</a> ();
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type>
<a name="l00095"></a><a class="code" href="classconvolutional__interleaver.html#a4fb48a3b97910049994ea2be0bc91c40">00095</a> <a class="code" href="classconvolutional__interleaver.html#a4fb48a3b97910049994ea2be0bc91c40">convolutional_interleaver<symbol_type>::~convolutional_interleaver</a> ()
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a>; i++)
<a name="l00098"></a>00098 <span class="keyword">delete</span> <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>[i];
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type> <span class="keywordtype">void</span>
<a name="l00102"></a><a class="code" href="classconvolutional__interleaver.html#a758195fcfe60037184a30e39e718126a">00102</a> <a class="code" href="classconvolutional__interleaver.html#a758195fcfe60037184a30e39e718126a" title="reset interleaver (flushes contents and resets commutator)">convolutional_interleaver<symbol_type>::reset</a> ()
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 <a class="code" href="classconvolutional__interleaver.html#ad47cdb2855d94872bea06fec637b82eb" title="sync interleaver (resets commutator, but doesn&#39;t flush fifos)">sync</a> ();
<a name="l00105"></a>00105 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a>; i++)
<a name="l00106"></a>00106 <a class="code" href="classconvolutional__interleaver.html#a361938024041b40e650ff6ad3492d0d7">m_fifo</a>[i]-><a class="code" href="classconvolutional__interleaver.html#a758195fcfe60037184a30e39e718126a" title="reset interleaver (flushes contents and resets commutator)">reset</a> ();
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type> <span class="keywordtype">int</span>
<a name="l00110"></a><a class="code" href="classconvolutional__interleaver.html#a95147618a994510cdc46db6f0ee23e27">00110</a> <a class="code" href="classconvolutional__interleaver.html#a95147618a994510cdc46db6f0ee23e27" title="return end to end delay in symbols (delay through concatenated interleaver / deinterleaver)...">convolutional_interleaver<symbol_type>::end_to_end_delay</a> ()
<a name="l00111"></a>00111 {
<a name="l00112"></a>00112 <span class="keywordtype">int</span> m = <a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a> * <a class="code" href="classconvolutional__interleaver.html#a64583ae8484756fba1845db8adee1bc7">m_fifo_size_incr</a>;
<a name="l00113"></a>00113 <span class="keywordflow">return</span> m * (<a class="code" href="classconvolutional__interleaver.html#a0e5b1c5a67032ce5ec79291e8bc957d1">m_nbanks</a> - 1);
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keyword">template</span><<span class="keyword">class</span> symbol_type> <span class="keywordtype">void</span>
<a name="l00117"></a><a class="code" href="classconvolutional__interleaver.html#afe0e221849f0feb4796f620e1858231b">00117</a> <a class="code" href="classconvolutional__interleaver.html#af49e21b50b9b59f0faf0d08d447dd67a" title="transform a single symbol">convolutional_interleaver<symbol_type>::transform</a> (symbol_type *out,
<a name="l00118"></a>00118 <span class="keyword">const</span> symbol_type *in,
<a name="l00119"></a>00119 <span class="keywordtype">int</span> nsymbols)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 <span class="comment">// we may want to unroll this a couple of times...</span>
<a name="l00122"></a>00122 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < nsymbols; i++)
<a name="l00123"></a>00123 out[i] = <a class="code" href="classconvolutional__interleaver.html#af49e21b50b9b59f0faf0d08d447dd67a" title="transform a single symbol">transform</a> (in[i]);
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="preprocessor">#endif </span><span class="comment">/* _CONVOLUTIONAL_INTERLEAVER_H_ */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:50:59 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
