root/doc/html/classitpp_1_1Reed__Solomon.html @ 353

Revision 353, 13.2 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::Reed_Solomon 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_1Reed__Solomon.html">Reed_Solomon</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Reed_Solomon Class Reference<br>
72<small>
73[<a class="el" href="group__fec.html">Forward Error Correcting Codes</a>]</small>
74</h1><!-- doxytag: class="itpp::Reed_Solomon" --><!-- doxytag: inherits="itpp::Channel_Code" -->Reed-Solomon Codes. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="reedsolomon_8h-source.html">reedsolomon.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Reed__Solomon-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="569487f380264de769c5fe142c8b12ad"></a><!-- doxytag: member="itpp::Reed_Solomon::Reed_Solomon" ref="569487f380264de769c5fe142c8b12ad" args="(int in_m, int in_t, bool sys=false)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#569487f380264de769c5fe142c8b12ad">Reed_Solomon</a> (int in_m, int in_t, bool sys=false)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor for the <img class="formulaInl" alt="$2^m$" src="form_307.png"> - ary, <img class="formulaInl" alt="$t$" src="form_54.png"> error correcting RS-code. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc6a799775767f0c4486399335d3484f"></a><!-- doxytag: member="itpp::Reed_Solomon::~Reed_Solomon" ref="dc6a799775767f0c4486399335d3484f" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#dc6a799775767f0c4486399335d3484f">~Reed_Solomon</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="24719bb3f2e49213b5f7ff67ac126a22"></a><!-- doxytag: member="itpp::Reed_Solomon::encode" ref="24719bb3f2e49213b5f7ff67ac126a22" 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_1Reed__Solomon.html#24719bb3f2e49213b5f7ff67ac126a22">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 function. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="24311c9cdd1f958f5e55ebe571d1d4ba"></a><!-- doxytag: member="itpp::Reed_Solomon::encode" ref="24311c9cdd1f958f5e55ebe571d1d4ba" args="(const bvec &amp;uncoded_bits)" -->
97virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#24311c9cdd1f958f5e55ebe571d1d4ba">encode</a> (const bvec &amp;uncoded_bits)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encoder function. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d081de5dc6c44daf3b1b83317ea5b10"></a><!-- doxytag: member="itpp::Reed_Solomon::decode" ref="7d081de5dc6c44daf3b1b83317ea5b10" 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_1Reed__Solomon.html#7d081de5dc6c44daf3b1b83317ea5b10">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 function. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9aa2bc593a7f745473cdc94d040f532"></a><!-- doxytag: member="itpp::Reed_Solomon::decode" ref="d9aa2bc593a7f745473cdc94d040f532" args="(const bvec &amp;coded_bits)" -->
105virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#d9aa2bc593a7f745473cdc94d040f532">decode</a> (const bvec &amp;coded_bits)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decoder function. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adf4c2642d4ad4ec8e9486650cdbb796"></a><!-- doxytag: member="itpp::Reed_Solomon::decode" ref="adf4c2642d4ad4ec8e9486650cdbb796" args="(const vec &amp;received_signal, bvec &amp;output)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#adf4c2642d4ad4ec8e9486650cdbb796">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="30746d97c5802b6f348bb467612bba7e"></a><!-- doxytag: member="itpp::Reed_Solomon::decode" ref="30746d97c5802b6f348bb467612bba7e" args="(const vec &amp;received_signal)" -->
113virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#30746d97c5802b6f348bb467612bba7e">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="206fd6f9d9516760c2840a504bc24b54"></a><!-- doxytag: member="itpp::Reed_Solomon::get_rate" ref="206fd6f9d9516760c2840a504bc24b54" args="() const " -->
117virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#206fd6f9d9516760c2840a504bc24b54">get_rate</a> () const </td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the rate of the RS-code. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99cfd5a270dcc8502dc099013196e053"></a><!-- doxytag: member="itpp::Reed_Solomon::operator=" ref="99cfd5a270dcc8502dc099013196e053" args="(const Reed_Solomon &amp;)" -->
121<a class="el" href="classitpp_1_1Reed__Solomon.html">Reed_Solomon</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#99cfd5a270dcc8502dc099013196e053">operator=</a> (const <a class="el" href="classitpp_1_1Reed__Solomon.html">Reed_Solomon</a> &amp;)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dummy assignment operator - MSVC++ warning C4512. <br></td></tr>
124<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8ef6f8b2a5206b7d4642b9583f6215a"></a><!-- doxytag: member="itpp::Reed_Solomon::g" ref="a8ef6f8b2a5206b7d4642b9583f6215a" args="" -->
126<a class="el" href="classitpp_1_1GFX.html">GFX</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#a8ef6f8b2a5206b7d4642b9583f6215a">g</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The generator polynomial of the RS code. <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4b60e673292a6abb87d0389537bfe0c"></a><!-- doxytag: member="itpp::Reed_Solomon::systematic" ref="e4b60e673292a6abb87d0389537bfe0c" args="" -->
130const bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#e4b60e673292a6abb87d0389537bfe0c">systematic</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Whether or not the code is systematic. <br></td></tr>
133<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Reed__Solomon.html#daa2843f29cad4bc95b72dc8d378b929">m</a></td></tr>
135
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0512b639a451cea3d4bf654a7cf78bde"></a><!-- doxytag: member="itpp::Reed_Solomon::t" ref="0512b639a451cea3d4bf654a7cf78bde" args="" -->
137int&nbsp;</td><td class="memItemRight" valign="bottom"><b>t</b></td></tr>
138
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c27f565f9dd1d72baf7dd445d2f15482"></a><!-- doxytag: member="itpp::Reed_Solomon::k" ref="c27f565f9dd1d72baf7dd445d2f15482" args="" -->
140int&nbsp;</td><td class="memItemRight" valign="bottom"><b>k</b></td></tr>
141
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2922275c21615691b46773c075ef8f00"></a><!-- doxytag: member="itpp::Reed_Solomon::n" ref="2922275c21615691b46773c075ef8f00" args="" -->
143int&nbsp;</td><td class="memItemRight" valign="bottom"><b>n</b></td></tr>
144
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ffdd76b4a71a344b2bdb643b9942b9e"></a><!-- doxytag: member="itpp::Reed_Solomon::q" ref="7ffdd76b4a71a344b2bdb643b9942b9e" args="" -->
146int&nbsp;</td><td class="memItemRight" valign="bottom"><b>q</b></td></tr>
147
148</table>
149<hr><a name="_details"></a><h2>Detailed Description</h2>
150Reed-Solomon Codes.
151<p>
152Uses the Berlkamp-Massey algorithm for decoding as described in: S. B. Wicker, "Error Control Systems for digital communication and storage," Prentice Hall.<p>
153The code is <img class="formulaInl" alt="$2^m$" src="form_307.png"> - ary of length <img class="formulaInl" alt="$2^m-1$" src="form_308.png"> capable of correcting <img class="formulaInl" alt="$t$" src="form_54.png"> errors. <hr><h2>Member Data Documentation</h2>
154<a class="anchor" name="daa2843f29cad4bc95b72dc8d378b929"></a><!-- doxytag: member="itpp::Reed_Solomon::m" ref="daa2843f29cad4bc95b72dc8d378b929" args="" -->
155<div class="memitem">
156<div class="memproto">
157      <table class="memname">
158        <tr>
159          <td class="memname">int <a class="el" href="classitpp_1_1Reed__Solomon.html#daa2843f29cad4bc95b72dc8d378b929">itpp::Reed_Solomon::m</a><code> [protected]</code>          </td>
160        </tr>
161      </table>
162</div>
163<div class="memdoc">
164
165<p>
166Internal encoder/decoder parameters
167<p>Referenced by <a class="el" href="reedsolomon_8cpp-source.html#l00119">decode()</a>, <a class="el" href="reedsolomon_8cpp-source.html#l00069">encode()</a>, and <a class="el" href="reedsolomon_8cpp-source.html#l00054">Reed_Solomon()</a>.</p>
168
169</div>
170</div><p>
171<hr>The documentation for this class was generated from the following files:<ul>
172<li><a class="el" href="reedsolomon_8h-source.html">reedsolomon.h</a><li><a class="el" href="reedsolomon_8cpp.html">reedsolomon.cpp</a></ul>
173</div>
174<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
175<a href="http://www.doxygen.org/index.html">
176<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
177</body>
178</html>
Note: See TracBrowser for help on using the browser.