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

Revision 621, 17.2 kB (checked in by smidl, 15 years ago)

doc - new pattern for from_setting for pdfs

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>
[616]76<hr/><a name="_details"></a><h2>Detailed Description</h2>
77<p>Abstract class for representation of double symmetric matrices in square-root form. </p>
78<p>All operations defined on this class should be optimized for the chosen decomposition. </p>
[538]79
[591]80<p><code>#include &lt;<a class="el" href="square__mat_8h_source.html">square_mat.h</a>&gt;</code></p>
[538]81
[591]82<p><a href="classbdm_1_1sqmat-members.html">List of all members.</a></p>
83<table border="0" cellpadding="0" cellspacing="0">
84<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
[621]85<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#a12298b1cc5a6f35876291e876b0e2993">opupdt</a> (const vec &amp;v, double w)</td></tr>
86<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68888112cf70681c1c7a0231a631dc76"></a><!-- doxytag: member="bdm::sqmat::to_mat" ref="a68888112cf70681c1c7a0231a631dc76" args="() const " -->
87virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a68888112cf70681c1c7a0231a631dc76">to_mat</a> () const </td></tr>
[591]88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br/></td></tr>
[621]89<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#af8b513b6ac0e54d6fe47afda8b254b29">mult_sym</a> (const mat &amp;C)</td></tr>
90<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="#af8b513b6ac0e54d6fe47afda8b254b29"></a><br/></td></tr>
91<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#aba45b96855264178ab67648bbc7cead5">mult_sym_t</a> (const mat &amp;C)</td></tr>
92<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="#aba45b96855264178ab67648bbc7cead5"></a><br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae770665dd7362ffd0f2043642f9958d3"></a><!-- doxytag: member="bdm::sqmat::logdet" ref="ae770665dd7362ffd0f2043642f9958d3" args="() const " -->
94virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#ae770665dd7362ffd0f2043642f9958d3">logdet</a> () const </td></tr>
[591]95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br/></td></tr>
[621]96<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#abcacd85ec5d128ebbb663ae4433c75b3">sqrt_mult</a> (const vec &amp;v) const </td></tr>
97<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="#abcacd85ec5d128ebbb663ae4433c75b3"></a><br/></td></tr>
98<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fad0f3844a0bbbf5b5b68c43fea0d12"></a><!-- doxytag: member="bdm::sqmat::qform" ref="a0fad0f3844a0bbbf5b5b68c43fea0d12" args="(const vec &amp;v) const " -->
99virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a0fad0f3844a0bbbf5b5b68c43fea0d12">qform</a> (const vec &amp;v) const </td></tr>
[608]100<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>
[621]101<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a022d2e2c128f3024b6f8c4bcf28dcfdd"></a><!-- doxytag: member="bdm::sqmat::invqform" ref="a022d2e2c128f3024b6f8c4bcf28dcfdd" args="(const vec &amp;v) const " -->
102virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a022d2e2c128f3024b6f8c4bcf28dcfdd">invqform</a> (const vec &amp;v) const </td></tr>
[608]103<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>
[621]104<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d2ab703ff24a6ece1c10b8e24015e72"></a><!-- doxytag: member="bdm::sqmat::clear" ref="a9d2ab703ff24a6ece1c10b8e24015e72" args="()" -->
105virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a9d2ab703ff24a6ece1c10b8e24015e72">clear</a> ()</td></tr>
[591]106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br/></td></tr>
107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a445ef762cf5d2d6cfdf53c72942363cf"></a><!-- doxytag: member="bdm::sqmat::cols" ref="a445ef762cf5d2d6cfdf53c72942363cf" args="() const " -->
108int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a445ef762cf5d2d6cfdf53c72942363cf">cols</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#a445ef762cf5d2d6cfdf53c72942363cf" title="Reimplementing common functions of mat: cols().">cols()</a>. <br/></td></tr>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73e639221343dcce76c3305524d67590"></a><!-- doxytag: member="bdm::sqmat::rows" ref="a73e639221343dcce76c3305524d67590" args="() const " -->
111int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a73e639221343dcce76c3305524d67590">rows</a> () const </td></tr>
112<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>
113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33a9a1ec2f66b6c1e3081e5e65c36d0e"></a><!-- doxytag: member="bdm::sqmat::~sqmat" ref="a33a9a1ec2f66b6c1e3081e5e65c36d0e" args="()" -->
114virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a33a9a1ec2f66b6c1e3081e5e65c36d0e">~sqmat</a> ()</td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br/></td></tr>
116<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)" -->
117&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a3d304dccc155638c6d435cd1c0611dfc">sqmat</a> (const int dim0)</td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3051f1734d36cce6c58c799fdd4451bb"></a><!-- doxytag: member="bdm::sqmat::sqmat" ref="a3051f1734d36cce6c58c799fdd4451bb" args="()" -->
120&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a3051f1734d36cce6c58c799fdd4451bb">sqmat</a> ()</td></tr>
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
122<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05111b5744a494880e62cb0f3d42293f"></a><!-- doxytag: member="bdm::sqmat::dim" ref="a05111b5744a494880e62cb0f3d42293f" args="" -->
124int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a05111b5744a494880e62cb0f3d42293f">dim</a></td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br/></td></tr>
[538]126</table>
[591]127<hr/><h2>Member Function Documentation</h2>
[621]128<a class="anchor" id="af8b513b6ac0e54d6fe47afda8b254b29"></a><!-- doxytag: member="bdm::sqmat::mult_sym" ref="af8b513b6ac0e54d6fe47afda8b254b29" args="(const mat &amp;C)" -->
[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>
[621]138          <td><code> [inline, virtual]</code></td>
[538]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
[621]152<p>Reimplemented 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
[621]154<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
155
[538]156</div>
[591]157</div>
[621]158<a class="anchor" id="aba45b96855264178ab67648bbc7cead5"></a><!-- doxytag: member="bdm::sqmat::mult_sym_t" ref="aba45b96855264178ab67648bbc7cead5" args="(const mat &amp;C)" -->
[538]159<div class="memitem">
160<div class="memproto">
161      <table class="memname">
162        <tr>
[591]163          <td class="memname">virtual void bdm::sqmat::mult_sym_t </td>
[538]164          <td>(</td>
165          <td class="paramtype">const mat &amp;&nbsp;</td>
[591]166          <td class="paramname"> <em>C</em></td>
[538]167          <td>&nbsp;)&nbsp;</td>
[621]168          <td><code> [inline, virtual]</code></td>
[538]169        </tr>
170      </table>
171</div>
172<div class="memdoc">
173
[608]174<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]175<dl><dt><b>Parameters:</b></dt><dd>
[538]176  <table border="0" cellspacing="2" cellpadding="0">
177    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
178  </table>
[591]179  </dd>
[538]180</dl>
181
[621]182<p>Reimplemented 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]183
[621]184<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
185
[538]186</div>
[591]187</div>
[621]188<a class="anchor" id="a12298b1cc5a6f35876291e876b0e2993"></a><!-- doxytag: member="bdm::sqmat::opupdt" ref="a12298b1cc5a6f35876291e876b0e2993" args="(const vec &amp;v, double w)" -->
[538]189<div class="memitem">
190<div class="memproto">
191      <table class="memname">
192        <tr>
[591]193          <td class="memname">virtual void bdm::sqmat::opupdt </td>
[538]194          <td>(</td>
195          <td class="paramtype">const vec &amp;&nbsp;</td>
196          <td class="paramname"> <em>v</em>, </td>
197        </tr>
198        <tr>
199          <td class="paramkey"></td>
200          <td></td>
201          <td class="paramtype">double&nbsp;</td>
202          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
203        </tr>
204        <tr>
205          <td></td>
206          <td>)</td>
[621]207          <td></td><td></td><td><code> [inline, virtual]</code></td>
[538]208        </tr>
209      </table>
210</div>
211<div class="memdoc">
[608]212<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]213<dl><dt><b>Parameters:</b></dt><dd>
[538]214  <table border="0" cellspacing="2" cellpadding="0">
215    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
216    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
217  </table>
[591]218  </dd>
[538]219</dl>
[591]220<p>BLAS-2b operation. </p>
[538]221
[621]222<p>Reimplemented 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>
[591]223
[621]224<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
225
[538]226</div>
[591]227</div>
[621]228<a class="anchor" id="abcacd85ec5d128ebbb663ae4433c75b3"></a><!-- doxytag: member="bdm::sqmat::sqrt_mult" ref="abcacd85ec5d128ebbb663ae4433c75b3" args="(const vec &amp;v) const " -->
[538]229<div class="memitem">
230<div class="memproto">
231      <table class="memname">
232        <tr>
[591]233          <td class="memname">virtual vec bdm::sqmat::sqrt_mult </td>
[538]234          <td>(</td>
235          <td class="paramtype">const vec &amp;&nbsp;</td>
[591]236          <td class="paramname"> <em>v</em></td>
[538]237          <td>&nbsp;)&nbsp;</td>
[621]238          <td> const<code> [inline, virtual]</code></td>
[538]239        </tr>
240      </table>
241</div>
242<div class="memdoc">
243
[608]244<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]245<p>Used e.g. in generating normal samples. </p>
[538]246
[621]247<p>Reimplemented 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>
[591]248
[621]249<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
250
[538]251</div>
252</div>
[591]253<hr/>The documentation for this class was generated from the following file:<ul>
254<li><a class="el" href="square__mat_8h_source.html">square_mat.h</a></li>
255</ul>
256</div>
[621]257<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 16 22:33:34 2009 for mixpp by&nbsp;
[538]258<a href="http://www.doxygen.org/index.html">
[591]259<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[538]260</body>
261</html>
Note: See TracBrowser for help on using the browser.