root/library/doc/html/classfsqmat.html @ 397

Revision 397, 28.1 kB (checked in by smidl, 16 years ago)

doc

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: fsqmat 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><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67</div>
68<div class="contents">
69<h1>fsqmat Class Reference<br>
70<small>
71[<a class="el" href="group__math.html">Auxiliary math functions</a>]</small>
72</h1><!-- doxytag: class="fsqmat" --><!-- doxytag: inherits="sqmat" -->Fake <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a>. This class maps <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a> operations to operations on full matrix. 
73<a href="#_details">More...</a>
74<p>
75<<<<<<< HEAD:library/doc/html/classfsqmat.html
76<code>#include &lt;<a class="el" href="square__mat_8h_source.html">square_mat.h</a>&gt;</code>
77=======
78<code>#include &lt;<a class="el" href="square__mat_8h-source.html">square_mat.h</a>&gt;</code>
79>>>>>>> doc:library/doc/html/classfsqmat.html
80<p>
81
82<p>
83<a href="classfsqmat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
84<tr><td></td></tr>
85<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#b36530e155667fe9f1bd58394e50c65a">opupdt</a> (const vec &amp;v, double w)</td></tr>
87
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f54fc955e8e3b43d15afa92124bc24b3"></a><!-- doxytag: member="fsqmat::to_mat" ref="f54fc955e8e3b43d15afa92124bc24b3" args="() const " -->
89mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#f54fc955e8e3b43d15afa92124bc24b3">to_mat</a> () const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to full matrix. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#5530d2756b5d991de755e6121c9a452e">mult_sym</a> (const mat &amp;C)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_53.png">.  <a href="#5530d2756b5d991de755e6121c9a452e"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#92052a8adc2054b63e42d1373d145c89">mult_sym_t</a> (const mat &amp;C)</td></tr>
96
97<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_52.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_54.png">.  <a href="#92052a8adc2054b63e42d1373d145c89"></a><br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4eddc3743c8865cc5ed92d14de0e3e3"></a><!-- doxytag: member="fsqmat::mult_sym" ref="d4eddc3743c8865cc5ed92d14de0e3e3" args="(const mat &amp;C, fsqmat &amp;U) const " -->
99void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#d4eddc3743c8865cc5ed92d14de0e3e3">mult_sym</a> (const mat &amp;C, <a class="el" href="classfsqmat.html">fsqmat</a> &amp;U) const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">store result of <code>mult_sym</code> in external matrix <img class="formulaInl" alt="$U$" src="form_58.png"> <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae4949ad2a32553c7fa04d6d1483770a"></a><!-- doxytag: member="fsqmat::mult_sym_t" ref="ae4949ad2a32553c7fa04d6d1483770a" args="(const mat &amp;C, fsqmat &amp;U) const " -->
103void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#ae4949ad2a32553c7fa04d6d1483770a">mult_sym_t</a> (const mat &amp;C, <a class="el" href="classfsqmat.html">fsqmat</a> &amp;U) const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">store result of <code>mult_sym_t</code> in external matrix <img class="formulaInl" alt="$U$" src="form_58.png"> <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfa4c359483d2322f32d1d50050f8ac4"></a><!-- doxytag: member="fsqmat::clear" ref="cfa4c359483d2322f32d1d50050f8ac4" args="()" -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#cfa4c359483d2322f32d1d50050f8ac4">clear</a> ()</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clearing matrix so that it corresponds to zeros. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79e3f73e0ccd663c7f7e08083d272940"></a><!-- doxytag: member="fsqmat::fsqmat" ref="79e3f73e0ccd663c7f7e08083d272940" args="()" -->
111&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#79e3f73e0ccd663c7f7e08083d272940">fsqmat</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default initialization. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40eae99305e7c7240fa95cfec125b06f"></a><!-- doxytag: member="fsqmat::fsqmat" ref="40eae99305e7c7240fa95cfec125b06f" args="(const int dim0)" -->
115&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#40eae99305e7c7240fa95cfec125b06f">fsqmat</a> (const int dim0)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default initialization with proper size. <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1929fbc9fe375f1d67f979d0d302336f"></a><!-- doxytag: member="fsqmat::fsqmat" ref="1929fbc9fe375f1d67f979d0d302336f" args="(const mat &amp;M)" -->
119&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#1929fbc9fe375f1d67f979d0d302336f">fsqmat</a> (const mat &amp;<a class="el" href="classfsqmat.html#a7a1fcb9aae19d1e4daddfc9c22ce453">M</a>)</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e19a5e26083f4a493b6fad38cc40fab"></a><!-- doxytag: member="fsqmat::fsqmat" ref="9e19a5e26083f4a493b6fad38cc40fab" args="(const fsqmat &amp;M, const ivec &amp;perm)" -->
123&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#9e19a5e26083f4a493b6fad38cc40fab">fsqmat</a> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;<a class="el" href="classfsqmat.html#a7a1fcb9aae19d1e4daddfc9c22ce453">M</a>, const ivec &amp;perm)</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c01f3e9bb590f2a2921369d672f3ce1e"></a><!-- doxytag: member="fsqmat::fsqmat" ref="c01f3e9bb590f2a2921369d672f3ce1e" args="(const vec &amp;d)" -->
127&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#c01f3e9bb590f2a2921369d672f3ce1e">fsqmat</a> (const vec &amp;d)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a8f104e4befbc2aa90d8b11edfedb2e"></a><!-- doxytag: member="fsqmat::~fsqmat" ref="2a8f104e4befbc2aa90d8b11edfedb2e" args="()" -->
131virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#2a8f104e4befbc2aa90d8b11edfedb2e">~fsqmat</a> ()</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#9fa853e1ca28f2a1a1c43377e798ecb1">inv</a> (<a class="el" href="classfsqmat.html">fsqmat</a> &amp;Inv)</td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix inversion preserving the chosen form.  <a href="#9fa853e1ca28f2a1a1c43377e798ecb1"></a><br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb0d1358f536e4453b5f99d0418ca1e5"></a><!-- doxytag: member="fsqmat::logdet" ref="eb0d1358f536e4453b5f99d0418ca1e5" args="() const " -->
138double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#eb0d1358f536e4453b5f99d0418ca1e5">logdet</a> () const </td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of a determinant. <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6c91b0389e73404324b2314b08d6e87"></a><!-- doxytag: member="fsqmat::qform" ref="a6c91b0389e73404324b2314b08d6e87" args="(const vec &amp;v) const " -->
142double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#a6c91b0389e73404324b2314b08d6e87">qform</a> (const vec &amp;v) const </td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*V*v$" src="form_56.png">;. <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58075da64ddadd4df40654c35b928c6f"></a><!-- doxytag: member="fsqmat::invqform" ref="58075da64ddadd4df40654c35b928c6f" args="(const vec &amp;v) const " -->
146double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#58075da64ddadd4df40654c35b928c6f">invqform</a> (const vec &amp;v) const </td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates quadratic form <img class="formulaInl" alt="$x= v'*inv(V)*v$" src="form_57.png">;. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#842a774077ee34ac3c36d180ab33e103">sqrt_mult</a> (const vec &amp;v) const </td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies square root of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.  <a href="#842a774077ee34ac3c36d180ab33e103"></a><br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2e0bf7dbbbbe1d3358064c4ad455f1f"></a><!-- doxytag: member="fsqmat::add" ref="a2e0bf7dbbbbe1d3358064c4ad455f1f" args="(const fsqmat &amp;fsq2, double w=1.0)" -->
153void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#a2e0bf7dbbbbe1d3358064c4ad455f1f">add</a> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;fsq2, double w=1.0)</td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add another matrix in fsq form with weight w. <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="922f8190c13987cbcdb33ec2bf5cf105"></a><!-- doxytag: member="fsqmat::setD" ref="922f8190c13987cbcdb33ec2bf5cf105" args="(const vec &amp;nD)" -->
157void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#922f8190c13987cbcdb33ec2bf5cf105">setD</a> (const vec &amp;nD)</td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf837b2956745e8986044f5600dbd6e"></a><!-- doxytag: member="fsqmat::getD" ref="bcf837b2956745e8986044f5600dbd6e" args="()" -->
161vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#bcf837b2956745e8986044f5600dbd6e">getD</a> ()</td></tr>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03a8f49eb4d38a054ecc522be59cd2ad"></a><!-- doxytag: member="fsqmat::setD" ref="03a8f49eb4d38a054ecc522be59cd2ad" args="(const vec &amp;nD, int i)" -->
165void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#03a8f49eb4d38a054ecc522be59cd2ad">setD</a> (const vec &amp;nD, int i)</td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access functions. <br></td></tr>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="514d1fdd8a382dbd6a774f2cf1ebd3de"></a><!-- doxytag: member="fsqmat::operator+=" ref="514d1fdd8a382dbd6a774f2cf1ebd3de" args="(const fsqmat &amp;A)" -->
169<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#514d1fdd8a382dbd6a774f2cf1ebd3de">operator+=</a> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;A)</td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add another <a class="el" href="classfsqmat.html" title="Fake sqmat. This class maps sqmat operations to operations on full matrix.">fsqmat</a> matrix <br></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e976bc9d899961e1d2087b0630ed33b7"></a><!-- doxytag: member="fsqmat::operator&#45;=" ref="e976bc9d899961e1d2087b0630ed33b7" args="(const fsqmat &amp;A)" -->
173<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#e976bc9d899961e1d2087b0630ed33b7">operator-=</a> (const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;A)</td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">subtrack another <a class="el" href="classfsqmat.html" title="Fake sqmat. This class maps sqmat operations to operations on full matrix.">fsqmat</a> matrix <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af800e7b2146da5e60897255dde80059"></a><!-- doxytag: member="fsqmat::operator*=" ref="af800e7b2146da5e60897255dde80059" args="(double x)" -->
177<a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#af800e7b2146da5e60897255dde80059">operator*=</a> (double x)</td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">multiply by a scalar <br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecc2e2540f95a04f4449842588170f5b"></a><!-- doxytag: member="fsqmat::cols" ref="ecc2e2540f95a04f4449842588170f5b" args="() const " -->
181int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b">cols</a> () const </td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="071e80ced9cc3b8cbb360fa7462eb646"></a><!-- doxytag: member="fsqmat::rows" ref="071e80ced9cc3b8cbb360fa7462eb646" args="() const " -->
185int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#071e80ced9cc3b8cbb360fa7462eb646">rows</a> () const </td></tr>
186
187<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplementing common functions of mat: <a class="el" href="classsqmat.html#ecc2e2540f95a04f4449842588170f5b" title="Reimplementing common functions of mat: cols().">cols()</a>. <br></td></tr>
188<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
189<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7a1fcb9aae19d1e4daddfc9c22ce453"></a><!-- doxytag: member="fsqmat::M" ref="a7a1fcb9aae19d1e4daddfc9c22ce453" args="" -->
190mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#a7a1fcb9aae19d1e4daddfc9c22ce453">M</a></td></tr>
191
192<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full matrix on which the operations are performed. <br></td></tr>
193<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0abed904bdc0882373ba9adba919689d"></a><!-- doxytag: member="fsqmat::dim" ref="0abed904bdc0882373ba9adba919689d" args="" -->
194int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsqmat.html#0abed904bdc0882373ba9adba919689d">dim</a></td></tr>
195
196<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the square matrix <br></td></tr>
197<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
198<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e06aba54d61e807b41bd68b5ee6ac22f"></a><!-- doxytag: member="fsqmat::operator&lt;&lt;" ref="e06aba54d61e807b41bd68b5ee6ac22f" args="(std::ostream &amp;os, const fsqmat &amp;sq)" -->
199std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsqmat.html#e06aba54d61e807b41bd68b5ee6ac22f">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classfsqmat.html">fsqmat</a> &amp;sq)</td></tr>
200
201<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">print full matrix <br></td></tr>
202</table>
203<hr><a name="_details"></a><h2>Detailed Description</h2>
204Fake <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a>. This class maps <a class="el" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square-root form...">sqmat</a> operations to operations on full matrix.
205<p>
206This class can be used to compare performance of algorithms using decomposed matrices with perormance of the same algorithms using full matrices; <hr><h2>Member Function Documentation</h2>
207<a class="anchor" name="9fa853e1ca28f2a1a1c43377e798ecb1"></a><!-- doxytag: member="fsqmat::inv" ref="9fa853e1ca28f2a1a1c43377e798ecb1" args="(fsqmat &amp;Inv)" -->
208<div class="memitem">
209<div class="memproto">
210      <table class="memname">
211        <tr>
212          <td class="memname">void fsqmat::inv           </td>
213          <td>(</td>
214          <td class="paramtype"><a class="el" href="classfsqmat.html">fsqmat</a> &amp;&nbsp;</td>
215          <td class="paramname"> <em>Inv</em>          </td>
216          <td>&nbsp;)&nbsp;</td>
217          <td><code> [virtual]</code></td>
218        </tr>
219      </table>
220</div>
221<div class="memdoc">
222
223<p>
224Matrix inversion preserving the chosen form.
225<p>
226<dl compact><dt><b>Parameters:</b></dt><dd>
227  <table border="0" cellspacing="2" cellpadding="0">
228    <tr><td valign="top"></td><td valign="top"><em>Inv</em>&nbsp;</td><td>a space where the inverse is stored. </td></tr>
229  </table>
230</dl>
231
232<<<<<<< HEAD:library/doc/html/classfsqmat.html
233<p>References <a class="el" href="square__mat_8h_source.html#l00122">M</a>.</p>
234
235<p>Referenced by <a class="el" href="kalman_8h_source.html#l00493">bdm::EKF&lt; sq_T &gt;::bayes()</a>, and <a class="el" href="exp__family_8cpp_source.html#l00021">bdm::egiw::evallog_nn()</a>.</p>
236=======
237<p>References <a class="el" href="square__mat_8h-source.html#l00122">M</a>.</p>
238
239<p>Referenced by <a class="el" href="kalman_8h-source.html#l00493">bdm::EKF&lt; sq_T &gt;::bayes()</a>, and <a class="el" href="exp__family_8cpp-source.html#l00021">bdm::egiw::evallog_nn()</a>.</p>
240>>>>>>> doc:library/doc/html/classfsqmat.html
241
242</div>
243</div><p>
244<a class="anchor" name="5530d2756b5d991de755e6121c9a452e"></a><!-- doxytag: member="fsqmat::mult_sym" ref="5530d2756b5d991de755e6121c9a452e" args="(const mat &amp;C)" -->
245<div class="memitem">
246<div class="memproto">
247      <table class="memname">
248        <tr>
249          <td class="memname">void fsqmat::mult_sym           </td>
250          <td>(</td>
251          <td class="paramtype">const mat &amp;&nbsp;</td>
252          <td class="paramname"> <em>C</em>          </td>
253          <td>&nbsp;)&nbsp;</td>
254          <td><code> [virtual]</code></td>
255        </tr>
256      </table>
257</div>
258<div class="memdoc">
259
260<p>
261Inplace symmetric multiplication by a SQUARE matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C*V*C'$" src="form_53.png">.
262<p>
263<dl compact><dt><b>Parameters:</b></dt><dd>
264  <table border="0" cellspacing="2" cellpadding="0">
265    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
266  </table>
267</dl>
268
269<p>Implements <a class="el" href="classsqmat.html#60fbbfa9e483b8187c135f787ee53afa">sqmat</a>.</p>
270
271<<<<<<< HEAD:library/doc/html/classfsqmat.html
272<p>References <a class="el" href="square__mat_8h_source.html#l00122">M</a>.</p>
273
274<p>Referenced by <a class="el" href="kalman_8h_source.html#l00493">bdm::EKF&lt; sq_T &gt;::bayes()</a>.</p>
275=======
276<p>References <a class="el" href="square__mat_8h-source.html#l00122">M</a>.</p>
277
278<p>Referenced by <a class="el" href="kalman_8h-source.html#l00493">bdm::EKF&lt; sq_T &gt;::bayes()</a>.</p>
279>>>>>>> doc:library/doc/html/classfsqmat.html
280
281</div>
282</div><p>
283<a class="anchor" name="92052a8adc2054b63e42d1373d145c89"></a><!-- doxytag: member="fsqmat::mult_sym_t" ref="92052a8adc2054b63e42d1373d145c89" args="(const mat &amp;C)" -->
284<div class="memitem">
285<div class="memproto">
286      <table class="memname">
287        <tr>
288          <td class="memname">void fsqmat::mult_sym_t           </td>
289          <td>(</td>
290          <td class="paramtype">const mat &amp;&nbsp;</td>
291          <td class="paramname"> <em>C</em>          </td>
292          <td>&nbsp;)&nbsp;</td>
293          <td><code> [virtual]</code></td>
294        </tr>
295      </table>
296</div>
297<div class="memdoc">
298
299<p>
300Inplace symmetric multiplication by a SQUARE transpose of matrix <img class="formulaInl" alt="$C$" src="form_52.png">, i.e. <img class="formulaInl" alt="$V = C'*V*C$" src="form_54.png">.
301<p>
302<dl compact><dt><b>Parameters:</b></dt><dd>
303  <table border="0" cellspacing="2" cellpadding="0">
304    <tr><td valign="top"></td><td valign="top"><em>C</em>&nbsp;</td><td>multiplying matrix, </td></tr>
305  </table>
306</dl>
307
308<p>Implements <a class="el" href="classsqmat.html#6909e906da17725b1b80f3cae7cf3325">sqmat</a>.</p>
309
310<<<<<<< HEAD:library/doc/html/classfsqmat.html
311<p>References <a class="el" href="square__mat_8h_source.html#l00122">M</a>.</p>
312=======
313<p>References <a class="el" href="square__mat_8h-source.html#l00122">M</a>.</p>
314>>>>>>> doc:library/doc/html/classfsqmat.html
315
316</div>
317</div><p>
318<a class="anchor" name="b36530e155667fe9f1bd58394e50c65a"></a><!-- doxytag: member="fsqmat::opupdt" ref="b36530e155667fe9f1bd58394e50c65a" args="(const vec &amp;v, double w)" -->
319<div class="memitem">
320<div class="memproto">
321      <table class="memname">
322        <tr>
323          <td class="memname">void fsqmat::opupdt           </td>
324          <td>(</td>
325          <td class="paramtype">const vec &amp;&nbsp;</td>
326          <td class="paramname"> <em>v</em>, </td>
327        </tr>
328        <tr>
329          <td class="paramkey"></td>
330          <td></td>
331          <td class="paramtype">double&nbsp;</td>
332          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
333        </tr>
334        <tr>
335          <td></td>
336          <td>)</td>
337          <td></td><td></td><td><code> [virtual]</code></td>
338        </tr>
339      </table>
340</div>
341<div class="memdoc">
342
343<p>
344Perfroms a rank-1 update by outer product of vectors: <img class="formulaInl" alt="$V = V + w v v'$" src="form_51.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
345  <table border="0" cellspacing="2" cellpadding="0">
346    <tr><td valign="top"></td><td valign="top"><em>v</em>&nbsp;</td><td>Vector forming the outer product to be added </td></tr>
347    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>weight of updating; can be negative</td></tr>
348  </table>
349</dl>
350BLAS-2b operation.
351<p>Implements <a class="el" href="classsqmat.html#b223484796661f2dadb5607a86ce0581">sqmat</a>.</p>
352
353<<<<<<< HEAD:library/doc/html/classfsqmat.html
354<p>References <a class="el" href="square__mat_8h_source.html#l00122">M</a>.</p>
355=======
356<p>References <a class="el" href="square__mat_8h-source.html#l00122">M</a>.</p>
357>>>>>>> doc:library/doc/html/classfsqmat.html
358
359</div>
360</div><p>
361<a class="anchor" name="842a774077ee34ac3c36d180ab33e103"></a><!-- doxytag: member="fsqmat::sqrt_mult" ref="842a774077ee34ac3c36d180ab33e103" args="(const vec &amp;v) const " -->
362<div class="memitem">
363<div class="memproto">
364      <table class="memname">
365        <tr>
366          <td class="memname">vec fsqmat::sqrt_mult           </td>
367          <td>(</td>
368          <td class="paramtype">const vec &amp;&nbsp;</td>
369          <td class="paramname"> <em>v</em>          </td>
370          <td>&nbsp;)&nbsp;</td>
371          <td> const<code> [inline, virtual]</code></td>
372        </tr>
373      </table>
374</div>
375<div class="memdoc">
376
377<p>
378Multiplies square root of <img class="formulaInl" alt="$V$" src="form_55.png"> by vector <img class="formulaInl" alt="$x$" src="form_1.png">.
379<p>
380Used e.g. in generating normal samples.
381<p>Implements <a class="el" href="classsqmat.html#6b79438b5d7544a9c8e110a145355d8f">sqmat</a>.</p>
382
383<<<<<<< HEAD:library/doc/html/classfsqmat.html
384<p>References <a class="el" href="square__mat_8h_source.html#l00122">M</a>.</p>
385=======
386<p>References <a class="el" href="square__mat_8h-source.html#l00122">M</a>.</p>
387>>>>>>> doc:library/doc/html/classfsqmat.html
388
389</div>
390</div><p>
391<hr>The documentation for this class was generated from the following files:<ul>
392<<<<<<< HEAD:library/doc/html/classfsqmat.html
393<li><a class="el" href="square__mat_8h_source.html">square_mat.h</a><li>square_mat.cpp</ul>
394</div>
395<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:47 2009 for mixpp by&nbsp;
396=======
397<li><a class="el" href="square__mat_8h-source.html">square_mat.h</a><li>square_mat.cpp</ul>
398</div>
399<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 23 19:52:51 2009 for mixpp by&nbsp;
400>>>>>>> doc:library/doc/html/classfsqmat.html
401<a href="http://www.doxygen.org/index.html">
402<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
403</body>
404</html>
Note: See TracBrowser for help on using the browser.