root/doc/html/gf2mat_8h.html @ 353

Revision 353, 10.5 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[353]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: gf2mat.h File 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><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>gf2mat.h File Reference</h1>Definition of a class for algebra on GF(2) (binary) matrices. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="vec_8h-source.html">itpp/base/vec.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="mat_8h-source.html">itpp/base/mat.h</a>&gt;</code><br>
72<code>#include &lt;<a class="el" href="svec_8h-source.html">itpp/base/svec.h</a>&gt;</code><br>
73<code>#include &lt;<a class="el" href="smat_8h-source.html">itpp/base/smat.h</a>&gt;</code><br>
74<code>#include &lt;<a class="el" href="itfile_8h-source.html">itpp/base/itfile.h</a>&gt;</code><br>
75
76<p>
77<a href="gf2mat_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat__sparse__alist.html">itpp::GF2mat_sparse_alist</a></td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parameterized "alist" representation of sparse GF(2) matrix.  <a href="classitpp_1_1GF2mat__sparse__alist.html#_details">More...</a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1GF2mat.html">itpp::GF2mat</a></td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class for dense GF(2) matrices.  <a href="classitpp_1_1GF2mat.html#_details">More...</a><br></td></tr>
86<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce0ed051b9f352b62ad77e7845a7f4c3"></a><!-- doxytag: member="gf2mat.h::GF2vec_sparse" ref="ce0ed051b9f352b62ad77e7845a7f4c3" args="" -->
88typedef Sparse_Vec&lt; bin &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#ce0ed051b9f352b62ad77e7845a7f4c3">itpp::GF2vec_sparse</a></td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sparse GF(2) vector. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9058a289bdfc4f48507558d3d6b39bd3"></a><!-- doxytag: member="gf2mat.h::GF2mat_sparse" ref="9058a289bdfc4f48507558d3d6b39bd3" args="" -->
92typedef Sparse_Mat&lt; bin &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#9058a289bdfc4f48507558d3d6b39bd3">itpp::GF2mat_sparse</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sparse GF(2) matrix. <br></td></tr>
95<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top">it_file &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#c16ab8f4fe2376b2199ea5572a18395b">itpp::operator&lt;&lt;</a> (it_file &amp;f, const GF2mat &amp;X)</td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top">it_ifile &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#019778d3ae4b64ad428df8c65a6c5e32">itpp::operator&gt;&gt;</a> (it_ifile &amp;f, GF2mat &amp;X)</td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top">GF2mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#c272d2dad7a03fcb4f648a1f04e99c8c">itpp::operator*</a> (const GF2mat &amp;X, const GF2mat &amp;Y)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GF(2) matrix multiplication.  <a href="#c272d2dad7a03fcb4f648a1f04e99c8c"></a><br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Vec.html#e10151f44bbabf17b670a9493d8088cf">bvec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#25a2817f97e5946b8fb0d14551387520">itpp::operator*</a> (const GF2mat &amp;X, const <a class="el" href="classitpp_1_1Vec.html#e10151f44bbabf17b670a9493d8088cf">bvec</a> &amp;y)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GF(2) matrix multiplication with "regular" binary vector.  <a href="#25a2817f97e5946b8fb0d14551387520"></a><br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top">GF2mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#f1f13cf996e90cbabbd46e5790b08287">itpp::operator+</a> (const GF2mat &amp;X, const GF2mat &amp;Y)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GF(2) matrix addition.  <a href="#f1f13cf996e90cbabbd46e5790b08287"></a><br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#189b6e6faee514b7aecaed8894b978ee">itpp::operator&lt;&lt;</a> (std::ostream &amp;os, const GF2mat &amp;X)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output stream (plain text) operator for dense GF(2) matrices.  <a href="#189b6e6faee514b7aecaed8894b978ee"></a><br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b07585c7d63aeb5a2f6d4dfd9b8333b3"></a><!-- doxytag: member="gf2mat.h::gf2dense_eye" ref="b07585c7d63aeb5a2f6d4dfd9b8333b3" args="(int m)" -->
113GF2mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#b07585c7d63aeb5a2f6d4dfd9b8333b3">itpp::gf2dense_eye</a> (int m)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">GF(2) Identity matrix. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="375df4bc73ef802e3face6661d088963"></a><!-- doxytag: member="gf2mat.h::mult_trans" ref="375df4bc73ef802e3face6661d088963" args="(const GF2mat &amp;X, const GF2mat &amp;Y)" -->
117GF2mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#375df4bc73ef802e3face6661d088963">itpp::mult_trans</a> (const GF2mat &amp;X, const GF2mat &amp;Y)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplication X*Y' where X and Y are GF(2) matrices. <br></td></tr>
120</table>
121<hr><a name="_details"></a><h2>Detailed Description</h2>
122Definition of a class for algebra on GF(2) (binary) matrices.
123<p>
124<dl class="author" compact><dt><b>Author:</b></dt><dd>Erik G. Larsson and Adam Piatyszek</dd></dl>
125-------------------------------------------------------------------------<p>
126Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
127This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
128IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
129IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
130You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
131-------------------------------------------------------------------------<p>
132Two representations are offered: GF2mat_sparse for sparse GF(2) matrices and GF2mat for dense GF(2) matrices. Conversions between dense and sparse GF(2) are also possible.<p>
133Binary vectors are represented either via the bvec class (memory typically is not an issue here) or as n*1 (or 1*n) GF(2) matrix.<p>
134Note that the <code>bmat</code> class also provides some functionality for matrix algebra over GF(2) but this class is based on <code>Mat&lt;&gt;</code> which has a fundamentally different addressing mechanism and which is much less memory efficient (<code>Mat&lt;&gt;</code> uses one byte memory minimum per element). </div>
135<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
136<a href="http://www.doxygen.org/index.html">
137<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
138</body>
139</html>
Note: See TracBrowser for help on using the browser.