root/doc/html/classitpp_1_1GF2mat__sparse__alist.html @ 354

Revision 353, 16.7 kB (checked in by smidl, 15 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::GF2mat_sparse_alist 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_1GF2mat__sparse__alist.html">GF2mat_sparse_alist</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::GF2mat_sparse_alist Class Reference</h1><!-- doxytag: class="itpp::GF2mat_sparse_alist" -->Parameterized "alist" representation of sparse GF(2) matrix. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="gf2mat_8h-source.html">gf2mat.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1GF2mat__sparse__alist-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="c058d66758b5076f711421bef945061e"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::GF2mat_sparse_alist" ref="c058d66758b5076f711421bef945061e" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#c058d66758b5076f711421bef945061e">GF2mat_sparse_alist</a> ()</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="d2f6e6cd2d712cc46633027dc7dfc1dc"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::GF2mat_sparse_alist" ref="d2f6e6cd2d712cc46633027dc7dfc1dc" args="(const std::string &amp;fname)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#d2f6e6cd2d712cc46633027dc7dfc1dc">GF2mat_sparse_alist</a> (const std::string &amp;fname)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, which reads alist data from a file named <code>fname</code>. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="676b89278f1fbed07232bb8e06bb8786"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::read" ref="676b89278f1fbed07232bb8e06bb8786" args="(const std::string &amp;fname)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#676b89278f1fbed07232bb8e06bb8786">read</a> (const std::string &amp;fname)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read alist data from a file named <code>fname</code>. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f246f48dd50505b24571f4c96da131a"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::write" ref="4f246f48dd50505b24571f4c96da131a" args="(const std::string &amp;fname) const " -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#4f246f48dd50505b24571f4c96da131a">write</a> (const std::string &amp;fname) const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write alist data to a file named <code>fname</code>. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Sparse__Mat.html">GF2mat_sparse</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#c72be60c1521e9041f28d9fb366440ac">to_sparse</a> (bool transpose=false) const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert "alist" representation to <code>GF2mat_sparse</code>.  <a href="#c72be60c1521e9041f28d9fb366440ac"></a><br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#a7372759f1bb26b018f8a347407b53c1">from_sparse</a> (const <a class="el" href="classitpp_1_1Sparse__Mat.html">GF2mat_sparse</a> &amp;mat, bool transpose=false)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Import "alist" representation from <code>GF2mat_sparse</code>.  <a href="#a7372759f1bb26b018f8a347407b53c1"></a><br></td></tr>
103<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff9879ed9038a9f433a4ba75132a256e"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::data_ok" ref="ff9879ed9038a9f433a4ba75132a256e" args="" -->
105bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#ff9879ed9038a9f433a4ba75132a256e">data_ok</a></td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flag indicating that "alist" matrix data are properly set. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="271af063051df8084f6352de7f43d64d"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::M" ref="271af063051df8084f6352de7f43d64d" args="" -->
109int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#271af063051df8084f6352de7f43d64d">M</a></td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the matrix: <code>M</code> rows x <code>N</code> columns. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8566797678b1b65e65fd2f89c5d56ce5"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::N" ref="8566797678b1b65e65fd2f89c5d56ce5" args="" -->
113int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#8566797678b1b65e65fd2f89c5d56ce5">N</a></td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the matrix: <code>M</code> rows x <code>N</code> columns. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28c56d18a7b72de1c3708d125660aef6"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::mlist" ref="28c56d18a7b72de1c3708d125660aef6" args="" -->
117imat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#28c56d18a7b72de1c3708d125660aef6">mlist</a></td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List of integer coordinates in the m direction with non-zero entries. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d1a20ca4167394364dfe08d4a171373"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::nlist" ref="7d1a20ca4167394364dfe08d4a171373" args="" -->
121imat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#7d1a20ca4167394364dfe08d4a171373">nlist</a></td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List of integer coordinates in the n direction with non-zero entries. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e852dd3e42999a7e6f21442f5dde2684"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::num_mlist" ref="e852dd3e42999a7e6f21442f5dde2684" args="" -->
125ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#e852dd3e42999a7e6f21442f5dde2684">num_mlist</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Weight of each row m. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9384d21436e6a0115b26106a132c3024"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::num_nlist" ref="9384d21436e6a0115b26106a132c3024" args="" -->
129ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#9384d21436e6a0115b26106a132c3024">num_nlist</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Weight of each column n. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02b6ed3e761959c93b443fec2c0867b1"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::max_num_m" ref="02b6ed3e761959c93b443fec2c0867b1" args="" -->
133int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#02b6ed3e761959c93b443fec2c0867b1">max_num_m</a></td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum weight of rows. <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22fcdedc34ed8da22e524a08d96f01bf"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::max_num_n" ref="22fcdedc34ed8da22e524a08d96f01bf" args="" -->
137int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html#22fcdedc34ed8da22e524a08d96f01bf">max_num_n</a></td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum weight of columns. <br></td></tr>
140</table>
141<hr><a name="_details"></a><h2>Detailed Description</h2>
142Parameterized "alist" representation of sparse GF(2) matrix.
143<p>
144<dl class="author" compact><dt><b>Author:</b></dt><dd>Adam Piatyszek and Erik G. Larsson</dd></dl>
145This class is used to provide a parameterized representation of a <code>GF2mat_sparse</code> class. The format is compatible with the "alist" format defined by David MacKay, Matthew Davey and John Lafferty:<ul>
146<li><a href="http://www.inference.phy.cam.ac.uk/mackay/codes/alist.html">http://www.inference.phy.cam.ac.uk/mackay/codes/alist.html</a></li></ul>
147<p>
148For examples of "alist" representation visit David MacKay's Encyclopedia of Sparse Graph Codes:<ul>
149<li><a href="http://www.inference.phy.cam.ac.uk/mackay/codes/data.html">http://www.inference.phy.cam.ac.uk/mackay/codes/data.html</a> </li></ul>
150<hr><h2>Member Function Documentation</h2>
151<a class="anchor" name="a7372759f1bb26b018f8a347407b53c1"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::from_sparse" ref="a7372759f1bb26b018f8a347407b53c1" args="(const GF2mat_sparse &amp;mat, bool transpose=false)" -->
152<div class="memitem">
153<div class="memproto">
154      <table class="memname">
155        <tr>
156          <td class="memname">void itpp::GF2mat_sparse_alist::from_sparse           </td>
157          <td>(</td>
158          <td class="paramtype">const <a class="el" href="classitpp_1_1Sparse__Mat.html">GF2mat_sparse</a> &amp;&nbsp;</td>
159          <td class="paramname"> <em>mat</em>, </td>
160        </tr>
161        <tr>
162          <td class="paramkey"></td>
163          <td></td>
164          <td class="paramtype">bool&nbsp;</td>
165          <td class="paramname"> <em>transpose</em> = <code>false</code></td><td>&nbsp;</td>
166        </tr>
167        <tr>
168          <td></td>
169          <td>)</td>
170          <td></td><td></td><td></td>
171        </tr>
172      </table>
173</div>
174<div class="memdoc">
175
176<p>
177Import "alist" representation from <code>GF2mat_sparse</code>.
178<p>
179<dl compact><dt><b>Parameters:</b></dt><dd>
180  <table border="0" cellspacing="2" cellpadding="0">
181    <tr><td valign="top"></td><td valign="top"><em>mat</em>&nbsp;</td><td>Matrix to import </td></tr>
182    <tr><td valign="top"></td><td valign="top"><em>transpose</em>&nbsp;</td><td>Indicates whether a matrix should be transposed during the conversion process </td></tr>
183  </table>
184</dl>
185
186<p>References <a class="el" href="smat_8h-source.html#l00164">itpp::Sparse_Mat&lt; T &gt;::cols()</a>, <a class="el" href="gf2mat_8h-source.html#l00116">data_ok</a>, <a class="el" href="smat_8h-source.html#l00615">itpp::Sparse_Mat&lt; T &gt;::get_col()</a>, <a class="el" href="gf2mat_8h-source.html#l00118">M</a>, <a class="el" href="tcp_8h-source.html#l00117">itpp::max()</a>, <a class="el" href="gf2mat_8h-source.html#l00130">max_num_m</a>, <a class="el" href="gf2mat_8h-source.html#l00132">max_num_n</a>, <a class="el" href="gf2mat_8h-source.html#l00122">mlist</a>, <a class="el" href="gf2mat_8h-source.html#l00120">N</a>, <a class="el" href="gf2mat_8h-source.html#l00124">nlist</a>, <a class="el" href="gf2mat_8h-source.html#l00126">num_mlist</a>, <a class="el" href="gf2mat_8h-source.html#l00128">num_nlist</a>, <a class="el" href="smat_8h-source.html#l00161">itpp::Sparse_Mat&lt; T &gt;::rows()</a>, and <a class="el" href="smat_8h-source.html#l00636">itpp::Sparse_Mat&lt; T &gt;::transpose()</a>.</p>
187
188<p>Referenced by <a class="el" href="ldpc_8cpp-source.html#l00182">itpp::LDPC_Parity::export_alist()</a>.</p>
189
190</div>
191</div><p>
192<a class="anchor" name="c72be60c1521e9041f28d9fb366440ac"></a><!-- doxytag: member="itpp::GF2mat_sparse_alist::to_sparse" ref="c72be60c1521e9041f28d9fb366440ac" args="(bool transpose=false) const " -->
193<div class="memitem">
194<div class="memproto">
195      <table class="memname">
196        <tr>
197          <td class="memname"><a class="el" href="classitpp_1_1Sparse__Mat.html">GF2mat_sparse</a> itpp::GF2mat_sparse_alist::to_sparse           </td>
198          <td>(</td>
199          <td class="paramtype">bool&nbsp;</td>
200          <td class="paramname"> <em>transpose</em> = <code>false</code>          </td>
201          <td>&nbsp;)&nbsp;</td>
202          <td> const</td>
203        </tr>
204      </table>
205</div>
206<div class="memdoc">
207
208<p>
209Convert "alist" representation to <code>GF2mat_sparse</code>.
210<p>
211<dl compact><dt><b>Parameters:</b></dt><dd>
212  <table border="0" cellspacing="2" cellpadding="0">
213    <tr><td valign="top"></td><td valign="top"><em>transpose</em>&nbsp;</td><td>Indicates whether a matrix should be transposed during the conversion process </td></tr>
214  </table>
215</dl>
216
217<p>References <a class="el" href="smat_8h-source.html#l00471">itpp::Sparse_Mat&lt; T &gt;::compact()</a>, <a class="el" href="gf2mat_8h-source.html#l00118">M</a>, <a class="el" href="gf2mat_8h-source.html#l00130">max_num_m</a>, <a class="el" href="gf2mat_8h-source.html#l00122">mlist</a>, <a class="el" href="gf2mat_8h-source.html#l00120">N</a>, <a class="el" href="gf2mat_8h-source.html#l00126">num_mlist</a>, <a class="el" href="smat_8h-source.html#l00511">itpp::Sparse_Mat&lt; T &gt;::set_new()</a>, and <a class="el" href="smat_8h-source.html#l00636">itpp::Sparse_Mat&lt; T &gt;::transpose()</a>.</p>
218
219<p>Referenced by <a class="el" href="ldpc_8cpp-source.html#l00167">itpp::LDPC_Parity::import_alist()</a>.</p>
220
221</div>
222</div><p>
223<hr>The documentation for this class was generated from the following files:<ul>
224<li><a class="el" href="gf2mat_8h-source.html">gf2mat.h</a><li><a class="el" href="gf2mat_8cpp.html">gf2mat.cpp</a></ul>
225</div>
226<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
227<a href="http://www.doxygen.org/index.html">
228<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
229</body>
230</html>
Note: See TracBrowser for help on using the browser.