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

Revision 608, 27.5 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::chmat 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_1chmat.html">chmat</a>
70  </div>
71</div>
72<div class="contents">
[591]73<h1>bdm::chmat Class Reference</h1><!-- doxytag: class="bdm::chmat" --><!-- doxytag: inherits="bdm::sqmat" -->
74<p>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. 
75<a href="#_details">More...</a></p>
[538]76
[591]77<p><code>#include &lt;<a class="el" href="chmat_8h_source.html">chmat.h</a>&gt;</code></p>
[538]78
[591]79<p><a href="classbdm_1_1chmat-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#abea30d9ae395363e5aef36f6359b15fd">opupdt</a> (const vec &amp;v, double w)</td></tr>
83<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b4c5d4dbb8a3d585b68d936cb6df31b"></a><!-- doxytag: member="bdm::chmat::to_mat" ref="a4b4c5d4dbb8a3d585b68d936cb6df31b" args="() const " -->
84mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a4b4c5d4dbb8a3d585b68d936cb6df31b">to_mat</a> () const </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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a832d1a18bbf33ee7681adf01d5d08e21">mult_sym</a> (const mat &amp;C)</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="#a832d1a18bbf33ee7681adf01d5d08e21"></a><br/></td></tr>
[591]88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0bf9168129004c4017d32fe1dc45816"></a><!-- doxytag: member="bdm::chmat::mult_sym" ref="ac0bf9168129004c4017d32fe1dc45816" args="(const mat &amp;C, chmat &amp;U) const " -->
[538]89void&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>
[591]90<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a7a4f54f1ea8b802f318de77a78f6ddb0">mult_sym_t</a> (const mat &amp;C)</td></tr>
[608]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_60.png"/>, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_62.png"/>.  <a href="#a7a4f54f1ea8b802f318de77a78f6ddb0"></a><br/></td></tr>
[591]92<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a18034a874d46b034f29a7e5d42f3b"></a><!-- doxytag: member="bdm::chmat::mult_sym_t" ref="a78a18034a874d46b034f29a7e5d42f3b" args="(const mat &amp;C, chmat &amp;U) const " -->
[538]93void&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>
[591]94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a949ccd174ed19f9cfe36366cbd5c56a4"></a><!-- doxytag: member="bdm::chmat::logdet" ref="a949ccd174ed19f9cfe36366cbd5c56a4" args="() const " -->
95double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a949ccd174ed19f9cfe36366cbd5c56a4">logdet</a> () const </td></tr>
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br/></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#aec8d3a1cbf3b50183f246a858663c92d">sqrt_mult</a> (const vec &amp;v) const </td></tr>
[608]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_63.png"/> by vector <img class="formulaInl" alt="$x$" src="form_1.png"/>.  <a href="#aec8d3a1cbf3b50183f246a858663c92d"></a><br/></td></tr>
[591]99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e0aee9691909602d341fe5ebd1f1ca8"></a><!-- doxytag: member="bdm::chmat::qform" ref="a6e0aee9691909602d341fe5ebd1f1ca8" args="(const vec &amp;v) const " -->
100double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a6e0aee9691909602d341fe5ebd1f1ca8">qform</a> (const vec &amp;v) const </td></tr>
[608]101<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]102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ac8d00a14a22a21760a8374fe5c5757"></a><!-- doxytag: member="bdm::chmat::invqform" ref="a3ac8d00a14a22a21760a8374fe5c5757" args="(const vec &amp;v) const " -->
103double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a3ac8d00a14a22a21760a8374fe5c5757">invqform</a> (const vec &amp;v) const </td></tr>
[608]104<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]105<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc753cb54aa8946ce41d95e82fc148b5"></a><!-- doxytag: member="bdm::chmat::clear" ref="abc753cb54aa8946ce41d95e82fc148b5" args="()" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#abc753cb54aa8946ce41d95e82fc148b5">clear</a> ()</td></tr>
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br/></td></tr>
108<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b3d5b772f791fc7c5df544a418278c7"></a><!-- doxytag: member="bdm::chmat::add" ref="a6b3d5b772f791fc7c5df544a418278c7" args="(const chmat &amp;A2, double w=1.0)" -->
109void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a6b3d5b772f791fc7c5df544a418278c7">add</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2, double w=1.0)</td></tr>
110<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>
111<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbf3389db96dff41fb2e9532d59b13c0"></a><!-- doxytag: member="bdm::chmat::inv" ref="acbf3389db96dff41fb2e9532d59b13c0" args="(chmat &amp;Inv) const " -->
112void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#acbf3389db96dff41fb2e9532d59b13c0">inv</a> (<a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;Inv) const </td></tr>
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inversion in the same form, i.e. cholesky. <br/></td></tr>
114<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa888e866a163bffe94b51e58af65901b"></a><!-- doxytag: member="bdm::chmat::~chmat" ref="aa888e866a163bffe94b51e58af65901b" args="()" -->
115virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#aa888e866a163bffe94b51e58af65901b">~chmat</a> ()</td></tr>
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br/></td></tr>
117<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a947c52c64022ef364d8ef17c94a65ef1"></a><!-- doxytag: member="bdm::chmat::chmat" ref="a947c52c64022ef364d8ef17c94a65ef1" args="(const int dim0)" -->
118&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a947c52c64022ef364d8ef17c94a65ef1">chmat</a> (const int dim0)</td></tr>
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae4dd65ff29d7d951b18903b100bd39d"></a><!-- doxytag: member="bdm::chmat::chmat" ref="aae4dd65ff29d7d951b18903b100bd39d" args="(const vec &amp;v)" -->
121&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#aae4dd65ff29d7d951b18903b100bd39d">chmat</a> (const vec &amp;v)</td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57513fca80f91194faf90297f2ab2b24"></a><!-- doxytag: member="bdm::chmat::chmat" ref="a57513fca80f91194faf90297f2ab2b24" args="(const chmat &amp;Ch0)" -->
124&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a57513fca80f91194faf90297f2ab2b24">chmat</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;Ch0)</td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a796ee52e1343bc53d278f17c55bb1cc7"></a><!-- doxytag: member="bdm::chmat::chmat" ref="a796ee52e1343bc53d278f17c55bb1cc7" args="(const mat &amp;M)" -->
127&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a796ee52e1343bc53d278f17c55bb1cc7">chmat</a> (const mat &amp;M)</td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (m3k:cholform). <br/></td></tr>
129<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a3c4e675e7efd91f78faa3dcf23aec153">chmat</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;M, const ivec &amp;perm)</td></tr>
130<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17daa8c5c5914bd3194cb3053c5793a5"></a><!-- doxytag: member="bdm::chmat::_Ch" ref="a17daa8c5c5914bd3194cb3053c5793a5" args="()" -->
131mat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a17daa8c5c5914bd3194cb3053c5793a5">_Ch</a> ()</td></tr>
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br/></td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e9e137c1a6f46d13c2b6790cfddaa92"></a><!-- doxytag: member="bdm::chmat::_Ch" ref="a3e9e137c1a6f46d13c2b6790cfddaa92" args="() const " -->
134const mat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a3e9e137c1a6f46d13c2b6790cfddaa92">_Ch</a> () const </td></tr>
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access function. <br/></td></tr>
136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab192df5b54b173ba9bc6922ee9983bc9"></a><!-- doxytag: member="bdm::chmat::setD" ref="ab192df5b54b173ba9bc6922ee9983bc9" args="(const vec &amp;nD)" -->
137void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#ab192df5b54b173ba9bc6922ee9983bc9">setD</a> (const vec &amp;nD)</td></tr>
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br/></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8fd18754b0e5e0463f818cd16c710c8"></a><!-- doxytag: member="bdm::chmat::setCh" ref="ab8fd18754b0e5e0463f818cd16c710c8" args="(const vec &amp;chQ)" -->
140void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#ab8fd18754b0e5e0463f818cd16c710c8">setCh</a> (const vec &amp;chQ)</td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br/></td></tr>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18f4b97bde650086fe5e3d9461a13514"></a><!-- doxytag: member="bdm::chmat::setD" ref="a18f4b97bde650086fe5e3d9461a13514" args="(const vec &amp;nD, int i)" -->
143void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a18f4b97bde650086fe5e3d9461a13514">setD</a> (const vec &amp;nD, int i)</td></tr>
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br/></td></tr>
145<tr><td class="memItemLeft" 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#a029a0997afc656fde0c73bbf7724aca9">operator+=</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2)</td></tr>
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Operators.  <a href="#a029a0997afc656fde0c73bbf7724aca9"></a><br/></td></tr>
147<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1d0180fb795d38b8c352df2686ec5ba"></a><!-- doxytag: member="bdm::chmat::operator&#45;=" ref="af1d0180fb795d38b8c352df2686ec5ba" args="(const chmat &amp;A2)" -->
148<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#af1d0180fb795d38b8c352df2686ec5ba">operator-=</a> (const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;A2)</td></tr>
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mapping of negative add operation to operators <br/></td></tr>
150<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62ce85eb2461b51821c0d8507dfb9e95"></a><!-- doxytag: member="bdm::chmat::operator*" ref="a62ce85eb2461b51821c0d8507dfb9e95" args="(const double &amp;d)" -->
[538]151<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>
[591]152<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8727d34435b7aa241c47a7b2fc0bed16"></a><!-- doxytag: member="bdm::chmat::operator=" ref="a8727d34435b7aa241c47a7b2fc0bed16" args="(const chmat &amp;A2)" -->
[538]153<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>
[591]154<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab05aac3f788d953a78c96295a6ad3d3b"></a><!-- doxytag: member="bdm::chmat::operator*=" ref="ab05aac3f788d953a78c96295a6ad3d3b" args="(double x)" -->
[538]155<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>
[591]156<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a445ef762cf5d2d6cfdf53c72942363cf"></a><!-- doxytag: member="bdm::chmat::cols" ref="a445ef762cf5d2d6cfdf53c72942363cf" args="() const " -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a445ef762cf5d2d6cfdf53c72942363cf">cols</a> () const </td></tr>
158<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>
159<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73e639221343dcce76c3305524d67590"></a><!-- doxytag: member="bdm::chmat::rows" ref="a73e639221343dcce76c3305524d67590" args="() const " -->
160int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a73e639221343dcce76c3305524d67590">rows</a> () const </td></tr>
161<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>
162<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
163<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e4f39b1895a0a870f8db98329635223"></a><!-- doxytag: member="bdm::chmat::Ch" ref="a3e4f39b1895a0a870f8db98329635223" args="" -->
164mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1chmat.html#a3e4f39b1895a0a870f8db98329635223">Ch</a></td></tr>
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Upper triangle of the cholesky matrix. <br/></td></tr>
166<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05111b5744a494880e62cb0f3d42293f"></a><!-- doxytag: member="bdm::chmat::dim" ref="a05111b5744a494880e62cb0f3d42293f" args="" -->
167int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1sqmat.html#a05111b5744a494880e62cb0f3d42293f">dim</a></td></tr>
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br/></td></tr>
[538]169</table>
[591]170<hr/><a name="_details"></a><h2>Detailed Description</h2>
171<p>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. </p>
[608]172<p>This 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; </p>
[591]173<hr/><h2>Constructor &amp; Destructor Documentation</h2>
174<a class="anchor" id="a3c4e675e7efd91f78faa3dcf23aec153"></a><!-- doxytag: member="bdm::chmat::chmat" ref="a3c4e675e7efd91f78faa3dcf23aec153" args="(const chmat &amp;M, const ivec &amp;perm)" -->
[590]175<div class="memitem">
176<div class="memproto">
177      <table class="memname">
178        <tr>
[591]179          <td class="memname">bdm::chmat::chmat </td>
[590]180          <td>(</td>
181          <td class="paramtype">const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td>
182          <td class="paramname"> <em>M</em>, </td>
183        </tr>
184        <tr>
185          <td class="paramkey"></td>
186          <td></td>
187          <td class="paramtype">const ivec &amp;&nbsp;</td>
188          <td class="paramname"> <em>perm</em></td><td>&nbsp;</td>
189        </tr>
190        <tr>
191          <td></td>
192          <td>)</td>
193          <td></td><td></td><td><code> [inline]</code></td>
194        </tr>
195      </table>
196</div>
197<div class="memdoc">
[591]198<p>Some templates require this constructor to compile, but it shouldn't actually be called. </p>
[590]199
[591]200<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
[590]201
202</div>
[591]203</div>
204<hr/><h2>Member Function Documentation</h2>
205<a class="anchor" id="a832d1a18bbf33ee7681adf01d5d08e21"></a><!-- doxytag: member="bdm::chmat::mult_sym" ref="a832d1a18bbf33ee7681adf01d5d08e21" args="(const mat &amp;C)" -->
[538]206<div class="memitem">
207<div class="memproto">
208      <table class="memname">
209        <tr>
[591]210          <td class="memname">void bdm::chmat::mult_sym </td>
[538]211          <td>(</td>
212          <td class="paramtype">const mat &amp;&nbsp;</td>
[591]213          <td class="paramname"> <em>C</em></td>
[538]214          <td>&nbsp;)&nbsp;</td>
215          <td><code> [virtual]</code></td>
216        </tr>
217      </table>
218</div>
219<div class="memdoc">
220
[608]221<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]222<dl><dt><b>Parameters:</b></dt><dd>
[538]223  <table border="0" cellspacing="2" cellpadding="0">
224    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
225  </table>
[591]226  </dd>
[538]227</dl>
228
[591]229<p>Implements <a class="el" href="classbdm_1_1sqmat.html#a742581db1f8ce9602ec1c3e6373e499c">bdm::sqmat</a>.</p>
[538]230
[591]231<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>
[538]232
233</div>
[591]234</div>
235<a class="anchor" id="a7a4f54f1ea8b802f318de77a78f6ddb0"></a><!-- doxytag: member="bdm::chmat::mult_sym_t" ref="a7a4f54f1ea8b802f318de77a78f6ddb0" args="(const mat &amp;C)" -->
[538]236<div class="memitem">
237<div class="memproto">
238      <table class="memname">
239        <tr>
[591]240          <td class="memname">void bdm::chmat::mult_sym_t </td>
[538]241          <td>(</td>
242          <td class="paramtype">const mat &amp;&nbsp;</td>
[591]243          <td class="paramname"> <em>C</em></td>
[538]244          <td>&nbsp;)&nbsp;</td>
245          <td><code> [virtual]</code></td>
246        </tr>
247      </table>
248</div>
249<div class="memdoc">
250
[608]251<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]252<dl><dt><b>Parameters:</b></dt><dd>
[538]253  <table border="0" cellspacing="2" cellpadding="0">
254    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
255  </table>
[591]256  </dd>
[538]257</dl>
258
[591]259<p>Implements <a class="el" href="classbdm_1_1sqmat.html#a2db6f35ac14e6d1d905b4100e4c13743">bdm::sqmat</a>.</p>
[538]260
[591]261<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>
[538]262
263</div>
[591]264</div>
265<a class="anchor" id="a029a0997afc656fde0c73bbf7724aca9"></a><!-- doxytag: member="bdm::chmat::operator+=" ref="a029a0997afc656fde0c73bbf7724aca9" args="(const chmat &amp;A2)" -->
[538]266<div class="memitem">
267<div class="memproto">
268      <table class="memname">
269        <tr>
[591]270          <td class="memname"><a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp; bdm::chmat::operator+= </td>
[538]271          <td>(</td>
272          <td class="paramtype">const <a class="el" href="classbdm_1_1chmat.html">chmat</a> &amp;&nbsp;</td>
[591]273          <td class="paramname"> <em>A2</em></td>
[538]274          <td>&nbsp;)&nbsp;</td>
275          <td><code> [inline]</code></td>
276        </tr>
277      </table>
278</div>
279<div class="memdoc">
280
[591]281<p>Operators. </p>
282<p>Operations: mapping of add operation to operators </p>
283
284<p>References <a class="el" href="chmat_8h_source.html#l00045">add()</a>.</p>
285
[538]286</div>
[591]287</div>
288<a class="anchor" id="abea30d9ae395363e5aef36f6359b15fd"></a><!-- doxytag: member="bdm::chmat::opupdt" ref="abea30d9ae395363e5aef36f6359b15fd" args="(const vec &amp;v, double w)" -->
[538]289<div class="memitem">
290<div class="memproto">
291      <table class="memname">
292        <tr>
[591]293          <td class="memname">void bdm::chmat::opupdt </td>
[538]294          <td>(</td>
295          <td class="paramtype">const vec &amp;&nbsp;</td>
296          <td class="paramname"> <em>v</em>, </td>
297        </tr>
298        <tr>
299          <td class="paramkey"></td>
300          <td></td>
301          <td class="paramtype">double&nbsp;</td>
302          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
303        </tr>
304        <tr>
305          <td></td>
306          <td>)</td>
307          <td></td><td></td><td><code> [virtual]</code></td>
308        </tr>
309      </table>
310</div>
311<div class="memdoc">
[608]312<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]313<dl><dt><b>Parameters:</b></dt><dd>
[538]314  <table border="0" cellspacing="2" cellpadding="0">
315    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
316    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
317  </table>
[591]318  </dd>
[538]319</dl>
[591]320<p>BLAS-2b operation. </p>
[538]321
[591]322<p>Implements <a class="el" href="classbdm_1_1sqmat.html#acb3b3eef10b0c1f41ead717d3ad40ec5">bdm::sqmat</a>.</p>
[538]323
[591]324<p>References <a class="el" href="chmat_8h_source.html#l00030">Ch</a>.</p>
325
[538]326</div>
[591]327</div>
328<a class="anchor" id="aec8d3a1cbf3b50183f246a858663c92d"></a><!-- doxytag: member="bdm::chmat::sqrt_mult" ref="aec8d3a1cbf3b50183f246a858663c92d" args="(const vec &amp;v) const " -->
[538]329<div class="memitem">
330<div class="memproto">
331      <table class="memname">
332        <tr>
[591]333          <td class="memname">vec bdm::chmat::sqrt_mult </td>
[538]334          <td>(</td>
335          <td class="paramtype">const vec &amp;&nbsp;</td>
[591]336          <td class="paramname"> <em>v</em></td>
[538]337          <td>&nbsp;)&nbsp;</td>
338          <td> const<code> [virtual]</code></td>
339        </tr>
340      </table>
341</div>
342<div class="memdoc">
343
[608]344<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]345<p>Used e.g. in generating normal samples. </p>
[538]346
[591]347<p>Implements <a class="el" href="classbdm_1_1sqmat.html#a608bfff59854833f1acfccdbd346832a">bdm::sqmat</a>.</p>
[538]348
[591]349<p>References <a class="el" href="chmat_8h_source.html#l00030">Ch</a>.</p>
350
[538]351</div>
352</div>
[591]353<hr/>The documentation for this class was generated from the following files:<ul>
354<li><a class="el" href="chmat_8h_source.html">chmat.h</a></li>
355<li>chmat.cpp</li>
356</ul>
357</div>
[608]358<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp;
[538]359<a href="http://www.doxygen.org/index.html">
[591]360<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[538]361</body>
362</html>
Note: See TracBrowser for help on using the browser.