root/doc/html/classitpp_1_1Channel__Code.html @ 353

Revision 353, 8.5 kB (checked in by smidl, 16 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::Channel_Code Class 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_1Channel__Code.html">Channel_Code</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Channel_Code Class Reference<br>
72<small>
73[<a class="el" href="group__fec.html">Forward Error Correcting Codes</a>]</small>
74</h1><!-- doxytag: class="itpp::Channel_Code" -->Generic Channel Code class. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="channel__code_8h-source.html">channel_code.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Channel__Code-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="4914d1ec0aa65080ab46b42b5d3137c0"></a><!-- doxytag: member="itpp::Channel_Code::Channel_Code" ref="4914d1ec0aa65080ab46b42b5d3137c0" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#4914d1ec0aa65080ab46b42b5d3137c0">Channel_Code</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf5f8995f9671983567feb9a90553b65"></a><!-- doxytag: member="itpp::Channel_Code::~Channel_Code" ref="bf5f8995f9671983567feb9a90553b65" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#bf5f8995f9671983567feb9a90553b65">~Channel_Code</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e151b53b207d644598360537dacaf91"></a><!-- doxytag: member="itpp::Channel_Code::encode" ref="8e151b53b207d644598360537dacaf91" args="(const bvec &amp;uncoded_bits, bvec &amp;coded_bits)=0" -->
93virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#8e151b53b207d644598360537dacaf91">encode</a> (const bvec &amp;uncoded_bits, bvec &amp;coded_bits)=0</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode a bvec of input. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c7564272c52e3721154c6ab60a04a41"></a><!-- doxytag: member="itpp::Channel_Code::encode" ref="8c7564272c52e3721154c6ab60a04a41" args="(const bvec &amp;uncoded_bits)=0" -->
97virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#8c7564272c52e3721154c6ab60a04a41">encode</a> (const bvec &amp;uncoded_bits)=0</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode a bvec of input. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6c5afdb8f2760f27d64663f94587b9a"></a><!-- doxytag: member="itpp::Channel_Code::decode" ref="e6c5afdb8f2760f27d64663f94587b9a" args="(const bvec &amp;codedbits, bvec &amp;decoded_bits)=0" -->
101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#e6c5afdb8f2760f27d64663f94587b9a">decode</a> (const bvec &amp;codedbits, bvec &amp;decoded_bits)=0</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode a bvec of coded data. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ca72fa5944f5d7ad86f690a4fd92db7"></a><!-- doxytag: member="itpp::Channel_Code::decode" ref="5ca72fa5944f5d7ad86f690a4fd92db7" args="(const bvec &amp;coded_bits)=0" -->
105virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#5ca72fa5944f5d7ad86f690a4fd92db7">decode</a> (const bvec &amp;coded_bits)=0</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode a bvec of coded data. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="904ec5436185e2b0b3838e834c24637d"></a><!-- doxytag: member="itpp::Channel_Code::decode" ref="904ec5436185e2b0b3838e834c24637d" args="(const vec &amp;received_signal, bvec &amp;decoded_bits)=0" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#904ec5436185e2b0b3838e834c24637d">decode</a> (const vec &amp;received_signal, bvec &amp;decoded_bits)=0</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode a vec of received data. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da54df6cfcd16e2f6e21dbcc3e4c87f8"></a><!-- doxytag: member="itpp::Channel_Code::decode" ref="da54df6cfcd16e2f6e21dbcc3e4c87f8" args="(const vec &amp;received_signal)=0" -->
113virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#da54df6cfcd16e2f6e21dbcc3e4c87f8">decode</a> (const vec &amp;received_signal)=0</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode a vec of received data. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5dbe6bc0940f0423c0507d5ca54bab93"></a><!-- doxytag: member="itpp::Channel_Code::get_rate" ref="5dbe6bc0940f0423c0507d5ca54bab93" args="() const =0" -->
117virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Channel__Code.html#5dbe6bc0940f0423c0507d5ca54bab93">get_rate</a> () const =0</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the code rate. <br></td></tr>
120</table>
121<hr><a name="_details"></a><h2>Detailed Description</h2>
122Generic Channel Code class. <hr>The documentation for this class was generated from the following file:<ul>
123<li><a class="el" href="channel__code_8h-source.html">channel_code.h</a></ul>
124</div>
125<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
126<a href="http://www.doxygen.org/index.html">
127<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
128</body>
129</html>
Note: See TracBrowser for help on using the browser.