root/doc/html/classsqmat.html @ 30

Revision 28, 10.8 kB (checked in by smidl, 16 years ago)

prelozitelna verze

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: sqmat 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>
13    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
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>sqmat Class Reference</h1><!-- doxytag: class="sqmat" -->Virtual class for representation of double symmetric matrices in square-root form. 
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 sqmat:</div>
30<div class="dynsection">
31<p><center><img src="classsqmat__inherit__graph.png" border="0" usemap="#sqmat__inherit__map" alt="Inheritance graph"></center>
32<map name="sqmat__inherit__map">
33<area shape="rect" href="classfsqmat.html" title="Fake sqmat. This class maps sqmat operations to operations on full matrix." alt="" coords="5,84,72,111"></map>
34<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
35
36<p>
37<a href="classsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
38<tr><td></td></tr>
39<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#b223484796661f2dadb5607a86ce0581">opupdt</a> (const vec &amp;v, double w)=0</td></tr>
41
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a5b6fddfeb42339e1dc9b978a2590fc"></a><!-- doxytag: member="sqmat::to_mat" ref="9a5b6fddfeb42339e1dc9b978a2590fc" args="()=0" -->
43virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#9a5b6fddfeb42339e1dc9b978a2590fc">to_mat</a> ()=0</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#faa3bc90be142adde9cf74f573c70157">mult_sym</a> (const mat &amp;C, bool trans=true)=0</td></tr>
47
48<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="#faa3bc90be142adde9cf74f573c70157"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c852819589f74cdaefbd648c0ce8547"></a><!-- doxytag: member="sqmat::logdet" ref="5c852819589f74cdaefbd648c0ce8547" args="()=0" -->
50virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#5c852819589f74cdaefbd648c0ce8547">logdet</a> ()=0</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#b5236c8a050199e1a9d338b0da1a08d2">sqrt_mult</a> (vec &amp;v)=0</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square root of $V$ by vector $x$.  <a href="#b5236c8a050199e1a9d338b0da1a08d2"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44e079468bc8bfccf634dc85b32ba6be"></a><!-- doxytag: member="sqmat::qform" ref="44e079468bc8bfccf634dc85b32ba6be" args="(vec &amp;v)=0" -->
57virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#44e079468bc8bfccf634dc85b32ba6be">qform</a> (vec &amp;v)=0</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form $x= v'*V*v$;. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fca246f9eabbdeb8cac03030e826b5e"></a><!-- doxytag: member="sqmat::clear" ref="6fca246f9eabbdeb8cac03030e826b5e" args="()=0" -->
61virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6fca246f9eabbdeb8cac03030e826b5e">clear</a> ()=0</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecc2e2540f95a04f4449842588170f5b"></a><!-- doxytag: member="sqmat::cols" ref="ecc2e2540f95a04f4449842588170f5b" args="() const " -->
65int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b">cols</a> () const </td></tr>
66
67<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>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071e80ced9cc3b8cbb360fa7462eb646"></a><!-- doxytag: member="sqmat::rows" ref="071e80ced9cc3b8cbb360fa7462eb646" args="() const " -->
69int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646">rows</a> () const </td></tr>
70
71<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>
72<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0abed904bdc0882373ba9adba919689d"></a><!-- doxytag: member="sqmat::dim" ref="0abed904bdc0882373ba9adba919689d" args="" -->
74int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dim</b></td></tr>
75
76</table>
77<hr><a name="_details"></a><h2>Detailed Description</h2>
78Virtual class for representation of double symmetric matrices in square-root form.
79<p>
80All operations defined on this class should be optimized for the chosed decomposition. <hr><h2>Member Function Documentation</h2>
81<a class="anchor" name="b223484796661f2dadb5607a86ce0581"></a><!-- doxytag: member="sqmat::opupdt" ref="b223484796661f2dadb5607a86ce0581" args="(const vec &amp;v, double w)=0" -->
82<div class="memitem">
83<div class="memproto">
84      <table class="memname">
85        <tr>
86          <td class="memname">virtual void sqmat::opupdt           </td>
87          <td>(</td>
88          <td class="paramtype">const vec &amp;&nbsp;</td>
89          <td class="paramname"> <em>v</em>, </td>
90        </tr>
91        <tr>
92          <td class="paramkey"></td>
93          <td></td>
94          <td class="paramtype">double&nbsp;</td>
95          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
96        </tr>
97        <tr>
98          <td></td>
99          <td>)</td>
100          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
101        </tr>
102      </table>
103</div>
104<div class="memdoc">
105
106<p>
107Perfroms a rank-1 update by outer product of vectors: $V = V + w v v'$. <dl compact><dt><b>Parameters:</b></dt><dd>
108  <table border="0" cellspacing="2" cellpadding="0">
109    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
110    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
111  </table>
112</dl>
113BLAS-2b operation.
114<p>Implemented in <a class="el" href="classfsqmat.html#b36530e155667fe9f1bd58394e50c65a">fsqmat</a>.</p>
115
116</div>
117</div><p>
118<a class="anchor" name="faa3bc90be142adde9cf74f573c70157"></a><!-- doxytag: member="sqmat::mult_sym" ref="faa3bc90be142adde9cf74f573c70157" args="(const mat &amp;C, bool trans=true)=0" -->
119<div class="memitem">
120<div class="memproto">
121      <table class="memname">
122        <tr>
123          <td class="memname">virtual void sqmat::mult_sym           </td>
124          <td>(</td>
125          <td class="paramtype">const mat &amp;&nbsp;</td>
126          <td class="paramname"> <em>C</em>, </td>
127        </tr>
128        <tr>
129          <td class="paramkey"></td>
130          <td></td>
131          <td class="paramtype">bool&nbsp;</td>
132          <td class="paramname"> <em>trans</em> = <code>true</code></td><td>&nbsp;</td>
133        </tr>
134        <tr>
135          <td></td>
136          <td>)</td>
137          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
138        </tr>
139      </table>
140</div>
141<div class="memdoc">
142
143<p>
144Inplace symmetric multiplication by a SQUARE matrix $C$, i.e. $V = C*V*C'$.
145<p>
146<dl compact><dt><b>Parameters:</b></dt><dd>
147  <table border="0" cellspacing="2" cellpadding="0">
148    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
149    <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>
150  </table>
151</dl>
152
153<p>Implemented in <a class="el" href="classfsqmat.html#acc5d2d0a243f1de6d0106065f01f518">fsqmat</a>.</p>
154
155</div>
156</div><p>
157<a class="anchor" name="b5236c8a050199e1a9d338b0da1a08d2"></a><!-- doxytag: member="sqmat::sqrt_mult" ref="b5236c8a050199e1a9d338b0da1a08d2" args="(vec &amp;v)=0" -->
158<div class="memitem">
159<div class="memproto">
160      <table class="memname">
161        <tr>
162          <td class="memname">virtual vec sqmat::sqrt_mult           </td>
163          <td>(</td>
164          <td class="paramtype">vec &amp;&nbsp;</td>
165          <td class="paramname"> <em>v</em>          </td>
166          <td>&nbsp;)&nbsp;</td>
167          <td width="100%"><code> [pure virtual]</code></td>
168        </tr>
169      </table>
170</div>
171<div class="memdoc">
172
173<p>
174Multiplies square root of $V$ by vector $x$.
175<p>
176Used e.g. in generating normal samples.
177<p>Implemented in <a class="el" href="classfsqmat.html#6648dd4291b809cce14e8497d0433ad3">fsqmat</a>.</p>
178
179</div>
180</div><p>
181<hr>The documentation for this class was generated from the following file:<ul>
182<li>work/mixpp/bdm/math/<a class="el" href="libDC_8h-source.html">libDC.h</a></ul>
183<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 18 21:48:45 2008 for mixpp by&nbsp;
184<a href="http://www.doxygen.org/index.html">
185<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
186</body>
187</html>
Note: See TracBrowser for help on using the browser.