root/doc/html/hammcode_8h-source.html @ 353

Revision 353, 9.7 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[353]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: hammcode.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65<h1>hammcode.h</h1><a href="hammcode_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
66<a name="l00029"></a>00029 <span class="preprocessor">#ifndef HAMMING_H</span>
67<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define HAMMING_H</span>
68<a name="l00031"></a>00031 <span class="preprocessor"></span>
69<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="vec_8h.html" title="Templated Vector Class Definitions.">itpp/base/vec.h</a>&gt;</span>
70<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;<a class="code" href="mat_8h.html" title="Matrix Class Definitions.">itpp/base/mat.h</a>&gt;</span>
71<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;<a class="code" href="channel__code_8h.html" title="Channel Code class virtual interface.">itpp/comm/channel_code.h</a>&gt;</span>
72<a name="l00035"></a>00035
73<a name="l00036"></a>00036
74<a name="l00037"></a>00037 <span class="keyword">namespace </span>itpp
75<a name="l00038"></a>00038 {
76<a name="l00039"></a>00039
77<a name="l00044"></a><a class="code" href="classitpp_1_1Hamming__Code.html">00044</a> <span class="keyword">class </span><a class="code" href="classitpp_1_1Hamming__Code.html" title="Binary Hamming codes.">Hamming_Code</a> : <span class="keyword">public</span> <a class="code" href="classitpp_1_1Channel__Code.html" title="Generic Channel Code class.">Channel_Code</a>
78<a name="l00045"></a>00045 {
79<a name="l00046"></a>00046 <span class="keyword">public</span>:
80<a name="l00048"></a>00048   <a class="code" href="classitpp_1_1Hamming__Code.html#e79a934c6b03ee606dde63126a04cc4a" title="Constructor for hamming(n,k). n = pow(2,m)-1 and k = pow(2,m)-m-1.">Hamming_Code</a>(<span class="keywordtype">int</span> m);
81<a name="l00049"></a>00049
82<a name="l00051"></a><a class="code" href="classitpp_1_1Hamming__Code.html#cbf2a2ea27cd7549caaa6ca2522e042a">00051</a>   <span class="keyword">virtual</span> <a class="code" href="classitpp_1_1Hamming__Code.html#cbf2a2ea27cd7549caaa6ca2522e042a" title="Destructor.">~Hamming_Code</a>() { }
83<a name="l00052"></a>00052
84<a name="l00054"></a>00054   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classitpp_1_1Hamming__Code.html#0ba41d4af1fffdb67dfd027c7f0fe667" title="Hamming encoder. Will truncate some bits if not length = integer * k.">encode</a>(<span class="keyword">const</span> bvec &amp;uncoded_bits, bvec &amp;coded_bits);
85<a name="l00056"></a>00056   <span class="keyword">virtual</span> bvec <a class="code" href="classitpp_1_1Hamming__Code.html#0ba41d4af1fffdb67dfd027c7f0fe667" title="Hamming encoder. Will truncate some bits if not length = integer * k.">encode</a>(<span class="keyword">const</span> bvec &amp;uncoded_bits);
86<a name="l00057"></a>00057
87<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classitpp_1_1Hamming__Code.html#cf97e226ec6c64105be98167afe01ee1" title="Hamming decoder. Will truncate some bits if not length = integer * n.">decode</a>(<span class="keyword">const</span> bvec &amp;coded_bits, bvec &amp;decoded_bits);
88<a name="l00061"></a>00061   <span class="keyword">virtual</span> bvec <a class="code" href="classitpp_1_1Hamming__Code.html#cf97e226ec6c64105be98167afe01ee1" title="Hamming decoder. Will truncate some bits if not length = integer * n.">decode</a>(<span class="keyword">const</span> bvec &amp;coded_bits);
89<a name="l00062"></a>00062
90<a name="l00063"></a>00063   <span class="comment">// Soft-decision decoding is not implemented</span>
91<a name="l00064"></a>00064   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classitpp_1_1Hamming__Code.html#cf97e226ec6c64105be98167afe01ee1" title="Hamming decoder. Will truncate some bits if not length = integer * n.">decode</a>(<span class="keyword">const</span> vec &amp;received_signal, bvec &amp;output);
92<a name="l00065"></a>00065   <span class="keyword">virtual</span> bvec <a class="code" href="classitpp_1_1Hamming__Code.html#cf97e226ec6c64105be98167afe01ee1" title="Hamming decoder. Will truncate some bits if not length = integer * n.">decode</a>(<span class="keyword">const</span> vec &amp;received_signal);
93<a name="l00066"></a>00066
94<a name="l00068"></a><a class="code" href="classitpp_1_1Hamming__Code.html#897c2c475b2aaa9bfe0d20f346274498">00068</a>   <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classitpp_1_1Hamming__Code.html#897c2c475b2aaa9bfe0d20f346274498" title="Get the code rate.">get_rate</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(k) / n; };
95<a name="l00069"></a>00069
96<a name="l00071"></a><a class="code" href="classitpp_1_1Hamming__Code.html#d3496b35f31f318a57d24bb3c8acfe01">00071</a>   <span class="keywordtype">int</span> <a class="code" href="classitpp_1_1Hamming__Code.html#d3496b35f31f318a57d24bb3c8acfe01" title="Gets the code length n.">get_n</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> n; };
97<a name="l00073"></a><a class="code" href="classitpp_1_1Hamming__Code.html#cc5e724c3ce0d4a0051c3983771e51bb">00073</a>   <span class="keywordtype">int</span> <a class="code" href="classitpp_1_1Hamming__Code.html#cc5e724c3ce0d4a0051c3983771e51bb" title="Gets the number of information bits per code word, k.">get_k</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> k; };
98<a name="l00075"></a><a class="code" href="classitpp_1_1Hamming__Code.html#09bf10714000b002320d6aedf9b59664">00075</a>   <a class="code" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69" title="bin matrix">bmat</a> <a class="code" href="classitpp_1_1Hamming__Code.html#09bf10714000b002320d6aedf9b59664" title="Gets the parity check matrix for the code.">get_H</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> H; };
99<a name="l00077"></a><a class="code" href="classitpp_1_1Hamming__Code.html#bc9fd25a88ffd26af3a6ac98a5e0a550">00077</a>   <a class="code" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69" title="bin matrix">bmat</a> <a class="code" href="classitpp_1_1Hamming__Code.html#bc9fd25a88ffd26af3a6ac98a5e0a550" title="Gets the generator matrix for the code.">get_G</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> G; };
100<a name="l00078"></a>00078 <span class="keyword">private</span>:
101<a name="l00079"></a>00079   <span class="keywordtype">int</span> n, k;
102<a name="l00080"></a>00080   <a class="code" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69" title="bin matrix">bmat</a> H, G;
103<a name="l00081"></a>00081   <span class="keywordtype">void</span> generate_H(<span class="keywordtype">void</span>);
104<a name="l00082"></a>00082   <span class="keywordtype">void</span> generate_G(<span class="keywordtype">void</span>);
105<a name="l00083"></a>00083 };
106<a name="l00084"></a>00084
107<a name="l00085"></a>00085 } <span class="comment">// namespace itpp</span>
108<a name="l00086"></a>00086
109<a name="l00087"></a>00087 <span class="preprocessor">#endif // #ifndef HAMMING_H</span>
110</pre></div></div>
111<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:11 2009 for mixpp by&nbsp;
112<a href="http://www.doxygen.org/index.html">
113<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
114</body>
115</html>
Note: See TracBrowser for help on using the browser.