root/doc/html/classfsqmat.html @ 28

Revision 28, 15.6 kB (checked in by smidl, 17 years ago)

prelozitelna verze

RevLine 
[8]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: fsqmat Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.3 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
12    <li><a href="files.html"><span>Files</span></a></li>
[28]13    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[8]14  </ul>
15</div>
16<div class="tabs">
17  <ul>
18    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
19    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21  </ul>
22</div>
23<h1>fsqmat Class Reference</h1><!-- doxytag: class="fsqmat" --><!-- doxytag: inherits="sqmat" -->Fake <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a>. This class maps <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a> operations to operations on full matrix. 
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;<a class="el" href="libDC_8h-source.html">libDC.h</a>&gt;</code>
27<p>
28<div class="dynheader">
29Inheritance diagram for fsqmat:</div>
30<div class="dynsection">
[19]31<p><center><img src="classfsqmat__inherit__graph.png" border="0" usemap="#fsqmat__inherit__map" alt="Inheritance graph"></center>
32<map name="fsqmat__inherit__map">
33<area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="8,7,69,33"></map>
34<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
35<div class="dynheader">
36Collaboration diagram for fsqmat:</div>
37<div class="dynsection">
38<p><center><img src="classfsqmat__coll__graph.png" border="0" usemap="#fsqmat__coll__map" alt="Collaboration graph"></center>
39<map name="fsqmat__coll__map">
40<area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="8,7,69,33"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
[8]42
43<p>
44<a href="classfsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
45<tr><td></td></tr>
[22]46<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#b36530e155667fe9f1bd58394e50c65a">opupdt</a> (const vec &amp;v, double w)</td></tr>
48
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cedf4f048309056f4262c930914dfda8"></a><!-- doxytag: member="fsqmat::to_mat" ref="cedf4f048309056f4262c930914dfda8" args="()" -->
50mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#cedf4f048309056f4262c930914dfda8">to_mat</a> ()</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#acc5d2d0a243f1de6d0106065f01f518">mult_sym</a> (const mat &amp;C, bool trans=false)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$.  <a href="#acc5d2d0a243f1de6d0106065f01f518"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ccf5ad8fb038f82e9d2201c0606b65fa"></a><!-- doxytag: member="fsqmat::mult_sym" ref="ccf5ad8fb038f82e9d2201c0606b65fa" args="(const mat &amp;C, fsqmat &amp;U, bool trans=false)" -->
57void&nbsp;</td><td class="memItemRight" valign="bottom"><b>mult_sym</b> (const mat &amp;C, <a class="el" href="classfsqmat.html">fsqmat</a> &amp;U, bool trans=false)</td></tr>
58
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfa4c359483d2322f32d1d50050f8ac4"></a><!-- doxytag: member="fsqmat::clear" ref="cfa4c359483d2322f32d1d50050f8ac4" args="()" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#cfa4c359483d2322f32d1d50050f8ac4">clear</a> ()</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1929fbc9fe375f1d67f979d0d302336f"></a><!-- doxytag: member="fsqmat::fsqmat" ref="1929fbc9fe375f1d67f979d0d302336f" args="(const mat &amp;M)" -->
64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#1929fbc9fe375f1d67f979d0d302336f">fsqmat</a> (const mat &amp;M)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
[28]67<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#9fa853e1ca28f2a1a1c43377e798ecb1">inv</a> (<a class="el" href="classfsqmat.html">fsqmat</a> &amp;Inv)</td></tr>
[22]68
[28]69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix inversion preserving the chosen form.  <a href="#9fa853e1ca28f2a1a1c43377e798ecb1"></a><br></td></tr>
[22]70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf212272ec195ad2706e2bf4d8e7c9b3"></a><!-- doxytag: member="fsqmat::logdet" ref="bf212272ec195ad2706e2bf4d8e7c9b3" args="()" -->
71double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#bf212272ec195ad2706e2bf4d8e7c9b3">logdet</a> ()</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d047b9f7a27dfc093303a13cc9b1fba"></a><!-- doxytag: member="fsqmat::qform" ref="6d047b9f7a27dfc093303a13cc9b1fba" args="(vec &amp;v)" -->
75double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#6d047b9f7a27dfc093303a13cc9b1fba">qform</a> (vec &amp;v)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form $x= v'*V*v$;. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#6648dd4291b809cce14e8497d0433ad3">sqrt_mult</a> (vec &amp;v)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square root of $V$ by vector $x$.  <a href="#6648dd4291b809cce14e8497d0433ad3"></a><br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="514d1fdd8a382dbd6a774f2cf1ebd3de"></a><!-- doxytag: member="fsqmat::operator+=" ref="514d1fdd8a382dbd6a774f2cf1ebd3de" args="(const fsqmat &amp;A)" -->
82<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator+=</b> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;A)</td></tr>
83
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e976bc9d899961e1d2087b0630ed33b7"></a><!-- doxytag: member="fsqmat::operator-=" ref="e976bc9d899961e1d2087b0630ed33b7" args="(const fsqmat &amp;A)" -->
85<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator-=</b> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;A)</td></tr>
86
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f7ce97628a50e06641281096b2af9b7"></a><!-- doxytag: member="fsqmat::operator *=" ref="8f7ce97628a50e06641281096b2af9b7" args="(double x)" -->
88<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator *=</b> (double x)</td></tr>
89
[28]90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecc2e2540f95a04f4449842588170f5b"></a><!-- doxytag: member="fsqmat::cols" ref="ecc2e2540f95a04f4449842588170f5b" args="() const " -->
91int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b">cols</a> () const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071e80ced9cc3b8cbb360fa7462eb646"></a><!-- doxytag: member="fsqmat::rows" ref="071e80ced9cc3b8cbb360fa7462eb646" args="() const " -->
95int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646">rows</a> () const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr>
[22]98<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7a1fcb9aae19d1e4daddfc9c22ce453"></a><!-- doxytag: member="fsqmat::M" ref="a7a1fcb9aae19d1e4daddfc9c22ce453" args="" -->
100mat&nbsp;</td><td class="memItemRight" valign="bottom"><b>M</b></td></tr>
101
[28]102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0abed904bdc0882373ba9adba919689d"></a><!-- doxytag: member="fsqmat::dim" ref="0abed904bdc0882373ba9adba919689d" args="" -->
103int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dim</b></td></tr>
104
[8]105</table>
106<hr><a name="_details"></a><h2>Detailed Description</h2>
107Fake <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a>. This class maps <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a> operations to operations on full matrix.
108<p>
[22]109This class can be used to compare performance of algorithms using decomposed matrices with perormance of the same algorithms using full matrices; <hr><h2>Member Function Documentation</h2>
110<a class="anchor" name="b36530e155667fe9f1bd58394e50c65a"></a><!-- doxytag: member="fsqmat::opupdt" ref="b36530e155667fe9f1bd58394e50c65a" args="(const vec &amp;v, double w)" -->
111<div class="memitem">
112<div class="memproto">
113      <table class="memname">
114        <tr>
115          <td class="memname">void fsqmat::opupdt           </td>
116          <td>(</td>
117          <td class="paramtype">const vec &amp;&nbsp;</td>
118          <td class="paramname"> <em>v</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">double&nbsp;</td>
124          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
125        </tr>
126        <tr>
127          <td></td>
128          <td>)</td>
129          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
130        </tr>
131      </table>
132</div>
133<div class="memdoc">
134
135<p>
136Perfroms a rank-1 update by outer product of vectors: $V = V + w v v'$. <dl compact><dt><b>Parameters:</b></dt><dd>
137  <table border="0" cellspacing="2" cellpadding="0">
138    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
139    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
140  </table>
141</dl>
142BLAS-2b operation.
143<p>Implements <a class="el" href="classsqmat.html#b223484796661f2dadb5607a86ce0581">sqmat</a>.</p>
144
145</div>
146</div><p>
147<a class="anchor" name="acc5d2d0a243f1de6d0106065f01f518"></a><!-- doxytag: member="fsqmat::mult_sym" ref="acc5d2d0a243f1de6d0106065f01f518" args="(const mat &amp;C, bool trans=false)" -->
148<div class="memitem">
149<div class="memproto">
150      <table class="memname">
151        <tr>
152          <td class="memname">void fsqmat::mult_sym           </td>
153          <td>(</td>
154          <td class="paramtype">const mat &amp;&nbsp;</td>
155          <td class="paramname"> <em>C</em>, </td>
156        </tr>
157        <tr>
158          <td class="paramkey"></td>
159          <td></td>
160          <td class="paramtype">bool&nbsp;</td>
161          <td class="paramname"> <em>trans</em> = <code>false</code></td><td>&nbsp;</td>
162        </tr>
163        <tr>
164          <td></td>
165          <td>)</td>
166          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
167        </tr>
168      </table>
169</div>
170<div class="memdoc">
171
172<p>
173Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$.
174<p>
175<dl compact><dt><b>Parameters:</b></dt><dd>
176  <table border="0" cellspacing="2" cellpadding="0">
177    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
178    <tr><td valign="top"></td><td valign="top"><em>trans</em>&nbsp;</td><td>if true, product $V = C'*V*C$ will be computed instead; </td></tr>
179  </table>
180</dl>
181
182<p>Implements <a class="el" href="classsqmat.html#faa3bc90be142adde9cf74f573c70157">sqmat</a>.</p>
183
184</div>
185</div><p>
[28]186<a class="anchor" name="9fa853e1ca28f2a1a1c43377e798ecb1"></a><!-- doxytag: member="fsqmat::inv" ref="9fa853e1ca28f2a1a1c43377e798ecb1" args="(fsqmat &amp;Inv)" -->
[22]187<div class="memitem">
188<div class="memproto">
189      <table class="memname">
190        <tr>
[28]191          <td class="memname">void fsqmat::inv           </td>
[22]192          <td>(</td>
[28]193          <td class="paramtype"><a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td>
[22]194          <td class="paramname"> <em>Inv</em>          </td>
195          <td>&nbsp;)&nbsp;</td>
196          <td width="100%"><code> [virtual]</code></td>
197        </tr>
198      </table>
199</div>
200<div class="memdoc">
201
202<p>
203Matrix inversion preserving the chosen form.
204<p>
205<dl compact><dt><b>Parameters:</b></dt><dd>
206  <table border="0" cellspacing="2" cellpadding="0">
207    <tr><td valign="top"></td><td valign="top"><em>Inv</em>&nbsp;</td><td>a space where the inverse is stored. </td></tr>
208  </table>
209</dl>
210
211</div>
212</div><p>
213<a class="anchor" name="6648dd4291b809cce14e8497d0433ad3"></a><!-- doxytag: member="fsqmat::sqrt_mult" ref="6648dd4291b809cce14e8497d0433ad3" args="(vec &amp;v)" -->
214<div class="memitem">
215<div class="memproto">
216      <table class="memname">
217        <tr>
218          <td class="memname">vec fsqmat::sqrt_mult           </td>
219          <td>(</td>
220          <td class="paramtype">vec &amp;&nbsp;</td>
221          <td class="paramname"> <em>v</em>          </td>
222          <td>&nbsp;)&nbsp;</td>
223          <td width="100%"><code> [inline, virtual]</code></td>
224        </tr>
225      </table>
226</div>
227<div class="memdoc">
228
229<p>
230Multiplies square root of $V$ by vector $x$.
231<p>
232Used e.g. in generating normal samples.
233<p>Implements <a class="el" href="classsqmat.html#b5236c8a050199e1a9d338b0da1a08d2">sqmat</a>.</p>
234
235</div>
236</div><p>
[28]237<hr>The documentation for this class was generated from the following files:<ul>
238<li>work/mixpp/bdm/math/<a class="el" href="libDC_8h-source.html">libDC.h</a><li>work/mixpp/bdm/math/libDC.cpp<li>work/mixpp/bdm/math/libDC_.cpp</ul>
239<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 18 21:48:44 2008 for mixpp by&nbsp;
[8]240<a href="http://www.doxygen.org/index.html">
241<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
242</body>
243</html>
Note: See TracBrowser for help on using the browser.