root/doc/html/classitpp_1_1Hamming__Code.html @ 353

Revision 353, 11.1 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::Hamming_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_1Hamming__Code.html">Hamming_Code</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Hamming_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::Hamming_Code" --><!-- doxytag: inherits="itpp::Channel_Code" -->Binary Hamming codes. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="hammcode_8h-source.html">hammcode.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Hamming__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="e79a934c6b03ee606dde63126a04cc4a"></a><!-- doxytag: member="itpp::Hamming_Code::Hamming_Code" ref="e79a934c6b03ee606dde63126a04cc4a" args="(int m)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#e79a934c6b03ee606dde63126a04cc4a">Hamming_Code</a> (int m)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor for <code>hamming(n,k)</code>. n = pow(2,m)-1 and k = pow(2,m)-m-1. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbf2a2ea27cd7549caaa6ca2522e042a"></a><!-- doxytag: member="itpp::Hamming_Code::~Hamming_Code" ref="cbf2a2ea27cd7549caaa6ca2522e042a" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#cbf2a2ea27cd7549caaa6ca2522e042a">~Hamming_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="0ba41d4af1fffdb67dfd027c7f0fe667"></a><!-- doxytag: member="itpp::Hamming_Code::encode" ref="0ba41d4af1fffdb67dfd027c7f0fe667" args="(const bvec &amp;uncoded_bits, bvec &amp;coded_bits)" -->
93virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#0ba41d4af1fffdb67dfd027c7f0fe667">encode</a> (const bvec &amp;uncoded_bits, bvec &amp;coded_bits)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hamming encoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * <em>k</em>. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c93ab1e395e02bcd685f6fae3ebf333d"></a><!-- doxytag: member="itpp::Hamming_Code::encode" ref="c93ab1e395e02bcd685f6fae3ebf333d" args="(const bvec &amp;uncoded_bits)" -->
97virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#c93ab1e395e02bcd685f6fae3ebf333d">encode</a> (const bvec &amp;uncoded_bits)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hamming encoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * <em>k</em>. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf97e226ec6c64105be98167afe01ee1"></a><!-- doxytag: member="itpp::Hamming_Code::decode" ref="cf97e226ec6c64105be98167afe01ee1" args="(const bvec &amp;coded_bits, bvec &amp;decoded_bits)" -->
101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#cf97e226ec6c64105be98167afe01ee1">decode</a> (const bvec &amp;coded_bits, bvec &amp;decoded_bits)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hamming decoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * <em>n</em>. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f26c7df80d892a3e924078bd4eb5b3c0"></a><!-- doxytag: member="itpp::Hamming_Code::decode" ref="f26c7df80d892a3e924078bd4eb5b3c0" args="(const bvec &amp;coded_bits)" -->
105virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#f26c7df80d892a3e924078bd4eb5b3c0">decode</a> (const bvec &amp;coded_bits)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hamming decoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * <em>n</em>. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5afaacb3037f35d598b521e5590db635"></a><!-- doxytag: member="itpp::Hamming_Code::decode" ref="5afaacb3037f35d598b521e5590db635" args="(const vec &amp;received_signal, bvec &amp;output)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#5afaacb3037f35d598b521e5590db635">decode</a> (const vec &amp;received_signal, bvec &amp;output)</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="097abe310dc026d18fd7722630ba4262"></a><!-- doxytag: member="itpp::Hamming_Code::decode" ref="097abe310dc026d18fd7722630ba4262" args="(const vec &amp;received_signal)" -->
113virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#097abe310dc026d18fd7722630ba4262">decode</a> (const vec &amp;received_signal)</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="897c2c475b2aaa9bfe0d20f346274498"></a><!-- doxytag: member="itpp::Hamming_Code::get_rate" ref="897c2c475b2aaa9bfe0d20f346274498" args="() const " -->
117virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#897c2c475b2aaa9bfe0d20f346274498">get_rate</a> () const </td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the code rate. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3496b35f31f318a57d24bb3c8acfe01"></a><!-- doxytag: member="itpp::Hamming_Code::get_n" ref="d3496b35f31f318a57d24bb3c8acfe01" args="() const " -->
121int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#d3496b35f31f318a57d24bb3c8acfe01">get_n</a> () const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the code length <em>n</em>. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc5e724c3ce0d4a0051c3983771e51bb"></a><!-- doxytag: member="itpp::Hamming_Code::get_k" ref="cc5e724c3ce0d4a0051c3983771e51bb" args="() const " -->
125int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#cc5e724c3ce0d4a0051c3983771e51bb">get_k</a> () const </td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the number of information bits per code word, <em>k</em>. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09bf10714000b002320d6aedf9b59664"></a><!-- doxytag: member="itpp::Hamming_Code::get_H" ref="09bf10714000b002320d6aedf9b59664" args="() const " -->
129<a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#09bf10714000b002320d6aedf9b59664">get_H</a> () const </td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the parity check matrix for the code. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc9fd25a88ffd26af3a6ac98a5e0a550"></a><!-- doxytag: member="itpp::Hamming_Code::get_G" ref="bc9fd25a88ffd26af3a6ac98a5e0a550" args="() const " -->
133<a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Hamming__Code.html#bc9fd25a88ffd26af3a6ac98a5e0a550">get_G</a> () const </td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the generator matrix for the code. <br></td></tr>
136</table>
137<hr><a name="_details"></a><h2>Detailed Description</h2>
138Binary Hamming codes. <hr>The documentation for this class was generated from the following files:<ul>
139<li><a class="el" href="hammcode_8h-source.html">hammcode.h</a><li><a class="el" href="hammcode_8cpp.html">hammcode.cpp</a></ul>
140</div>
141<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
142<a href="http://www.doxygen.org/index.html">
143<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
144</body>
145</html>
Note: See TracBrowser for help on using the browser.