root/doc/html/classsqmat.html @ 280

Revision 280, 16.7 kB (checked in by smidl, 16 years ago)

progress...

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