root/library/doc/html/classsqmat.html @ 477

Revision 472, 16.3 kB (checked in by mido, 15 years ago)

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

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="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.9 -->
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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66</div>
67<div class="contents">
68<h1>sqmat Class Reference</h1><!-- doxytag: class="sqmat" -->Abstract class for representation of double symmetric matrices in square-root form. 
69<a href="#_details">More...</a>
70<p>
71<code>#include &lt;<a class="el" href="square__mat_8h_source.html">square_mat.h</a>&gt;</code>
72<p>
73
74<p>
75<a href="classsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
76<tr><td></td></tr>
77<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
78<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>
79
80<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" -->
81virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#cd0ea3701e4493f353499755fba6e07f">to_mat</a> () const =0</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br></td></tr>
84<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>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_53.png">.  <a href="#60fbbfa9e483b8187c135f787ee53afa"></a><br></td></tr>
87<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>
88
89<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_52.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_54.png">.  <a href="#6909e906da17725b1b80f3cae7cf3325"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a772b396750eeeed85d69fa72478b45"></a><!-- doxytag: member="sqmat::logdet" ref="0a772b396750eeeed85d69fa72478b45" args="() const =0" -->
91virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0a772b396750eeeed85d69fa72478b45">logdet</a> () const =0</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
94<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>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square root of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.  <a href="#6b79438b5d7544a9c8e110a145355d8f"></a><br></td></tr>
97<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" -->
98virtual 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>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*V*v$" src="form_56.png">;. <br></td></tr>
101<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" -->
102virtual 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>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*inv(V)*v$" src="form_57.png">;. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fca246f9eabbdeb8cac03030e826b5e"></a><!-- doxytag: member="sqmat::clear" ref="6fca246f9eabbdeb8cac03030e826b5e" args="()=0" -->
106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#6fca246f9eabbdeb8cac03030e826b5e">clear</a> ()=0</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecc2e2540f95a04f4449842588170f5b"></a><!-- doxytag: member="sqmat::cols" ref="ecc2e2540f95a04f4449842588170f5b" args="() const " -->
110int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b">cols</a> () const </td></tr>
111
112<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>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071e80ced9cc3b8cbb360fa7462eb646"></a><!-- doxytag: member="sqmat::rows" ref="071e80ced9cc3b8cbb360fa7462eb646" args="() const " -->
114int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646">rows</a> () const </td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646" title="Reimplementing common functions of mat: rows().">rows()</a>. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0481f2067bb32aaea7e6d4f27e46b656"></a><!-- doxytag: member="sqmat::~sqmat" ref="0481f2067bb32aaea7e6d4f27e46b656" args="()" -->
118virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0481f2067bb32aaea7e6d4f27e46b656">~sqmat</a> ()</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
121<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)" -->
122&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#4268750c040c716b2c05037f725078a2">sqmat</a> (const int dim0)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5493a4a11a2b3c41de9cdd8ce305bb44"></a><!-- doxytag: member="sqmat::sqmat" ref="5493a4a11a2b3c41de9cdd8ce305bb44" args="()" -->
126&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#5493a4a11a2b3c41de9cdd8ce305bb44">sqmat</a> ()</td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
129<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0abed904bdc0882373ba9adba919689d"></a><!-- doxytag: member="sqmat::dim" ref="0abed904bdc0882373ba9adba919689d" args="" -->
131int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0abed904bdc0882373ba9adba919689d">dim</a></td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br></td></tr>
134</table>
135<hr><a name="_details"></a><h2>Detailed Description</h2>
136Abstract class for representation of double symmetric matrices in square-root form.
137<p>
138All operations defined on this class should be optimized for the chosen decomposition. <hr><h2>Member Function Documentation</h2>
139<a class="anchor" name="60fbbfa9e483b8187c135f787ee53afa"></a><!-- doxytag: member="sqmat::mult_sym" ref="60fbbfa9e483b8187c135f787ee53afa" args="(const mat &amp;C)=0" -->
140<div class="memitem">
141<div class="memproto">
142      <table class="memname">
143        <tr>
144          <td class="memname">virtual void sqmat::mult_sym           </td>
145          <td>(</td>
146          <td class="paramtype">const mat &amp;&nbsp;</td>
147          <td class="paramname"> <em>C</em>          </td>
148          <td>&nbsp;)&nbsp;</td>
149          <td><code> [pure virtual]</code></td>
150        </tr>
151      </table>
152</div>
153<div class="memdoc">
154
155<p>
156Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_53.png">.
157<p>
158<dl compact><dt><b>Parameters:</b></dt><dd>
159  <table border="0" cellspacing="2" cellpadding="0">
160    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
161  </table>
162</dl>
163
164<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>
165
166</div>
167</div><p>
168<a class="anchor" name="6909e906da17725b1b80f3cae7cf3325"></a><!-- doxytag: member="sqmat::mult_sym_t" ref="6909e906da17725b1b80f3cae7cf3325" args="(const mat &amp;C)=0" -->
169<div class="memitem">
170<div class="memproto">
171      <table class="memname">
172        <tr>
173          <td class="memname">virtual void sqmat::mult_sym_t           </td>
174          <td>(</td>
175          <td class="paramtype">const mat &amp;&nbsp;</td>
176          <td class="paramname"> <em>C</em>          </td>
177          <td>&nbsp;)&nbsp;</td>
178          <td><code> [pure virtual]</code></td>
179        </tr>
180      </table>
181</div>
182<div class="memdoc">
183
184<p>
185Inplace symmetric multiplication by a SQUARE transpose of matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_54.png">.
186<p>
187<dl compact><dt><b>Parameters:</b></dt><dd>
188  <table border="0" cellspacing="2" cellpadding="0">
189    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
190  </table>
191</dl>
192
193<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>
194
195</div>
196</div><p>
197<a class="anchor" name="b223484796661f2dadb5607a86ce0581"></a><!-- doxytag: member="sqmat::opupdt" ref="b223484796661f2dadb5607a86ce0581" args="(const vec &amp;v, double w)=0" -->
198<div class="memitem">
199<div class="memproto">
200      <table class="memname">
201        <tr>
202          <td class="memname">virtual void sqmat::opupdt           </td>
203          <td>(</td>
204          <td class="paramtype">const vec &amp;&nbsp;</td>
205          <td class="paramname"> <em>v</em>, </td>
206        </tr>
207        <tr>
208          <td class="paramkey"></td>
209          <td></td>
210          <td class="paramtype">double&nbsp;</td>
211          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
212        </tr>
213        <tr>
214          <td></td>
215          <td>)</td>
216          <td></td><td></td><td><code> [pure virtual]</code></td>
217        </tr>
218      </table>
219</div>
220<div class="memdoc">
221
222<p>
223Perfroms a rank-1 update by outer product of vectors: <img class="formulaInl" alt="$V = V + w v v'$" src="form_51.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
224  <table border="0" cellspacing="2" cellpadding="0">
225    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
226    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
227  </table>
228</dl>
229BLAS-2b operation.
230<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>
231
232</div>
233</div><p>
234<a class="anchor" name="6b79438b5d7544a9c8e110a145355d8f"></a><!-- doxytag: member="sqmat::sqrt_mult" ref="6b79438b5d7544a9c8e110a145355d8f" args="(const vec &amp;v) const =0" -->
235<div class="memitem">
236<div class="memproto">
237      <table class="memname">
238        <tr>
239          <td class="memname">virtual vec sqmat::sqrt_mult           </td>
240          <td>(</td>
241          <td class="paramtype">const vec &amp;&nbsp;</td>
242          <td class="paramname"> <em>v</em>          </td>
243          <td>&nbsp;)&nbsp;</td>
244          <td> const<code> [pure virtual]</code></td>
245        </tr>
246      </table>
247</div>
248<div class="memdoc">
249
250<p>
251Multiplies square root of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.
252<p>
253Used e.g. in generating normal samples.
254<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>
255
256</div>
257</div><p>
258<hr>The documentation for this class was generated from the following file:<ul>
259<li><a class="el" href="square__mat_8h_source.html">square_mat.h</a></ul>
260</div>
261<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:54 2009 for mixpp by&nbsp;
262<a href="http://www.doxygen.org/index.html">
263<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
264</body>
265</html>
Note: See TracBrowser for help on using the browser.