root/doc/html/classsqmat.html @ 224

Revision 224, 15.4 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: 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.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>sqmat Class Reference<br>
28<small>
29[<a class="el" href="group__math.html">Auxiliary math functions</a>]</small>
30</h1><!-- doxytag: class="sqmat" -->Virtual class for representation of double symmetric matrices in square-root form. 
31<a href="#_details">More...</a>
32<p>
33<code>#include &lt;<a class="el" href="libDC_8h-source.html">libDC.h</a>&gt;</code>
34<p>
35<div class="dynheader">
36Inheritance diagram for sqmat:</div>
37<div class="dynsection">
38<p><center><img src="classsqmat__inherit__graph.png" border="0" usemap="#sqmat__inherit__map" alt="Inheritance graph"></center>
39<map name="sqmat__inherit__map">
40<area shape="rect" href="classchmat.html" title="Symmetric matrix stored in square root decomposition using upper cholesky." alt="" coords="5,84,67,111"><area shape="rect" href="classfsqmat.html" title="Fake sqmat. This class maps sqmat operations to operations on full matrix." alt="" coords="91,84,157,111"><area shape="rect" href="classldmat.html" title="Matrix stored in LD form, (commonly known as UD)." alt="" coords="181,84,240,111"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42
43<p>
44<a href="classsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
45<tr><td></td></tr>
46<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
47<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>
48
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd0ea3701e4493f353499755fba6e07f"></a><!-- doxytag: member="sqmat::to_mat" ref="cd0ea3701e4493f353499755fba6e07f" args="() const =0" -->
50virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#cd0ea3701e4493f353499755fba6e07f">to_mat</a> () const =0</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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#60fbbfa9e483b8187c135f787ee53afa">mult_sym</a> (const mat &amp;C)=0</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_24.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_25.png">.  <a href="#60fbbfa9e483b8187c135f787ee53afa"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6909e906da17725b1b80f3cae7cf3325">mult_sym_t</a> (const mat &amp;C)=0</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE transpose of matrix <img class="formulaInl" alt="$C$" src="form_24.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_26.png">.  <a href="#6909e906da17725b1b80f3cae7cf3325"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a772b396750eeeed85d69fa72478b45"></a><!-- doxytag: member="sqmat::logdet" ref="0a772b396750eeeed85d69fa72478b45" args="() const =0" -->
60virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0a772b396750eeeed85d69fa72478b45">logdet</a> () const =0</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6b79438b5d7544a9c8e110a145355d8f">sqrt_mult</a> (const vec &amp;v) const =0</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square root of <img class="formulaInl" alt="$V$" src="form_27.png"> by vector <img class="formulaInl" alt="$x$" src="form_28.png">.  <a href="#6b79438b5d7544a9c8e110a145355d8f"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc026312eb02ba09f85d5aacd6f05ab3"></a><!-- doxytag: member="sqmat::qform" ref="fc026312eb02ba09f85d5aacd6f05ab3" args="(const vec &amp;v) const =0" -->
67virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#fc026312eb02ba09f85d5aacd6f05ab3">qform</a> (const vec &amp;v) const =0</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*V*v$" src="form_29.png">;. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6230e8e8a9341866aaa0ce008691aac2"></a><!-- doxytag: member="sqmat::invqform" ref="6230e8e8a9341866aaa0ce008691aac2" args="(const vec &amp;v) const =0" -->
71virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6230e8e8a9341866aaa0ce008691aac2">invqform</a> (const vec &amp;v) const =0</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*inv(V)*v$" src="form_30.png">;. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fca246f9eabbdeb8cac03030e826b5e"></a><!-- doxytag: member="sqmat::clear" ref="6fca246f9eabbdeb8cac03030e826b5e" args="()=0" -->
75virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6fca246f9eabbdeb8cac03030e826b5e">clear</a> ()=0</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecc2e2540f95a04f4449842588170f5b"></a><!-- doxytag: member="sqmat::cols" ref="ecc2e2540f95a04f4449842588170f5b" args="() const " -->
79int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b">cols</a> () const </td></tr>
80
81<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>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071e80ced9cc3b8cbb360fa7462eb646"></a><!-- doxytag: member="sqmat::rows" ref="071e80ced9cc3b8cbb360fa7462eb646" args="() const " -->
83int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646">rows</a> () const </td></tr>
84
85<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>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0481f2067bb32aaea7e6d4f27e46b656"></a><!-- doxytag: member="sqmat::~sqmat" ref="0481f2067bb32aaea7e6d4f27e46b656" args="()" -->
87virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0481f2067bb32aaea7e6d4f27e46b656">~sqmat</a> ()</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4268750c040c716b2c05037f725078a2"></a><!-- doxytag: member="sqmat::sqmat" ref="4268750c040c716b2c05037f725078a2" args="(const int dim0)" -->
91&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#4268750c040c716b2c05037f725078a2">sqmat</a> (const int dim0)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
94<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0abed904bdc0882373ba9adba919689d"></a><!-- doxytag: member="sqmat::dim" ref="0abed904bdc0882373ba9adba919689d" args="" -->
96int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0abed904bdc0882373ba9adba919689d">dim</a></td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br></td></tr>
99</table>
100<hr><a name="_details"></a><h2>Detailed Description</h2>
101Virtual class for representation of double symmetric matrices in square-root form.
102<p>
103All operations defined on this class should be optimized for the chosen decomposition. <hr><h2>Member Function Documentation</h2>
104<a class="anchor" name="b223484796661f2dadb5607a86ce0581"></a><!-- doxytag: member="sqmat::opupdt" ref="b223484796661f2dadb5607a86ce0581" args="(const vec &amp;v, double w)=0" -->
105<div class="memitem">
106<div class="memproto">
107      <table class="memname">
108        <tr>
109          <td class="memname">virtual void sqmat::opupdt           </td>
110          <td>(</td>
111          <td class="paramtype">const vec &amp;&nbsp;</td>
112          <td class="paramname"> <em>v</em>, </td>
113        </tr>
114        <tr>
115          <td class="paramkey"></td>
116          <td></td>
117          <td class="paramtype">double&nbsp;</td>
118          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
119        </tr>
120        <tr>
121          <td></td>
122          <td>)</td>
123          <td></td><td></td><td><code> [pure virtual]</code></td>
124        </tr>
125      </table>
126</div>
127<div class="memdoc">
128
129<p>
130Perfroms a rank-1 update by outer product of vectors: <img class="formulaInl" alt="$V = V + w v v'$" src="form_23.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
131  <table border="0" cellspacing="2" cellpadding="0">
132    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
133    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
134  </table>
135</dl>
136BLAS-2b operation.
137<p>Implemented in <a class="el" href="classchmat.html#bbc2d98d7455b1f38828907d442836bf">chmat</a>, <a class="el" href="classfsqmat.html#b36530e155667fe9f1bd58394e50c65a">fsqmat</a>, and <a class="el" href="classldmat.html#0f0f6e083e6d947cf58097ffce3ccd1a">ldmat</a>.</p>
138
139</div>
140</div><p>
141<a class="anchor" name="60fbbfa9e483b8187c135f787ee53afa"></a><!-- doxytag: member="sqmat::mult_sym" ref="60fbbfa9e483b8187c135f787ee53afa" args="(const mat &amp;C)=0" -->
142<div class="memitem">
143<div class="memproto">
144      <table class="memname">
145        <tr>
146          <td class="memname">virtual void sqmat::mult_sym           </td>
147          <td>(</td>
148          <td class="paramtype">const mat &amp;&nbsp;</td>
149          <td class="paramname"> <em>C</em>          </td>
150          <td>&nbsp;)&nbsp;</td>
151          <td><code> [pure virtual]</code></td>
152        </tr>
153      </table>
154</div>
155<div class="memdoc">
156
157<p>
158Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_24.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_25.png">.
159<p>
160<dl compact><dt><b>Parameters:</b></dt><dd>
161  <table border="0" cellspacing="2" cellpadding="0">
162    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
163  </table>
164</dl>
165
166<p>Implemented in <a class="el" href="classchmat.html#66f509f92b0ccf020e2a2a32566e0777">chmat</a>, <a class="el" href="classfsqmat.html#5530d2756b5d991de755e6121c9a452e">fsqmat</a>, and <a class="el" href="classldmat.html#e967b9425007f0cb6cd59b845f9756d8">ldmat</a>.</p>
167
168</div>
169</div><p>
170<a class="anchor" name="6909e906da17725b1b80f3cae7cf3325"></a><!-- doxytag: member="sqmat::mult_sym_t" ref="6909e906da17725b1b80f3cae7cf3325" args="(const mat &amp;C)=0" -->
171<div class="memitem">
172<div class="memproto">
173      <table class="memname">
174        <tr>
175          <td class="memname">virtual void sqmat::mult_sym_t           </td>
176          <td>(</td>
177          <td class="paramtype">const mat &amp;&nbsp;</td>
178          <td class="paramname"> <em>C</em>          </td>
179          <td>&nbsp;)&nbsp;</td>
180          <td><code> [pure virtual]</code></td>
181        </tr>
182      </table>
183</div>
184<div class="memdoc">
185
186<p>
187Inplace symmetric multiplication by a SQUARE transpose of matrix <img class="formulaInl" alt="$C$" src="form_24.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_26.png">.
188<p>
189<dl compact><dt><b>Parameters:</b></dt><dd>
190  <table border="0" cellspacing="2" cellpadding="0">
191    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
192  </table>
193</dl>
194
195<p>Implemented in <a class="el" href="classchmat.html#07f50d1332b901eee962e8b1913102f7">chmat</a>, <a class="el" href="classfsqmat.html#92052a8adc2054b63e42d1373d145c89">fsqmat</a>, and <a class="el" href="classldmat.html#4fd155f38eb6dd5af4bdf9c98a7999a9">ldmat</a>.</p>
196
197</div>
198</div><p>
199<a class="anchor" name="6b79438b5d7544a9c8e110a145355d8f"></a><!-- doxytag: member="sqmat::sqrt_mult" ref="6b79438b5d7544a9c8e110a145355d8f" args="(const vec &amp;v) const =0" -->
200<div class="memitem">
201<div class="memproto">
202      <table class="memname">
203        <tr>
204          <td class="memname">virtual vec sqmat::sqrt_mult           </td>
205          <td>(</td>
206          <td class="paramtype">const vec &amp;&nbsp;</td>
207          <td class="paramname"> <em>v</em>          </td>
208          <td>&nbsp;)&nbsp;</td>
209          <td> const<code> [pure virtual]</code></td>
210        </tr>
211      </table>
212</div>
213<div class="memdoc">
214
215<p>
216Multiplies square root of <img class="formulaInl" alt="$V$" src="form_27.png"> by vector <img class="formulaInl" alt="$x$" src="form_28.png">.
217<p>
218Used e.g. in generating normal samples.
219<p>Implemented in <a class="el" href="classchmat.html#b22aa239dbaca33e3fb93b4f674d7051">chmat</a>, <a class="el" href="classfsqmat.html#842a774077ee34ac3c36d180ab33e103">fsqmat</a>, and <a class="el" href="classldmat.html#fc380626ced6f9244fb58c5f0231174d">ldmat</a>.</p>
220
221</div>
222</div><p>
223<hr>The documentation for this class was generated from the following file:<ul>
224<li>work/git/mixpp/bdm/math/<a class="el" href="libDC_8h-source.html">libDC.h</a></ul>
225</div>
226<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:29: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.6 </small></address>
229</body>
230</html>
Note: See TracBrowser for help on using the browser.