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

Revision 661, 29.1 kB (checked in by smidl, 15 years ago)

doc

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