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

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

doc

RevLine 
[591]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
[538]5<title>mixpp: bdm::sqmat Class Reference</title>
[591]6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.1 -->
[538]11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1sqmat.html">sqmat</a>
70  </div>
71</div>
72<div class="contents">
[591]73<h1>bdm::sqmat Class Reference</h1><!-- doxytag: class="bdm::sqmat" -->
74<p>Abstract class for representation of double symmetric matrices in square-root form. 
75<a href="#_details">More...</a></p>
[538]76
[591]77<p><code>#include &lt;<a class="el" href="square__mat_8h_source.html">square_mat.h</a>&gt;</code></p>
[538]78
[591]79<p><a href="classbdm_1_1sqmat-members.html">List of all members.</a></p>
80<table border="0" cellpadding="0" cellspacing="0">
81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#acb3b3eef10b0c1f41ead717d3ad40ec5">opupdt</a> (const vec &amp;v, double w)=0</td></tr>
83<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee9c751c4b506c29dc65c2b61487e1ad"></a><!-- doxytag: member="bdm::sqmat::to_mat" ref="aee9c751c4b506c29dc65c2b61487e1ad" args="() const =0" -->
84virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#aee9c751c4b506c29dc65c2b61487e1ad">to_mat</a> () const =0</td></tr>
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br/></td></tr>
86<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a742581db1f8ce9602ec1c3e6373e499c">mult_sym</a> (const mat &amp;C)=0</td></tr>
[608]87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_60.png"/>, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_61.png"/>.  <a href="#a742581db1f8ce9602ec1c3e6373e499c"></a><br/></td></tr>
[591]88<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a2db6f35ac14e6d1d905b4100e4c13743">mult_sym_t</a> (const mat &amp;C)=0</td></tr>
[608]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_60.png"/>, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_62.png"/>.  <a href="#a2db6f35ac14e6d1d905b4100e4c13743"></a><br/></td></tr>
[591]90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a121b108a818c0388a46866ad34ae9242"></a><!-- doxytag: member="bdm::sqmat::logdet" ref="a121b108a818c0388a46866ad34ae9242" args="() const =0" -->
91virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a121b108a818c0388a46866ad34ae9242">logdet</a> () const =0</td></tr>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a608bfff59854833f1acfccdbd346832a">sqrt_mult</a> (const vec &amp;v) const =0</td></tr>
[608]94<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_63.png"/> by vector <img class="formulaInl" alt="$x$" src="form_1.png"/>.  <a href="#a608bfff59854833f1acfccdbd346832a"></a><br/></td></tr>
[591]95<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2b7450ba7cf9068ab332f8abdf065f7"></a><!-- doxytag: member="bdm::sqmat::qform" ref="ac2b7450ba7cf9068ab332f8abdf065f7" args="(const vec &amp;v) const =0" -->
96virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#ac2b7450ba7cf9068ab332f8abdf065f7">qform</a> (const vec &amp;v) const =0</td></tr>
[608]97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*V*v$" src="form_64.png"/>;. <br/></td></tr>
[591]98<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e5e62419aa9ab15556dd49e5a9ad6ed"></a><!-- doxytag: member="bdm::sqmat::invqform" ref="a5e5e62419aa9ab15556dd49e5a9ad6ed" args="(const vec &amp;v) const =0" -->
99virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a5e5e62419aa9ab15556dd49e5a9ad6ed">invqform</a> (const vec &amp;v) const =0</td></tr>
[608]100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*inv(V)*v$" src="form_65.png"/>;. <br/></td></tr>
[591]101<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab24649cb221296e633d658c8aba2c9d8"></a><!-- doxytag: member="bdm::sqmat::clear" ref="ab24649cb221296e633d658c8aba2c9d8" args="()=0" -->
102virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#ab24649cb221296e633d658c8aba2c9d8">clear</a> ()=0</td></tr>
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br/></td></tr>
104<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a445ef762cf5d2d6cfdf53c72942363cf"></a><!-- doxytag: member="bdm::sqmat::cols" ref="a445ef762cf5d2d6cfdf53c72942363cf" args="() const " -->
105int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a445ef762cf5d2d6cfdf53c72942363cf">cols</a> () const </td></tr>
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classbdm_1_1sqmat.html#a445ef762cf5d2d6cfdf53c72942363cf" title="Reimplementing common functions of mat: cols().">cols()</a>. <br/></td></tr>
107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73e639221343dcce76c3305524d67590"></a><!-- doxytag: member="bdm::sqmat::rows" ref="a73e639221343dcce76c3305524d67590" args="() const " -->
108int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a73e639221343dcce76c3305524d67590">rows</a> () const </td></tr>
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classbdm_1_1sqmat.html#a73e639221343dcce76c3305524d67590" title="Reimplementing common functions of mat: rows().">rows()</a>. <br/></td></tr>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33a9a1ec2f66b6c1e3081e5e65c36d0e"></a><!-- doxytag: member="bdm::sqmat::~sqmat" ref="a33a9a1ec2f66b6c1e3081e5e65c36d0e" args="()" -->
111virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a33a9a1ec2f66b6c1e3081e5e65c36d0e">~sqmat</a> ()</td></tr>
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br/></td></tr>
113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d304dccc155638c6d435cd1c0611dfc"></a><!-- doxytag: member="bdm::sqmat::sqmat" ref="a3d304dccc155638c6d435cd1c0611dfc" args="(const int dim0)" -->
114&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a3d304dccc155638c6d435cd1c0611dfc">sqmat</a> (const int dim0)</td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3051f1734d36cce6c58c799fdd4451bb"></a><!-- doxytag: member="bdm::sqmat::sqmat" ref="a3051f1734d36cce6c58c799fdd4451bb" args="()" -->
117&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a3051f1734d36cce6c58c799fdd4451bb">sqmat</a> ()</td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
119<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05111b5744a494880e62cb0f3d42293f"></a><!-- doxytag: member="bdm::sqmat::dim" ref="a05111b5744a494880e62cb0f3d42293f" args="" -->
121int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a05111b5744a494880e62cb0f3d42293f">dim</a></td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br/></td></tr>
[538]123</table>
[591]124<hr/><a name="_details"></a><h2>Detailed Description</h2>
125<p>Abstract class for representation of double symmetric matrices in square-root form. </p>
126<p>All operations defined on this class should be optimized for the chosen decomposition. </p>
127<hr/><h2>Member Function Documentation</h2>
128<a class="anchor" id="a742581db1f8ce9602ec1c3e6373e499c"></a><!-- doxytag: member="bdm::sqmat::mult_sym" ref="a742581db1f8ce9602ec1c3e6373e499c" args="(const mat &amp;C)=0" -->
[538]129<div class="memitem">
130<div class="memproto">
131      <table class="memname">
132        <tr>
[591]133          <td class="memname">virtual void bdm::sqmat::mult_sym </td>
[538]134          <td>(</td>
135          <td class="paramtype">const mat &amp;&nbsp;</td>
[591]136          <td class="paramname"> <em>C</em></td>
[538]137          <td>&nbsp;)&nbsp;</td>
138          <td><code> [pure virtual]</code></td>
139        </tr>
140      </table>
141</div>
142<div class="memdoc">
143
[608]144<p>Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_60.png"/>, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_61.png"/>. </p>
[591]145<dl><dt><b>Parameters:</b></dt><dd>
[538]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  </table>
[591]149  </dd>
[538]150</dl>
151
[591]152<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#a832d1a18bbf33ee7681adf01d5d08e21">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#afca713af3f74677fd7fbafe723590112">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#a7a813158c36347deccf50a08feee24a8">bdm::ldmat</a>.</p>
[538]153
154</div>
[591]155</div>
156<a class="anchor" id="a2db6f35ac14e6d1d905b4100e4c13743"></a><!-- doxytag: member="bdm::sqmat::mult_sym_t" ref="a2db6f35ac14e6d1d905b4100e4c13743" args="(const mat &amp;C)=0" -->
[538]157<div class="memitem">
158<div class="memproto">
159      <table class="memname">
160        <tr>
[591]161          <td class="memname">virtual void bdm::sqmat::mult_sym_t </td>
[538]162          <td>(</td>
163          <td class="paramtype">const mat &amp;&nbsp;</td>
[591]164          <td class="paramname"> <em>C</em></td>
[538]165          <td>&nbsp;)&nbsp;</td>
166          <td><code> [pure virtual]</code></td>
167        </tr>
168      </table>
169</div>
170<div class="memdoc">
171
[608]172<p>Inplace symmetric multiplication by a SQUARE transpose of matrix <img class="formulaInl" alt="$C$" src="form_60.png"/>, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_62.png"/>. </p>
[591]173<dl><dt><b>Parameters:</b></dt><dd>
[538]174  <table border="0" cellspacing="2" cellpadding="0">
175    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
176  </table>
[591]177  </dd>
[538]178</dl>
179
[591]180<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#a7a4f54f1ea8b802f318de77a78f6ddb0">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#a0f6b7cf09daf484f29ea99a144a27039">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#a591ae54f5fce50e7160025eeab44888f">bdm::ldmat</a>.</p>
[538]181
182</div>
[591]183</div>
184<a class="anchor" id="acb3b3eef10b0c1f41ead717d3ad40ec5"></a><!-- doxytag: member="bdm::sqmat::opupdt" ref="acb3b3eef10b0c1f41ead717d3ad40ec5" args="(const vec &amp;v, double w)=0" -->
[538]185<div class="memitem">
186<div class="memproto">
187      <table class="memname">
188        <tr>
[591]189          <td class="memname">virtual void bdm::sqmat::opupdt </td>
[538]190          <td>(</td>
191          <td class="paramtype">const vec &amp;&nbsp;</td>
192          <td class="paramname"> <em>v</em>, </td>
193        </tr>
194        <tr>
195          <td class="paramkey"></td>
196          <td></td>
197          <td class="paramtype">double&nbsp;</td>
198          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
199        </tr>
200        <tr>
201          <td></td>
202          <td>)</td>
203          <td></td><td></td><td><code> [pure virtual]</code></td>
204        </tr>
205      </table>
206</div>
207<div class="memdoc">
[608]208<p>Perfroms a rank-1 update by outer product of vectors: <img class="formulaInl" alt="$V = V + w v v'$" src="form_59.png"/>. </p>
[591]209<dl><dt><b>Parameters:</b></dt><dd>
[538]210  <table border="0" cellspacing="2" cellpadding="0">
211    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
212    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
213  </table>
[591]214  </dd>
[538]215</dl>
[591]216<p>BLAS-2b operation. </p>
[538]217
[591]218<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#abea30d9ae395363e5aef36f6359b15fd">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#aa41b3686a77d1f9657b6942b01cfd8be">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#ac9dc3f1f86d36ec7eedb8746eb2c3b5c">bdm::ldmat</a>.</p>
219
[538]220</div>
[591]221</div>
222<a class="anchor" id="a608bfff59854833f1acfccdbd346832a"></a><!-- doxytag: member="bdm::sqmat::sqrt_mult" ref="a608bfff59854833f1acfccdbd346832a" args="(const vec &amp;v) const =0" -->
[538]223<div class="memitem">
224<div class="memproto">
225      <table class="memname">
226        <tr>
[591]227          <td class="memname">virtual vec bdm::sqmat::sqrt_mult </td>
[538]228          <td>(</td>
229          <td class="paramtype">const vec &amp;&nbsp;</td>
[591]230          <td class="paramname"> <em>v</em></td>
[538]231          <td>&nbsp;)&nbsp;</td>
232          <td> const<code> [pure virtual]</code></td>
233        </tr>
234      </table>
235</div>
236<div class="memdoc">
237
[608]238<p>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_63.png"/> by vector <img class="formulaInl" alt="$x$" src="form_1.png"/>. </p>
[591]239<p>Used e.g. in generating normal samples. </p>
[538]240
[591]241<p>Implemented in <a class="el" href="classbdm_1_1chmat.html#aec8d3a1cbf3b50183f246a858663c92d">bdm::chmat</a>, <a class="el" href="classbdm_1_1fsqmat.html#aab240f84ea1685bc95df0446f948abfd">bdm::fsqmat</a>, and <a class="el" href="classbdm_1_1ldmat.html#a2c670269c0ee397eb49ba7b0712e16a5">bdm::ldmat</a>.</p>
242
[538]243</div>
244</div>
[591]245<hr/>The documentation for this class was generated from the following file:<ul>
246<li><a class="el" href="square__mat_8h_source.html">square_mat.h</a></li>
247</ul>
248</div>
[614]249<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:43 2009 for mixpp by&nbsp;
[538]250<a href="http://www.doxygen.org/index.html">
[591]251<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[538]252</body>
253</html>
Note: See TracBrowser for help on using the browser.