root/library/doc/html/classbdm_1_1chmat.html @ 651

Revision 651, 27.7 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

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::chmat 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 class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1chmat.html">chmat</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::chmat Class Reference</h1><!-- doxytag: class="bdm::chmat" --><!-- doxytag: inherits="bdm::sqmat" -->Symmetric matrix stored in square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> decomposition using upper cholesky. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="chmat_8h_source.html">chmat.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1chmat-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#bea30d9ae395363e5aef36f6359b15fd">opupdt</a> (const vec &amp;v, double w)</td></tr>
81
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b4c5d4dbb8a3d585b68d936cb6df31b"></a><!-- doxytag: member="bdm::chmat::to_mat" ref="4b4c5d4dbb8a3d585b68d936cb6df31b" args="() const " -->
83mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#4b4c5d4dbb8a3d585b68d936cb6df31b">to_mat</a> () const </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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#832d1a18bbf33ee7681adf01d5d08e21">mult_sym</a> (const mat &amp;C)</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_60.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_61.png">.  <a href="#832d1a18bbf33ee7681adf01d5d08e21"></a><br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0bf9168129004c4017d32fe1dc45816"></a><!-- doxytag: member="bdm::chmat::mult_sym" ref="c0bf9168129004c4017d32fe1dc45816" args="(const mat &amp;C, chmat &amp;U) const " -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><b>mult_sym</b> (const mat &amp;C, <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;U) const </td></tr>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#7a4f54f1ea8b802f318de77a78f6ddb0">mult_sym_t</a> (const mat &amp;C)</td></tr>
93
94<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="#7a4f54f1ea8b802f318de77a78f6ddb0"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78a18034a874d46b034f29a7e5d42f3b"></a><!-- doxytag: member="bdm::chmat::mult_sym_t" ref="78a18034a874d46b034f29a7e5d42f3b" args="(const mat &amp;C, chmat &amp;U) const " -->
96void&nbsp;</td><td class="memItemRight" valign="bottom"><b>mult_sym_t</b> (const mat &amp;C, <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;U) const </td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="949ccd174ed19f9cfe36366cbd5c56a4"></a><!-- doxytag: member="bdm::chmat::logdet" ref="949ccd174ed19f9cfe36366cbd5c56a4" args="() const " -->
99double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#949ccd174ed19f9cfe36366cbd5c56a4">logdet</a> () const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#ec8d3a1cbf3b50183f246a858663c92d">sqrt_mult</a> (const vec &amp;v) const </td></tr>
103
104<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="#ec8d3a1cbf3b50183f246a858663c92d"></a><br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e0aee9691909602d341fe5ebd1f1ca8"></a><!-- doxytag: member="bdm::chmat::qform" ref="6e0aee9691909602d341fe5ebd1f1ca8" args="(const vec &amp;v) const " -->
106double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#6e0aee9691909602d341fe5ebd1f1ca8">qform</a> (const vec &amp;v) const </td></tr>
107
108<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>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ac8d00a14a22a21760a8374fe5c5757"></a><!-- doxytag: member="bdm::chmat::invqform" ref="3ac8d00a14a22a21760a8374fe5c5757" args="(const vec &amp;v) const " -->
110double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#3ac8d00a14a22a21760a8374fe5c5757">invqform</a> (const vec &amp;v) const </td></tr>
111
112<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>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc753cb54aa8946ce41d95e82fc148b5"></a><!-- doxytag: member="bdm::chmat::clear" ref="bc753cb54aa8946ce41d95e82fc148b5" args="()" -->
114void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#bc753cb54aa8946ce41d95e82fc148b5">clear</a> ()</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b3d5b772f791fc7c5df544a418278c7"></a><!-- doxytag: member="bdm::chmat::add" ref="6b3d5b772f791fc7c5df544a418278c7" args="(const chmat &amp;A2, double w=1.0)" -->
118void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#6b3d5b772f791fc7c5df544a418278c7">add</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2, double w=1.0)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add another <a class="el" href="classbdm_1_1chmat.html" title="Symmetric matrix stored in square root decomposition using upper cholesky.">chmat</a> <code>A2</code> with weight <code>w</code>. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbf3389db96dff41fb2e9532d59b13c0"></a><!-- doxytag: member="bdm::chmat::inv" ref="cbf3389db96dff41fb2e9532d59b13c0" args="(chmat &amp;Inv) const " -->
122void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#cbf3389db96dff41fb2e9532d59b13c0">inv</a> (<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;Inv) const </td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inversion in the same form, i.e. cholesky. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a888e866a163bffe94b51e58af65901b"></a><!-- doxytag: member="bdm::chmat::~chmat" ref="a888e866a163bffe94b51e58af65901b" args="()" -->
126virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a888e866a163bffe94b51e58af65901b">~chmat</a> ()</td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="947c52c64022ef364d8ef17c94a65ef1"></a><!-- doxytag: member="bdm::chmat::chmat" ref="947c52c64022ef364d8ef17c94a65ef1" args="(const int dim0)" -->
130&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#947c52c64022ef364d8ef17c94a65ef1">chmat</a> (const int dim0)</td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae4dd65ff29d7d951b18903b100bd39d"></a><!-- doxytag: member="bdm::chmat::chmat" ref="ae4dd65ff29d7d951b18903b100bd39d" args="(const vec &amp;v)" -->
134&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#ae4dd65ff29d7d951b18903b100bd39d">chmat</a> (const vec &amp;v)</td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57513fca80f91194faf90297f2ab2b24"></a><!-- doxytag: member="bdm::chmat::chmat" ref="57513fca80f91194faf90297f2ab2b24" args="(const chmat &amp;Ch0)" -->
138&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#57513fca80f91194faf90297f2ab2b24">chmat</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;Ch0)</td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="796ee52e1343bc53d278f17c55bb1cc7"></a><!-- doxytag: member="bdm::chmat::chmat" ref="796ee52e1343bc53d278f17c55bb1cc7" args="(const mat &amp;M)" -->
142&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#796ee52e1343bc53d278f17c55bb1cc7">chmat</a> (const mat &amp;M)</td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (m3k:cholform). <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#3c4e675e7efd91f78faa3dcf23aec153">chmat</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;M, const ivec &amp;perm)</td></tr>
146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17daa8c5c5914bd3194cb3053c5793a5"></a><!-- doxytag: member="bdm::chmat::_Ch" ref="17daa8c5c5914bd3194cb3053c5793a5" args="()" -->
148mat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#17daa8c5c5914bd3194cb3053c5793a5">_Ch</a> ()</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e9e137c1a6f46d13c2b6790cfddaa92"></a><!-- doxytag: member="bdm::chmat::_Ch" ref="3e9e137c1a6f46d13c2b6790cfddaa92" args="() const " -->
152const mat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#3e9e137c1a6f46d13c2b6790cfddaa92">_Ch</a> () const </td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b192df5b54b173ba9bc6922ee9983bc9"></a><!-- doxytag: member="bdm::chmat::setD" ref="b192df5b54b173ba9bc6922ee9983bc9" args="(const vec &amp;nD)" -->
156void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#b192df5b54b173ba9bc6922ee9983bc9">setD</a> (const vec &amp;nD)</td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8fd18754b0e5e0463f818cd16c710c8"></a><!-- doxytag: member="bdm::chmat::setCh" ref="b8fd18754b0e5e0463f818cd16c710c8" args="(const vec &amp;chQ)" -->
160void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#b8fd18754b0e5e0463f818cd16c710c8">setCh</a> (const vec &amp;chQ)</td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18f4b97bde650086fe5e3d9461a13514"></a><!-- doxytag: member="bdm::chmat::setD" ref="18f4b97bde650086fe5e3d9461a13514" args="(const vec &amp;nD, int i)" -->
164void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#18f4b97bde650086fe5e3d9461a13514">setD</a> (const vec &amp;nD, int i)</td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#029a0997afc656fde0c73bbf7724aca9">operator+=</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2)</td></tr>
168
169<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Operators.  <a href="#029a0997afc656fde0c73bbf7724aca9"></a><br></td></tr>
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1d0180fb795d38b8c352df2686ec5ba"></a><!-- doxytag: member="bdm::chmat::operator&#45;=" ref="f1d0180fb795d38b8c352df2686ec5ba" args="(const chmat &amp;A2)" -->
171<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#f1d0180fb795d38b8c352df2686ec5ba">operator-=</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2)</td></tr>
172
173<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mapping of negative add operation to operators <br></td></tr>
174<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62ce85eb2461b51821c0d8507dfb9e95"></a><!-- doxytag: member="bdm::chmat::operator*" ref="62ce85eb2461b51821c0d8507dfb9e95" args="(const double &amp;d)" -->
175<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator*</b> (const double &amp;d)</td></tr>
176
177<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8727d34435b7aa241c47a7b2fc0bed16"></a><!-- doxytag: member="bdm::chmat::operator=" ref="8727d34435b7aa241c47a7b2fc0bed16" args="(const chmat &amp;A2)" -->
178<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2)</td></tr>
179
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b05aac3f788d953a78c96295a6ad3d3b"></a><!-- doxytag: member="bdm::chmat::operator*=" ref="b05aac3f788d953a78c96295a6ad3d3b" args="(double x)" -->
181<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator*=</b> (double x)</td></tr>
182
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="445ef762cf5d2d6cfdf53c72942363cf"></a><!-- doxytag: member="bdm::chmat::cols" ref="445ef762cf5d2d6cfdf53c72942363cf" args="() const " -->
184int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#445ef762cf5d2d6cfdf53c72942363cf">cols</a> () const </td></tr>
185
186<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>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73e639221343dcce76c3305524d67590"></a><!-- doxytag: member="bdm::chmat::rows" ref="73e639221343dcce76c3305524d67590" args="() const " -->
188int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#73e639221343dcce76c3305524d67590">rows</a> () const </td></tr>
189
190<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>
191<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
192<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e4f39b1895a0a870f8db98329635223"></a><!-- doxytag: member="bdm::chmat::Ch" ref="3e4f39b1895a0a870f8db98329635223" args="" -->
193mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#3e4f39b1895a0a870f8db98329635223">Ch</a></td></tr>
194
195<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Upper triangle of the cholesky matrix. <br></td></tr>
196<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05111b5744a494880e62cb0f3d42293f"></a><!-- doxytag: member="bdm::chmat::dim" ref="05111b5744a494880e62cb0f3d42293f" args="" -->
197int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#05111b5744a494880e62cb0f3d42293f">dim</a></td></tr>
198
199<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br></td></tr>
200</table>
201<hr><a name="_details"></a><h2>Detailed Description</h2>
202Symmetric matrix stored in square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> decomposition using upper cholesky.
203<p>
204This matrix represent <img class="formulaInl" alt="$A=Ch' Ch$" src="form_46.png"> where only the upper triangle <img class="formulaInl" alt="$Ch$" src="form_47.png"> is stored; <hr><h2>Constructor &amp; Destructor Documentation</h2>
205<a class="anchor" name="3c4e675e7efd91f78faa3dcf23aec153"></a><!-- doxytag: member="bdm::chmat::chmat" ref="3c4e675e7efd91f78faa3dcf23aec153" args="(const chmat &amp;M, const ivec &amp;perm)" -->
206<div class="memitem">
207<div class="memproto">
208      <table class="memname">
209        <tr>
210          <td class="memname">bdm::chmat::chmat           </td>
211          <td>(</td>
212          <td class="paramtype">const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td>
213          <td class="paramname"> <em>M</em>, </td>
214        </tr>
215        <tr>
216          <td class="paramkey"></td>
217          <td></td>
218          <td class="paramtype">const ivec &amp;&nbsp;</td>
219          <td class="paramname"> <em>perm</em></td><td>&nbsp;</td>
220        </tr>
221        <tr>
222          <td></td>
223          <td>)</td>
224          <td></td><td></td><td><code> [inline]</code></td>
225        </tr>
226      </table>
227</div>
228<div class="memdoc">
229
230<p>
231Some templates require this constructor to compile, but it shouldn't actually be called.
232<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
233
234</div>
235</div><p>
236<hr><h2>Member Function Documentation</h2>
237<a class="anchor" name="832d1a18bbf33ee7681adf01d5d08e21"></a><!-- doxytag: member="bdm::chmat::mult_sym" ref="832d1a18bbf33ee7681adf01d5d08e21" args="(const mat &amp;C)" -->
238<div class="memitem">
239<div class="memproto">
240      <table class="memname">
241        <tr>
242          <td class="memname">void bdm::chmat::mult_sym           </td>
243          <td>(</td>
244          <td class="paramtype">const mat &amp;&nbsp;</td>
245          <td class="paramname"> <em>C</em>          </td>
246          <td>&nbsp;)&nbsp;</td>
247          <td><code> [virtual]</code></td>
248        </tr>
249      </table>
250</div>
251<div class="memdoc">
252
253<p>
254Inplace 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">.
255<p>
256<dl compact><dt><b>Parameters:</b></dt><dd>
257  <table border="0" cellspacing="2" cellpadding="0">
258    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
259  </table>
260</dl>
261
262<p>Reimplemented from <a class="el" href="classbdm_1_1sqmat.html#f8b513b6ac0e54d6fe47afda8b254b29">bdm::sqmat</a>.</p>
263
264<p>References <a class="el" href="bdmerror_8h_source.html#l00047">bdm_assert_debug</a>, <a class="el" href="bdmerror_8h_source.html#l00059">bdm_warning</a>, <a class="el" href="chmat_8h_source.html#l00030">Ch</a>, and <a class="el" href="square__mat_8h_source.html#l00109">bdm::sqmat::dim</a>.</p>
265
266</div>
267</div><p>
268<a class="anchor" name="7a4f54f1ea8b802f318de77a78f6ddb0"></a><!-- doxytag: member="bdm::chmat::mult_sym_t" ref="7a4f54f1ea8b802f318de77a78f6ddb0" args="(const mat &amp;C)" -->
269<div class="memitem">
270<div class="memproto">
271      <table class="memname">
272        <tr>
273          <td class="memname">void bdm::chmat::mult_sym_t           </td>
274          <td>(</td>
275          <td class="paramtype">const mat &amp;&nbsp;</td>
276          <td class="paramname"> <em>C</em>          </td>
277          <td>&nbsp;)&nbsp;</td>
278          <td><code> [virtual]</code></td>
279        </tr>
280      </table>
281</div>
282<div class="memdoc">
283
284<p>
285Inplace 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">.
286<p>
287<dl compact><dt><b>Parameters:</b></dt><dd>
288  <table border="0" cellspacing="2" cellpadding="0">
289    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
290  </table>
291</dl>
292
293<p>Reimplemented from <a class="el" href="classbdm_1_1sqmat.html#ba45b96855264178ab67648bbc7cead5">bdm::sqmat</a>.</p>
294
295<p>References <a class="el" href="bdmerror_8h_source.html#l00047">bdm_assert_debug</a>, <a class="el" href="bdmerror_8h_source.html#l00059">bdm_warning</a>, <a class="el" href="chmat_8h_source.html#l00030">Ch</a>, and <a class="el" href="square__mat_8h_source.html#l00109">bdm::sqmat::dim</a>.</p>
296
297</div>
298</div><p>
299<a class="anchor" name="029a0997afc656fde0c73bbf7724aca9"></a><!-- doxytag: member="bdm::chmat::operator+=" ref="029a0997afc656fde0c73bbf7724aca9" args="(const chmat &amp;A2)" -->
300<div class="memitem">
301<div class="memproto">
302      <table class="memname">
303        <tr>
304          <td class="memname"><a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp; bdm::chmat::operator+=           </td>
305          <td>(</td>
306          <td class="paramtype">const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td>
307          <td class="paramname"> <em>A2</em>          </td>
308          <td>&nbsp;)&nbsp;</td>
309          <td><code> [inline]</code></td>
310        </tr>
311      </table>
312</div>
313<div class="memdoc">
314
315<p>
316Operators.
317<p>
318Operations: mapping of add operation to operators
319<p>References <a class="el" href="chmat_8h_source.html#l00045">add()</a>.</p>
320
321</div>
322</div><p>
323<a class="anchor" name="bea30d9ae395363e5aef36f6359b15fd"></a><!-- doxytag: member="bdm::chmat::opupdt" ref="bea30d9ae395363e5aef36f6359b15fd" args="(const vec &amp;v, double w)" -->
324<div class="memitem">
325<div class="memproto">
326      <table class="memname">
327        <tr>
328          <td class="memname">void bdm::chmat::opupdt           </td>
329          <td>(</td>
330          <td class="paramtype">const vec &amp;&nbsp;</td>
331          <td class="paramname"> <em>v</em>, </td>
332        </tr>
333        <tr>
334          <td class="paramkey"></td>
335          <td></td>
336          <td class="paramtype">double&nbsp;</td>
337          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
338        </tr>
339        <tr>
340          <td></td>
341          <td>)</td>
342          <td></td><td></td><td><code> [virtual]</code></td>
343        </tr>
344      </table>
345</div>
346<div class="memdoc">
347
348<p>
349Perfroms a rank-1 update by outer product of vectors: <img class="formulaInl" alt="$V = V + w v v'$" src="form_59.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
350  <table border="0" cellspacing="2" cellpadding="0">
351    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
352    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
353  </table>
354</dl>
355BLAS-2b operation.
356<p>Reimplemented from <a class="el" href="classbdm_1_1sqmat.html#12298b1cc5a6f35876291e876b0e2993">bdm::sqmat</a>.</p>
357
358<p>References <a class="el" href="chmat_8h_source.html#l00030">Ch</a>.</p>
359
360</div>
361</div><p>
362<a class="anchor" name="ec8d3a1cbf3b50183f246a858663c92d"></a><!-- doxytag: member="bdm::chmat::sqrt_mult" ref="ec8d3a1cbf3b50183f246a858663c92d" args="(const vec &amp;v) const " -->
363<div class="memitem">
364<div class="memproto">
365      <table class="memname">
366        <tr>
367          <td class="memname">vec bdm::chmat::sqrt_mult           </td>
368          <td>(</td>
369          <td class="paramtype">const vec &amp;&nbsp;</td>
370          <td class="paramname"> <em>v</em>          </td>
371          <td>&nbsp;)&nbsp;</td>
372          <td> const<code> [virtual]</code></td>
373        </tr>
374      </table>
375</div>
376<div class="memdoc">
377
378<p>
379Multiplies 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">.
380<p>
381Used e.g. in generating normal samples.
382<p>Reimplemented from <a class="el" href="classbdm_1_1sqmat.html#bcacd85ec5d128ebbb663ae4433c75b3">bdm::sqmat</a>.</p>
383
384<p>References <a class="el" href="chmat_8h_source.html#l00030">Ch</a>.</p>
385
386</div>
387</div><p>
388<hr>The documentation for this class was generated from the following files:<ul>
389<li><a class="el" href="chmat_8h_source.html">chmat.h</a><li>chmat.cpp</ul>
390</div>
391<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:47 2009 for mixpp by&nbsp;
392<a href="http://www.doxygen.org/index.html">
393<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
394</body>
395</html>
Note: See TracBrowser for help on using the browser.