root/doc/html/classitpp_1_1LDPC__Generator.html @ 354

Revision 353, 9.6 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::LDPC_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_1LDPC__Generator.html">LDPC_Generator</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::LDPC_Generator Class Reference</h1><!-- doxytag: class="itpp::LDPC_Generator" -->LDPC Generator pure virtual base 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_1LDPC__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="da814d8755e0487539ff726361e8ee99"></a><!-- doxytag: member="itpp::LDPC_Generator::LDPC_Generator" ref="da814d8755e0487539ff726361e8ee99" args="(const std::string &amp;type_in=&quot;&quot;)" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#da814d8755e0487539ff726361e8ee99">LDPC_Generator</a> (const std::string &amp;type_in=&quot;&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="65679f09648fe18f850e156aa1cff432"></a><!-- doxytag: member="itpp::LDPC_Generator::~LDPC_Generator" ref="65679f09648fe18f850e156aa1cff432" args="()" -->
86virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#65679f09648fe18f850e156aa1cff432">~LDPC_Generator</a> ()</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0b88b84513103f2d1c19d62284648c2"></a><!-- doxytag: member="itpp::LDPC_Generator::encode" ref="c0b88b84513103f2d1c19d62284648c2" args="(const bvec &amp;input, bvec &amp;output)=0" -->
90virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#c0b88b84513103f2d1c19d62284648c2">encode</a> (const bvec &amp;input, bvec &amp;output)=0</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generator specific encode function. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08a7401d1e74e5bf7125315690714a1b"></a><!-- doxytag: member="itpp::LDPC_Generator::get_type" ref="08a7401d1e74e5bf7125315690714a1b" args="() const " -->
94std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#08a7401d1e74e5bf7125315690714a1b">get_type</a> () const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return generator type. <br></td></tr>
97<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6dc3ede11c56d04304c480b04507b8e5"></a><!-- doxytag: member="itpp::LDPC_Generator::save" ref="6dc3ede11c56d04304c480b04507b8e5" args="(const std::string &amp;filename) const =0" -->
99virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#6dc3ede11c56d04304c480b04507b8e5">save</a> (const std::string &amp;filename) const =0</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save generator data to a file. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8973051cc4b7073f84b2e3607c8ba837"></a><!-- doxytag: member="itpp::LDPC_Generator::load" ref="8973051cc4b7073f84b2e3607c8ba837" args="(const std::string &amp;filename)=0" -->
103virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#8973051cc4b7073f84b2e3607c8ba837">load</a> (const std::string &amp;filename)=0</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read generator data from a file. <br></td></tr>
106<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="269fad976f1590c09c5331b2cb7407bc"></a><!-- doxytag: member="itpp::LDPC_Generator::init_flag" ref="269fad976f1590c09c5331b2cb7407bc" args="" -->
108bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#269fad976f1590c09c5331b2cb7407bc">init_flag</a></td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if generator is initialized. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a3ee287a74880985500b0470c10393f"></a><!-- doxytag: member="itpp::LDPC_Generator::type" ref="3a3ee287a74880985500b0470c10393f" args="" -->
112std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1LDPC__Generator.html#3a3ee287a74880985500b0470c10393f">type</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generator type. <br></td></tr>
115<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c5a92585a571ccbff3d2eab54915ef8"></a><!-- doxytag: member="itpp::LDPC_Generator::LDPC_Code" ref="4c5a92585a571ccbff3d2eab54915ef8" args="" -->
117class&nbsp;</td><td class="memItemRight" valign="bottom"><b>LDPC_Code</b></td></tr>
118
119</table>
120<hr><a name="_details"></a><h2>Detailed Description</h2>
121LDPC Generator pure virtual base class.
122<p>
123This is an abstract base class for LDPC generators. It provides a generic interface that is used by the <code><a class="el" href="classitpp_1_1LDPC__Code.html" title="Low-density parity check (LDPC) codec.">LDPC_Code</a></code> class. The <code><a class="el" href="classitpp_1_1LDPC__Generator.html" title="LDPC Generator pure virtual base class.">LDPC_Generator</a></code> class can be inherited to create a new type of generator. In addition to the default constructor, the following three pure virtual methods need to be defined in a derived class: <code><a class="el" href="classitpp_1_1LDPC__Generator.html#c0b88b84513103f2d1c19d62284648c2" title="Generator specific encode function.">encode()</a></code>, <code><a class="el" href="classitpp_1_1LDPC__Generator.html#6dc3ede11c56d04304c480b04507b8e5" title="Save generator data to a file.">save()</a></code> and <code><a class="el" href="classitpp_1_1LDPC__Generator.html#8973051cc4b7073f84b2e3607c8ba837" title="Read generator data from a file.">load()</a></code>.<p>
124See the <code><a class="el" href="classitpp_1_1LDPC__Generator__Systematic.html" title="Systematic LDPC Generator class.">LDPC_Generator_Systematic</a></code> class for an example implementation of a derived generator.<p>
125<dl class="author" compact><dt><b>Author:</b></dt><dd>Adam Piatyszek </dd></dl>
126<hr>The documentation for this class was generated from the following file:<ul>
127<li><a class="el" href="ldpc_8h-source.html">ldpc.h</a></ul>
128</div>
129<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
130<a href="http://www.doxygen.org/index.html">
131<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
132</body>
133</html>
Note: See TracBrowser for help on using the browser.