root/doc/html/classsqmat.html @ 22

Revision 22, 10.7 kB (checked in by smidl, 17 years ago)

upravy Kalmana

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