root/doc/html/classitpp_1_1Sequence__Interleaver.html @ 354

Revision 353, 14.1 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::Sequence_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_1Sequence__Interleaver.html">Sequence_Interleaver</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Sequence_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::Sequence_Interleaver" -->Sequence 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_1Sequence__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="5a2944c1c1dc62bb6c948e56b4785a0c"></a><!-- doxytag: member="itpp::Sequence_Interleaver::Sequence_Interleaver" ref="5a2944c1c1dc62bb6c948e56b4785a0c" args="(void)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#5a2944c1c1dc62bb6c948e56b4785a0c">Sequence_Interleaver</a> (void)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Sequence__Interleaver.html" title="Sequence Interleaver Class.">Sequence_Interleaver</a> constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#219bd8d01d532d0c914c93727fce8cd1">Sequence_Interleaver</a> (int in_interleaver_depth)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Sequence__Interleaver.html" title="Sequence Interleaver Class.">Sequence_Interleaver</a> constructor.  <a href="#219bd8d01d532d0c914c93727fce8cd1"></a><br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#41bd70b8751ff4f827e08ad43a9f082d">Sequence_Interleaver</a> (ivec in_interleaver_sequence)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Sequence__Interleaver.html" title="Sequence Interleaver Class.">Sequence_Interleaver</a> constructor.  <a href="#41bd70b8751ff4f827e08ad43a9f082d"></a><br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3436faf70c53400695f0c54ee9c0fb64"></a><!-- doxytag: member="itpp::Sequence_Interleaver::interleave" ref="3436faf70c53400695f0c54ee9c0fb64" args="(const Vec&lt; T &gt; &amp;input)" -->
95<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_1Sequence__Interleaver.html#3436faf70c53400695f0c54ee9c0fb64">interleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for sequence interleaving. May add some zeros. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9ac67d98ff2a698fd47937a09d0ff11"></a><!-- doxytag: member="itpp::Sequence_Interleaver::interleave" ref="e9ac67d98ff2a698fd47937a09d0ff11" args="(const Vec&lt; T &gt; &amp;input, Vec&lt; T &gt; &amp;output)" -->
99void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#e9ac67d98ff2a698fd47937a09d0ff11">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>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for sequence interleaving. May add some zeros. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8394055c94d125c12995bf418dc356c0"></a><!-- doxytag: member="itpp::Sequence_Interleaver::deinterleave" ref="8394055c94d125c12995bf418dc356c0" args="(const Vec&lt; T &gt; &amp;input, short keepzeros=0)" -->
103<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_1Sequence__Interleaver.html#8394055c94d125c12995bf418dc356c0">deinterleave</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; T &gt; &amp;input, short keepzeros=0)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for sequence deinterleaving. Removes additional zeros if <em>keepzeros</em> = 0. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9782d94ff1322dfca4db14b62724e6d9"></a><!-- doxytag: member="itpp::Sequence_Interleaver::deinterleave" ref="9782d94ff1322dfca4db14b62724e6d9" args="(const Vec&lt; T &gt; &amp;input, Vec&lt; T &gt; &amp;output, short keepzeros=0)" -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#9782d94ff1322dfca4db14b62724e6d9">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>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for sequence deinterleaving. Removes additional zeros if <em>keepzeros</em> = 0. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f68f9acbac21192d93de9284db930340"></a><!-- doxytag: member="itpp::Sequence_Interleaver::randomize_interleaver_sequence" ref="f68f9acbac21192d93de9284db930340" args="()" -->
111void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#f68f9acbac21192d93de9284db930340">randomize_interleaver_sequence</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate a new random sequence for interleaving. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ccff537b7dd07bbc1d34ec343e7df63a"></a><!-- doxytag: member="itpp::Sequence_Interleaver::get_interleaver_sequence" ref="ccff537b7dd07bbc1d34ec343e7df63a" args="()" -->
115ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#ccff537b7dd07bbc1d34ec343e7df63a">get_interleaver_sequence</a> ()</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the interleaver sequence presently used. <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db47d1227f4a2b47a2a2aff225ca5bf5"></a><!-- doxytag: member="itpp::Sequence_Interleaver::set_interleaver_sequence" ref="db47d1227f4a2b47a2a2aff225ca5bf5" args="(ivec in_interleaver_sequence)" -->
119void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#db47d1227f4a2b47a2a2aff225ca5bf5">set_interleaver_sequence</a> (ivec in_interleaver_sequence)</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the interleaver sequence to be used. <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16ae0b10d8296ce5bc5cd371e64cca2b"></a><!-- doxytag: member="itpp::Sequence_Interleaver::set_interleaver_depth" ref="16ae0b10d8296ce5bc5cd371e64cca2b" args="(int in_interleaver_depth)" -->
123void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#16ae0b10d8296ce5bc5cd371e64cca2b">set_interleaver_depth</a> (int in_interleaver_depth)</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the length of the interleaver sequence to be used. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="97559ad3aa356c53f32cc58d230e653d"></a><!-- doxytag: member="itpp::Sequence_Interleaver::get_interleaver_depth" ref="97559ad3aa356c53f32cc58d230e653d" args="(void)" -->
127int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Sequence__Interleaver.html#97559ad3aa356c53f32cc58d230e653d">get_interleaver_depth</a> (void)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the length of the interleaver sequence presently used. <br></td></tr>
130</table>
131<hr><a name="_details"></a><h2>Detailed Description</h2>
132<h3>template&lt;class T&gt;<br>
133 class itpp::Sequence_Interleaver&lt; T &gt;</h3>
134
135Sequence Interleaver Class.
136<p>
137<h3>Example of use: </h3>
138<p>
139<div class="fragment"><pre class="fragment">  BPSK bpsk;
140  bvec bits = <span class="stringliteral">"0 1 1 0 0 0 1 1 1 1 0 0 1 0 0 1"</span>;
141  vec symbols = bpsk.modulate_bits(bits);
142
143  Sequence_Interleaver&lt;double&gt; sequence_interleaver(16);
144  sequence_interleaver.randomize_interleaver_sequence();
145  vec interleaved_symbols = sequence_snterleaver.interleave(symbols);
146</pre></div> <hr><h2>Constructor &amp; Destructor Documentation</h2>
147<a class="anchor" name="219bd8d01d532d0c914c93727fce8cd1"></a><!-- doxytag: member="itpp::Sequence_Interleaver::Sequence_Interleaver" ref="219bd8d01d532d0c914c93727fce8cd1" args="(int in_interleaver_depth)" -->
148<div class="memitem">
149<div class="memproto">
150<div class="memtemplate">
151template&lt;class T &gt; </div>
152      <table class="memname">
153        <tr>
154          <td class="memname"><a class="el" href="classitpp_1_1Sequence__Interleaver.html">itpp::Sequence_Interleaver</a>&lt; T &gt;::<a class="el" href="classitpp_1_1Sequence__Interleaver.html">Sequence_Interleaver</a>           </td>
155          <td>(</td>
156          <td class="paramtype">int&nbsp;</td>
157          <td class="paramname"> <em>in_interleaver_depth</em>          </td>
158          <td>&nbsp;)&nbsp;</td>
159          <td><code> [inline]</code></td>
160        </tr>
161      </table>
162</div>
163<div class="memdoc">
164
165<p>
166<a class="el" href="classitpp_1_1Sequence__Interleaver.html" title="Sequence Interleaver Class.">Sequence_Interleaver</a> constructor.
167<p>
168Chooses a random sequence of length <em>in_interleaver_depth</em> for interleaving.
169<p>References <a class="el" href="random_8h-source.html#l00608">itpp::randu()</a>.</p>
170
171</div>
172</div><p>
173<a class="anchor" name="41bd70b8751ff4f827e08ad43a9f082d"></a><!-- doxytag: member="itpp::Sequence_Interleaver::Sequence_Interleaver" ref="41bd70b8751ff4f827e08ad43a9f082d" args="(ivec in_interleaver_sequence)" -->
174<div class="memitem">
175<div class="memproto">
176<div class="memtemplate">
177template&lt;class T &gt; </div>
178      <table class="memname">
179        <tr>
180          <td class="memname"><a class="el" href="classitpp_1_1Sequence__Interleaver.html">itpp::Sequence_Interleaver</a>&lt; T &gt;::<a class="el" href="classitpp_1_1Sequence__Interleaver.html">Sequence_Interleaver</a>           </td>
181          <td>(</td>
182          <td class="paramtype">ivec&nbsp;</td>
183          <td class="paramname"> <em>in_interleaver_sequence</em>          </td>
184          <td>&nbsp;)&nbsp;</td>
185          <td><code> [inline]</code></td>
186        </tr>
187      </table>
188</div>
189<div class="memdoc">
190
191<p>
192<a class="el" href="classitpp_1_1Sequence__Interleaver.html" title="Sequence Interleaver Class.">Sequence_Interleaver</a> constructor.
193<p>
194Uses the <em>in_interleaver_sequence</em> for interleaving.
195</div>
196</div><p>
197<hr>The documentation for this class was generated from the following file:<ul>
198<li><a class="el" href="interleave_8h-source.html">interleave.h</a></ul>
199</div>
200<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
201<a href="http://www.doxygen.org/index.html">
202<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
203</body>
204</html>
Note: See TracBrowser for help on using the browser.