root/doc/html/classitpp_1_1Extended__Golay.html @ 354

Revision 353, 9.8 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::Extended_Golay 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_1Extended__Golay.html">Extended_Golay</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Extended_Golay Class Reference<br>
72<small>
73[<a class="el" href="group__fec.html">Forward Error Correcting Codes</a>]</small>
74</h1><!-- doxytag: class="itpp::Extended_Golay" --><!-- doxytag: inherits="itpp::Channel_Code" -->Extended Golay code (24,12,8). 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="egolay_8h-source.html">egolay.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Extended__Golay-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="122575a88fc60b28892ca444e3af80ed"></a><!-- doxytag: member="itpp::Extended_Golay::Extended_Golay" ref="122575a88fc60b28892ca444e3af80ed" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#122575a88fc60b28892ca444e3af80ed">Extended_Golay</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d414de784c7d645e418a643a6c0ce9f1"></a><!-- doxytag: member="itpp::Extended_Golay::~Extended_Golay" ref="d414de784c7d645e418a643a6c0ce9f1" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#d414de784c7d645e418a643a6c0ce9f1">~Extended_Golay</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="5ac3d9d36ea970ad2236129370d2ebaf"></a><!-- doxytag: member="itpp::Extended_Golay::encode" ref="5ac3d9d36ea970ad2236129370d2ebaf" 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_1Extended__Golay.html#5ac3d9d36ea970ad2236129370d2ebaf">encode</a> (const bvec &amp;uncoded_bits, bvec &amp;coded_bits)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * 12. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cd790dd09f46f597d80bb539739d640"></a><!-- doxytag: member="itpp::Extended_Golay::encode" ref="4cd790dd09f46f597d80bb539739d640" args="(const bvec &amp;uncoded_bits)" -->
97virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#4cd790dd09f46f597d80bb539739d640">encode</a> (const bvec &amp;uncoded_bits)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * 12. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cf29cba49dee11ff6459b8eb21b2a8f"></a><!-- doxytag: member="itpp::Extended_Golay::decode" ref="2cf29cba49dee11ff6459b8eb21b2a8f" 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_1Extended__Golay.html#2cf29cba49dee11ff6459b8eb21b2a8f">decode</a> (const bvec &amp;coded_bits, bvec &amp;decoded_bits)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * 24. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7c70ebb4ffb1710a70459ea5f72af84"></a><!-- doxytag: member="itpp::Extended_Golay::decode" ref="e7c70ebb4ffb1710a70459ea5f72af84" args="(const bvec &amp;coded_bits)" -->
105virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#e7c70ebb4ffb1710a70459ea5f72af84">decode</a> (const bvec &amp;coded_bits)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decoder. Will truncate some bits if not <em>length</em> = <code>integer</code> * 24. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8de1be3f51dc31c42c6b22aad9d082fb"></a><!-- doxytag: member="itpp::Extended_Golay::decode" ref="8de1be3f51dc31c42c6b22aad9d082fb" args="(const vec &amp;received_signal, bvec &amp;output)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#8de1be3f51dc31c42c6b22aad9d082fb">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="96f4d130d26c412b2f028eff7864acbd"></a><!-- doxytag: member="itpp::Extended_Golay::decode" ref="96f4d130d26c412b2f028eff7864acbd" args="(const vec &amp;received_signal)" -->
113virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#96f4d130d26c412b2f028eff7864acbd">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="de58a8cbd4503d9785fefb09e5a1cac5"></a><!-- doxytag: member="itpp::Extended_Golay::get_rate" ref="de58a8cbd4503d9785fefb09e5a1cac5" args="() const " -->
117virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#de58a8cbd4503d9785fefb09e5a1cac5">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="a0dcaa032503d2e32336651ca6095581"></a><!-- doxytag: member="itpp::Extended_Golay::get_G" ref="a0dcaa032503d2e32336651ca6095581" args="() const " -->
121<a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Extended__Golay.html#a0dcaa032503d2e32336651ca6095581">get_G</a> () const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the generator matrix for the code (also the parity check matrix). <br></td></tr>
124</table>
125<hr><a name="_details"></a><h2>Detailed Description</h2>
126Extended Golay code (24,12,8).
127<p>
128<dl class="author" compact><dt><b>Author:</b></dt><dd>Tony Ottosson</dd></dl>
129The code is given in systematic form with the information bits first, followed by the parity check bits. The decoder uses the arithmetic decoding algorithm that is for example described in Wicker "Error Control Systems for Digital Communication and Storage", Prentice Hall, 1995 (page 143). <hr>The documentation for this class was generated from the following files:<ul>
130<li><a class="el" href="egolay_8h-source.html">egolay.h</a><li><a class="el" href="egolay_8cpp.html">egolay.cpp</a></ul>
131</div>
132<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
133<a href="http://www.doxygen.org/index.html">
134<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
135</body>
136</html>
Note: See TracBrowser for help on using the browser.