root/doc/html/classitpp_1_1Block__Interleaver.html @ 354

Revision 353, 10.6 kB (checked in by smidl, 15 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::Block_Interleaver&lt; T &gt; Class Template Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1Block__Interleaver.html">Block_Interleaver</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Block_Interleaver&lt; T &gt; Class Template Reference<br>
72<small>
73[<a class="el" href="group__interl.html">Interleavers</a>]</small>
74</h1><!-- doxytag: class="itpp::Block_Interleaver" -->Block Interleaver Class. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="interleave_8h-source.html">comm/interleave.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Block__Interleaver-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3129ee09a9e830fcef08dae71ddaaa3e"></a><!-- doxytag: member="itpp::Block_Interleaver::Block_Interleaver" ref="3129ee09a9e830fcef08dae71ddaaa3e" args="(void)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#3129ee09a9e830fcef08dae71ddaaa3e">Block_Interleaver</a> (void)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Block__Interleaver.html" title="Block Interleaver Class.">Block_Interleaver</a> constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26e8964f2fd3b94ae1f22c3529685f1f"></a><!-- doxytag: member="itpp::Block_Interleaver::Block_Interleaver" ref="26e8964f2fd3b94ae1f22c3529685f1f" args="(int in_rows, int in_cols)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#26e8964f2fd3b94ae1f22c3529685f1f">Block_Interleaver</a> (int in_rows, int in_cols)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Block__Interleaver.html" title="Block Interleaver Class.">Block_Interleaver</a> constructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="250fc156ccb4545850f0d9e72495bec3"></a><!-- doxytag: member="itpp::Block_Interleaver::interleave" ref="250fc156ccb4545850f0d9e72495bec3" args="(const Vec&lt; T &gt; &amp;input)" -->
93<a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#250fc156ccb4545850f0d9e72495bec3">interleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for block interleaving. May add some zeros. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a9acdc9e5074a099be78f358149b1f7"></a><!-- doxytag: member="itpp::Block_Interleaver::interleave" ref="8a9acdc9e5074a099be78f358149b1f7" args="(const Vec&lt; T &gt; &amp;input, Vec&lt; T &gt; &amp;output)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#8a9acdc9e5074a099be78f358149b1f7">interleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input, <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;output)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for block interleaving. May add some zeros. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c82b6bed55a14a3f7b8580668ab4bc5"></a><!-- doxytag: member="itpp::Block_Interleaver::deinterleave" ref="0c82b6bed55a14a3f7b8580668ab4bc5" args="(const Vec&lt; T &gt; &amp;input, short keepzeros=0)" -->
101<a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#0c82b6bed55a14a3f7b8580668ab4bc5">deinterleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input, short keepzeros=0)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for block deinterleaving. Removes additional zeros if <em>keepzeros</em> = 0. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2befff97c52ed91c3c99727a5440fdc1"></a><!-- doxytag: member="itpp::Block_Interleaver::deinterleave" ref="2befff97c52ed91c3c99727a5440fdc1" args="(const Vec&lt; T &gt; &amp;input, Vec&lt; T &gt; &amp;output, short keepzeros=0)" -->
105void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#2befff97c52ed91c3c99727a5440fdc1">deinterleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input, <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;output, short keepzeros=0)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for block deinterleaving. Removes additional zeros if <em>keepzeros</em> = 0. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c52dd1b18110528bba6ce67937d14024"></a><!-- doxytag: member="itpp::Block_Interleaver::set_rows" ref="c52dd1b18110528bba6ce67937d14024" args="(int in_rows)" -->
109void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#c52dd1b18110528bba6ce67937d14024">set_rows</a> (int in_rows)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the number of <em>rows</em> for block interleaving. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c933fa3a6bec600b3eb0fbfd62ad786"></a><!-- doxytag: member="itpp::Block_Interleaver::set_cols" ref="7c933fa3a6bec600b3eb0fbfd62ad786" args="(int in_cols)" -->
113void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#7c933fa3a6bec600b3eb0fbfd62ad786">set_cols</a> (int in_cols)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the number of <em>columns</em> for block interleaving. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82b4f68808a621ffa07f99ff93f61e16"></a><!-- doxytag: member="itpp::Block_Interleaver::get_rows" ref="82b4f68808a621ffa07f99ff93f61e16" args="(void)" -->
117int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#82b4f68808a621ffa07f99ff93f61e16">get_rows</a> (void)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of <em>rows</em> for block interleaving. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa474881a1f9ffa9132850096dc16bb5"></a><!-- doxytag: member="itpp::Block_Interleaver::get_cols" ref="aa474881a1f9ffa9132850096dc16bb5" args="(void)" -->
121int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Block__Interleaver.html#aa474881a1f9ffa9132850096dc16bb5">get_cols</a> (void)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of <em>columns</em> for block interleaving. <br></td></tr>
124</table>
125<hr><a name="_details"></a><h2>Detailed Description</h2>
126<h3>template&lt;class T&gt;<br>
127 class itpp::Block_Interleaver&lt; T &gt;</h3>
128
129Block Interleaver Class.
130<p>
131Data is written row-wise and read column-wise when interleaving. <h3>Example of use:</h3>
132<p>
133<div class="fragment"><pre class="fragment">  BPSK bpsk;
134  bvec bits = <span class="stringliteral">"0 1 1 0 0 0 1 1 1 1 0 0 1 0 0 1"</span>;
135  vec symbols = bpsk.modulate_bits(bits);
136
137  Block_Interleaver&lt;double&gt; block_interleaver(4,4);
138  vec interleaved_symbols = block_interleaver.interleave(symbols);
139</pre></div> <hr>The documentation for this class was generated from the following file:<ul>
140<li><a class="el" href="interleave_8h-source.html">interleave.h</a></ul>
141</div>
142<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
143<a href="http://www.doxygen.org/index.html">
144<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
145</body>
146</html>
Note: See TracBrowser for help on using the browser.