root/doc/html/classitpp_1_1BLDPC__Generator.html @ 354

Revision 353, 12.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::BLDPC_Generator 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_1BLDPC__Generator.html">BLDPC_Generator</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::BLDPC_Generator Class Reference</h1><!-- doxytag: class="itpp::BLDPC_Generator" --><!-- doxytag: inherits="itpp::LDPC_Generator" -->Block LDPC Generator class. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="ldpc_8h-source.html">ldpc.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1BLDPC__Generator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99a98629158668fc1dd4b6fd4949a66a"></a><!-- doxytag: member="itpp::BLDPC_Generator::BLDPC_Generator" ref="99a98629158668fc1dd4b6fd4949a66a" args="(const std::string type=&quot;BLDPC&quot;)" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#99a98629158668fc1dd4b6fd4949a66a">BLDPC_Generator</a> (const std::string <a class="el" href="classitpp_1_1LDPC__Generator.html#3a3ee287a74880985500b0470c10393f">type</a>=&quot;BLDPC&quot;)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="763ba6d940d6c9d3850d9a05e9ce2bf5"></a><!-- doxytag: member="itpp::BLDPC_Generator::BLDPC_Generator" ref="763ba6d940d6c9d3850d9a05e9ce2bf5" args="(const BLDPC_Parity *const H, const std::string type=&quot;BLDPC&quot;)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#763ba6d940d6c9d3850d9a05e9ce2bf5">BLDPC_Generator</a> (const <a class="el" href="classitpp_1_1BLDPC__Parity.html">BLDPC_Parity</a> *const H, const std::string <a class="el" href="classitpp_1_1LDPC__Generator.html#3a3ee287a74880985500b0470c10393f">type</a>=&quot;BLDPC&quot;)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parametrized constructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56757cc11a4f2737df2cf7144edfeb9d"></a><!-- doxytag: member="itpp::BLDPC_Generator::get_exp_factor" ref="56757cc11a4f2737df2cf7144edfeb9d" args="() const " -->
90int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#56757cc11a4f2737df2cf7144edfeb9d">get_exp_factor</a> () const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get expansion factor. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6fdf4df53cb36c1753c5a37d205aaff"></a><!-- doxytag: member="itpp::BLDPC_Generator::encode" ref="f6fdf4df53cb36c1753c5a37d205aaff" args="(const bvec &amp;input, bvec &amp;output)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#f6fdf4df53cb36c1753c5a37d205aaff">encode</a> (const bvec &amp;input, bvec &amp;output)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generator specific encode function. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c3fd4be8398563cf3bf8d216905bce8"></a><!-- doxytag: member="itpp::BLDPC_Generator::construct" ref="3c3fd4be8398563cf3bf8d216905bce8" args="(const BLDPC_Parity *const H)" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#3c3fd4be8398563cf3bf8d216905bce8">construct</a> (const <a class="el" href="classitpp_1_1BLDPC__Parity.html">BLDPC_Parity</a> *const H)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct the BLDPC generator. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08a7401d1e74e5bf7125315690714a1b"></a><!-- doxytag: member="itpp::BLDPC_Generator::get_type" ref="08a7401d1e74e5bf7125315690714a1b" args="() const " -->
102std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#08a7401d1e74e5bf7125315690714a1b">get_type</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return generator type. <br></td></tr>
105<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="132ce5aa532f32d05281871f3bc1aa58"></a><!-- doxytag: member="itpp::BLDPC_Generator::save" ref="132ce5aa532f32d05281871f3bc1aa58" args="(const std::string &amp;filename) const " -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#132ce5aa532f32d05281871f3bc1aa58">save</a> (const std::string &amp;filename) const </td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save generator data to a file. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a22307edd5abe03e750382514dcef7c0"></a><!-- doxytag: member="itpp::BLDPC_Generator::load" ref="a22307edd5abe03e750382514dcef7c0" args="(const std::string &amp;filename)" -->
111void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#a22307edd5abe03e750382514dcef7c0">load</a> (const std::string &amp;filename)</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read generator data from a file. <br></td></tr>
114<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cb9d76420526cf025f5bf2a16a7d488"></a><!-- doxytag: member="itpp::BLDPC_Generator::H_enc" ref="4cb9d76420526cf025f5bf2a16a7d488" args="" -->
116<a class="el" href="classitpp_1_1GF2mat.html">GF2mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#4cb9d76420526cf025f5bf2a16a7d488">H_enc</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preprocessed parity check matrix. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa2d7c7becef8f6271d836f69c15b11c"></a><!-- doxytag: member="itpp::BLDPC_Generator::N" ref="aa2d7c7becef8f6271d836f69c15b11c" args="" -->
120int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#aa2d7c7becef8f6271d836f69c15b11c">N</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Codeword length = H_enc.cols(). <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b4eda3b4e9141f31b5dbee0b2006c48"></a><!-- doxytag: member="itpp::BLDPC_Generator::M" ref="8b4eda3b4e9141f31b5dbee0b2006c48" args="" -->
124int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#8b4eda3b4e9141f31b5dbee0b2006c48">M</a></td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of parity check bits = H_enc.rows(). <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d44f2281b0499b4e1ad7e6569fd00f40"></a><!-- doxytag: member="itpp::BLDPC_Generator::K" ref="d44f2281b0499b4e1ad7e6569fd00f40" args="" -->
128int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#d44f2281b0499b4e1ad7e6569fd00f40">K</a></td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of information bits = N-M. <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70567e717dfc33ba053896b6936116a8"></a><!-- doxytag: member="itpp::BLDPC_Generator::Z" ref="70567e717dfc33ba053896b6936116a8" args="" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLDPC__Generator.html#70567e717dfc33ba053896b6936116a8">Z</a></td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expansion factor. <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="269fad976f1590c09c5331b2cb7407bc"></a><!-- doxytag: member="itpp::BLDPC_Generator::init_flag" ref="269fad976f1590c09c5331b2cb7407bc" args="" -->
136bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#269fad976f1590c09c5331b2cb7407bc">init_flag</a></td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if generator is initialized. <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a3ee287a74880985500b0470c10393f"></a><!-- doxytag: member="itpp::BLDPC_Generator::type" ref="3a3ee287a74880985500b0470c10393f" args="" -->
140std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#3a3ee287a74880985500b0470c10393f">type</a></td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generator type. <br></td></tr>
143</table>
144<hr><a name="_details"></a><h2>Detailed Description</h2>
145Block LDPC Generator class.
146<p>
147<dl class="author" compact><dt><b>Author:</b></dt><dd>Adam Piatyszek</dd></dl>
148<dl class="note" compact><dt><b>Note:</b></dt><dd>Please refer to the <a class="el" href="classitpp_1_1BLDPC__Parity.html" title="Block LDPC code parity-check matrix.">BLDPC_Parity</a> class description for information on B-LDPC codes </dd></dl>
149<hr>The documentation for this class was generated from the following files:<ul>
150<li><a class="el" href="ldpc_8h-source.html">ldpc.h</a><li><a class="el" href="ldpc_8cpp.html">ldpc.cpp</a></ul>
151</div>
152<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
153<a href="http://www.doxygen.org/index.html">
154<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
155</body>
156</html>
Note: See TracBrowser for help on using the browser.