root/library/doc/html/classbdm_1_1sqmat.html @ 541

Revision 538, 16.9 kB (checked in by smidl, 15 years ago)

Documentation regenerated

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: bdm::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.8 -->
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 class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1sqmat.html">sqmat</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::sqmat Class Reference</h1><!-- doxytag: class="bdm::sqmat" -->Abstract class for representation of double symmetric matrices in square-root form. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="square__mat_8h-source.html">square_mat.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1sqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#cb3b3eef10b0c1f41ead717d3ad40ec5">opupdt</a> (const vec &amp;v, double w)=0</td></tr>
81
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee9c751c4b506c29dc65c2b61487e1ad"></a><!-- doxytag: member="bdm::sqmat::to_mat" ref="ee9c751c4b506c29dc65c2b61487e1ad" args="() const =0" -->
83virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#ee9c751c4b506c29dc65c2b61487e1ad">to_mat</a> () const =0</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#742581db1f8ce9602ec1c3e6373e499c">mult_sym</a> (const mat &amp;C)=0</td></tr>
87
88<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="#742581db1f8ce9602ec1c3e6373e499c"></a><br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#2db6f35ac14e6d1d905b4100e4c13743">mult_sym_t</a> (const mat &amp;C)=0</td></tr>
90
91<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="#2db6f35ac14e6d1d905b4100e4c13743"></a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="121b108a818c0388a46866ad34ae9242"></a><!-- doxytag: member="bdm::sqmat::logdet" ref="121b108a818c0388a46866ad34ae9242" args="() const =0" -->
93virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#121b108a818c0388a46866ad34ae9242">logdet</a> () const =0</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#608bfff59854833f1acfccdbd346832a">sqrt_mult</a> (const vec &amp;v) const =0</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.  <a href="#608bfff59854833f1acfccdbd346832a"></a><br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c2b7450ba7cf9068ab332f8abdf065f7"></a><!-- doxytag: member="bdm::sqmat::qform" ref="c2b7450ba7cf9068ab332f8abdf065f7" args="(const vec &amp;v) const =0" -->
100virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#c2b7450ba7cf9068ab332f8abdf065f7">qform</a> (const vec &amp;v) const =0</td></tr>
101
102<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>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e5e62419aa9ab15556dd49e5a9ad6ed"></a><!-- doxytag: member="bdm::sqmat::invqform" ref="5e5e62419aa9ab15556dd49e5a9ad6ed" args="(const vec &amp;v) const =0" -->
104virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#5e5e62419aa9ab15556dd49e5a9ad6ed">invqform</a> (const vec &amp;v) const =0</td></tr>
105
106<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>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b24649cb221296e633d658c8aba2c9d8"></a><!-- doxytag: member="bdm::sqmat::clear" ref="b24649cb221296e633d658c8aba2c9d8" args="()=0" -->
108virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#b24649cb221296e633d658c8aba2c9d8">clear</a> ()=0</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="445ef762cf5d2d6cfdf53c72942363cf"></a><!-- doxytag: member="bdm::sqmat::cols" ref="445ef762cf5d2d6cfdf53c72942363cf" args="() const " -->
112int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#445ef762cf5d2d6cfdf53c72942363cf">cols</a> () const </td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classbdm_1_1sqmat.html#445ef762cf5d2d6cfdf53c72942363cf" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73e639221343dcce76c3305524d67590"></a><!-- doxytag: member="bdm::sqmat::rows" ref="73e639221343dcce76c3305524d67590" args="() const " -->
116int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#73e639221343dcce76c3305524d67590">rows</a> () const </td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classbdm_1_1sqmat.html#73e639221343dcce76c3305524d67590" title="Reimplementing common functions of mat: rows().">rows()</a>. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33a9a1ec2f66b6c1e3081e5e65c36d0e"></a><!-- doxytag: member="bdm::sqmat::~sqmat" ref="33a9a1ec2f66b6c1e3081e5e65c36d0e" args="()" -->
120virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#33a9a1ec2f66b6c1e3081e5e65c36d0e">~sqmat</a> ()</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d304dccc155638c6d435cd1c0611dfc"></a><!-- doxytag: member="bdm::sqmat::sqmat" ref="3d304dccc155638c6d435cd1c0611dfc" args="(const int dim0)" -->
124&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#3d304dccc155638c6d435cd1c0611dfc">sqmat</a> (const int dim0)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3051f1734d36cce6c58c799fdd4451bb"></a><!-- doxytag: member="bdm::sqmat::sqmat" ref="3051f1734d36cce6c58c799fdd4451bb" args="()" -->
128&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#3051f1734d36cce6c58c799fdd4451bb">sqmat</a> ()</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
131<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05111b5744a494880e62cb0f3d42293f"></a><!-- doxytag: member="bdm::sqmat::dim" ref="05111b5744a494880e62cb0f3d42293f" args="" -->
133int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#05111b5744a494880e62cb0f3d42293f">dim</a></td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br></td></tr>
136</table>
137<hr><a name="_details"></a><h2>Detailed Description</h2>
138Abstract class for representation of double symmetric matrices in square-root form.
139<p>
140All operations defined on this class should be optimized for the chosen decomposition. <hr><h2>Member Function Documentation</h2>
141<a class="anchor" name="742581db1f8ce9602ec1c3e6373e499c"></a><!-- doxytag: member="bdm::sqmat::mult_sym" ref="742581db1f8ce9602ec1c3e6373e499c" 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 bdm::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_52.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_53.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="classbdm_1_1chmat.html#832d1a18bbf33ee7681adf01d5d08e21">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#fca713af3f74677fd7fbafe723590112">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#7a813158c36347deccf50a08feee24a8">bdm::ldmat</a>.</p>
167
168</div>
169</div><p>
170<a class="anchor" name="2db6f35ac14e6d1d905b4100e4c13743"></a><!-- doxytag: member="bdm::sqmat::mult_sym_t" ref="2db6f35ac14e6d1d905b4100e4c13743" 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 bdm::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_52.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_54.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="classbdm_1_1chmat.html#7a4f54f1ea8b802f318de77a78f6ddb0">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#0f6b7cf09daf484f29ea99a144a27039">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#591ae54f5fce50e7160025eeab44888f">bdm::ldmat</a>.</p>
196
197</div>
198</div><p>
199<a class="anchor" name="cb3b3eef10b0c1f41ead717d3ad40ec5"></a><!-- doxytag: member="bdm::sqmat::opupdt" ref="cb3b3eef10b0c1f41ead717d3ad40ec5" args="(const vec &amp;v, double w)=0" -->
200<div class="memitem">
201<div class="memproto">
202      <table class="memname">
203        <tr>
204          <td class="memname">virtual void bdm::sqmat::opupdt           </td>
205          <td>(</td>
206          <td class="paramtype">const vec &amp;&nbsp;</td>
207          <td class="paramname"> <em>v</em>, </td>
208        </tr>
209        <tr>
210          <td class="paramkey"></td>
211          <td></td>
212          <td class="paramtype">double&nbsp;</td>
213          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
214        </tr>
215        <tr>
216          <td></td>
217          <td>)</td>
218          <td></td><td></td><td><code> [pure virtual]</code></td>
219        </tr>
220      </table>
221</div>
222<div class="memdoc">
223
224<p>
225Perfroms 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>
226  <table border="0" cellspacing="2" cellpadding="0">
227    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
228    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
229  </table>
230</dl>
231BLAS-2b operation.
232<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#bea30d9ae395363e5aef36f6359b15fd">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#a41b3686a77d1f9657b6942b01cfd8be">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#c9dc3f1f86d36ec7eedb8746eb2c3b5c">bdm::ldmat</a>.</p>
233
234</div>
235</div><p>
236<a class="anchor" name="608bfff59854833f1acfccdbd346832a"></a><!-- doxytag: member="bdm::sqmat::sqrt_mult" ref="608bfff59854833f1acfccdbd346832a" args="(const vec &amp;v) const =0" -->
237<div class="memitem">
238<div class="memproto">
239      <table class="memname">
240        <tr>
241          <td class="memname">virtual vec bdm::sqmat::sqrt_mult           </td>
242          <td>(</td>
243          <td class="paramtype">const vec &amp;&nbsp;</td>
244          <td class="paramname"> <em>v</em>          </td>
245          <td>&nbsp;)&nbsp;</td>
246          <td> const<code> [pure virtual]</code></td>
247        </tr>
248      </table>
249</div>
250<div class="memdoc">
251
252<p>
253Multiplies square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.
254<p>
255Used e.g. in generating normal samples.
256<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#ec8d3a1cbf3b50183f246a858663c92d">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#ab240f84ea1685bc95df0446f948abfd">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#2c670269c0ee397eb49ba7b0712e16a5">bdm::ldmat</a>.</p>
257
258</div>
259</div><p>
260<hr>The documentation for this class was generated from the following file:<ul>
261<li><a class="el" href="square__mat_8h-source.html">square_mat.h</a></ul>
262</div>
263<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp;
264<a href="http://www.doxygen.org/index.html">
265<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
266</body>
267</html>
Note: See TracBrowser for help on using the browser.