root/doc/xml/classfsqmat.xml @ 222

Revision 187, 40.7 kB (checked in by smidl, 17 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classfsqmat" kind="class" prot="public">
4    <compoundname>fsqmat</compoundname>
5    <basecompoundref refid="classsqmat" prot="public" virt="non-virtual">sqmat</basecompoundref>
6    <includes refid="libDC_8h" local="no">libDC.h</includes>
7      <sectiondef kind="protected-attrib">
8      <memberdef kind="variable" id="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" prot="protected" static="no" mutable="no">
9        <type>mat</type>
10        <definition>mat fsqmat::M</definition>
11        <argsstring></argsstring>
12        <name>M</name>
13        <briefdescription>
14<para>Full matrix on which the operations are performed. </para>        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="114" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="114" bodyend="-1"/>
20        <referencedby refid="classfsqmat_1a2e0bf7dbbbbe1d3358064c4ad455f1f" compoundref="libDC_8h" startline="152" endline="152">add</referencedby>
21        <referencedby refid="classfsqmat_1cfa4c359483d2322f32d1d50050f8ac4" compoundref="libDC_8cpp" startline="15" endline="15">clear</referencedby>
22        <referencedby refid="classfsqmat_11929fbc9fe375f1d67f979d0d302336f" compoundref="libDC_8cpp" startline="16" endline="20">fsqmat</referencedby>
23        <referencedby refid="classfsqmat_1bcf837b2956745e8986044f5600dbd6e" compoundref="libDC_8h" startline="157" endline="157">getD</referencedby>
24        <referencedby refid="classfsqmat_19fa853e1ca28f2a1a1c43377e798ecb1" compoundref="libDC_8cpp" startline="14" endline="14">inv</referencedby>
25        <referencedby refid="classfsqmat_158075da64ddadd4df40654c35b928c6f" compoundref="libDC_8h" startline="148" endline="148">invqform</referencedby>
26        <referencedby refid="classfsqmat_1eb0d1358f536e4453b5f99d0418ca1e5" compoundref="libDC_8h" startline="146" endline="146">logdet</referencedby>
27        <referencedby refid="classfsqmat_15530d2756b5d991de755e6121c9a452e" compoundref="libDC_8cpp" startline="10" endline="10">mult_sym</referencedby>
28        <referencedby refid="classfsqmat_192052a8adc2054b63e42d1373d145c89" compoundref="libDC_8cpp" startline="11" endline="11">mult_sym_t</referencedby>
29        <referencedby refid="classfsqmat_1af800e7b2146da5e60897255dde80059" compoundref="libDC_8h" startline="167" endline="167">operator*=</referencedby>
30        <referencedby refid="classfsqmat_1514d1fdd8a382dbd6a774f2cf1ebd3de" compoundref="libDC_8h" startline="163" endline="163">operator+=</referencedby>
31        <referencedby refid="classfsqmat_1e976bc9d899961e1d2087b0630ed33b7" compoundref="libDC_8h" startline="165" endline="165">operator-=</referencedby>
32        <referencedby refid="classfsqmat_1b36530e155667fe9f1bd58394e50c65a" compoundref="libDC_8cpp" startline="8" endline="8">opupdt</referencedby>
33        <referencedby refid="classfsqmat_1a6c91b0389e73404324b2314b08d6e87" compoundref="libDC_8h" startline="147" endline="147">qform</referencedby>
34        <referencedby refid="classfsqmat_1922f8190c13987cbcdb33ec2bf5cf105" compoundref="libDC_8h" startline="155" endline="155">setD</referencedby>
35        <referencedby refid="classfsqmat_1842a774077ee34ac3c36d180ab33e103" compoundref="libDC_8h" startline="149" endline="149">sqrt_mult</referencedby>
36        <referencedby refid="classfsqmat_1cedf4f048309056f4262c930914dfda8" compoundref="libDC_8cpp" startline="9" endline="9">to_mat</referencedby>
37      </memberdef>
38      <memberdef kind="variable" id="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" static="no" mutable="no">
39        <type>int</type>
40        <definition>int sqmat::dim</definition>
41        <argsstring></argsstring>
42        <name>dim</name>
43        <briefdescription>
44<para>dimension of the square matrix </para>        </briefdescription>
45        <detaileddescription>
46        </detaileddescription>
47        <inbodydescription>
48        </inbodydescription>
49        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="102" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="99" bodyend="-1"/>
50        <referencedby refid="classldmat_1a60f2c7e4f3c6a7738eaaaab81ffad20" compoundref="libDC_8cpp" startline="104" endline="114">ldmat::add</referencedby>
51        <referencedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306" compoundref="libDC_8h" startline="277" endline="277">ldmat::cols</referencedby>
52        <referencedby refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" compoundref="libDC_8h" startline="91" endline="91">sqmat::cols</referencedby>
53        <referencedby refid="classldmat_1f291faa073e7bc8dfafc7ae93daa2506" compoundref="libDC_8cpp" startline="203" endline="297">ldmat::ldform</referencedby>
54        <referencedby refid="classldmat_1abe16e0f86668ef61a9a4896c8565dee" compoundref="libDC_8cpp" startline="41" endline="44">ldmat::ldmat</referencedby>
55        <referencedby refid="libDC_8h_16715d039e6d5d97005cf9e2522dfa474" compoundref="libDC_8cpp" startline="301" endline="320">ltuinv</referencedby>
56        <referencedby refid="classldmat_10f0f6e083e6d947cf58097ffce3ccd1a" compoundref="libDC_8cpp" startline="58" endline="72">ldmat::opupdt</referencedby>
57        <referencedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163" compoundref="libDC_8h" startline="279" endline="279">ldmat::rows</referencedby>
58        <referencedby refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" compoundref="libDC_8h" startline="94" endline="94">sqmat::rows</referencedby>
59        <referencedby refid="classldmat_1fc380626ced6f9244fb58c5f0231174d" compoundref="libDC_8cpp" startline="189" endline="201">ldmat::sqrt_mult</referencedby>
60        <referencedby refid="classldmat_15b0515da8dc2293d9e4360b74cc26c9e" compoundref="libDC_8cpp" startline="80" endline="101">ldmat::to_mat</referencedby>
61      </memberdef>
62      </sectiondef>
63      <sectiondef kind="public-func">
64      <memberdef kind="function" id="classfsqmat_1b36530e155667fe9f1bd58394e50c65a" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
65        <type>void</type>
66        <definition>void fsqmat::opupdt</definition>
67        <argsstring>(const vec &amp;v, double w)</argsstring>
68        <name>opupdt</name>
69        <reimplements refid="classsqmat_1b223484796661f2dadb5607a86ce0581">opupdt</reimplements>
70        <param>
71          <type>const vec &amp;</type>
72          <declname>v</declname>
73        </param>
74        <param>
75          <type>double</type>
76          <declname>w</declname>
77        </param>
78        <briefdescription>
79        </briefdescription>
80        <detaileddescription>
81<para>Perfroms a rank-1 update by outer product of vectors: <formula id="23">$V = V + w v v&apos;$</formula>. <parameterlist kind="param"><parameteritem>
82<parameternamelist>
83<parametername>v</parametername>
84</parameternamelist>
85<parameterdescription>
86<para>Vector forming the outer product to be added </para></parameterdescription>
87</parameteritem>
88<parameteritem>
89<parameternamelist>
90<parametername>w</parametername>
91</parameternamelist>
92<parameterdescription>
93<para>weight of updating; can be negative</para></parameterdescription>
94</parameteritem>
95</parameterlist>
96BLAS-2b operation. </para>        </detaileddescription>
97        <inbodydescription>
98        </inbodydescription>
99        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="116" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="8" bodyend="8"/>
100        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
101      </memberdef>
102      <memberdef kind="function" id="classfsqmat_1cedf4f048309056f4262c930914dfda8" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
103        <type>mat</type>
104        <definition>mat fsqmat::to_mat</definition>
105        <argsstring>()</argsstring>
106        <name>to_mat</name>
107        <reimplements refid="classsqmat_19a5b6fddfeb42339e1dc9b978a2590fc">to_mat</reimplements>
108        <briefdescription>
109<para>Conversion to full matrix. </para>        </briefdescription>
110        <detaileddescription>
111        </detaileddescription>
112        <inbodydescription>
113        </inbodydescription>
114        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="117" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="9" bodyend="9"/>
115        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
116        <referencedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7" compoundref="libKF_8h" startline="364" endline="396">EKF&lt; sq_T &gt;::bayes</referencedby>
117      </memberdef>
118      <memberdef kind="function" id="classfsqmat_15530d2756b5d991de755e6121c9a452e" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
119        <type>void</type>
120        <definition>void fsqmat::mult_sym</definition>
121        <argsstring>(const mat &amp;C)</argsstring>
122        <name>mult_sym</name>
123        <reimplements refid="classsqmat_160fbbfa9e483b8187c135f787ee53afa">mult_sym</reimplements>
124        <param>
125          <type>const mat &amp;</type>
126          <declname>C</declname>
127        </param>
128        <briefdescription>
129<para>Inplace symmetric multiplication by a SQUARE matrix <formula id="24">$C$</formula>, i.e. <formula id="25">$V = C*V*C&apos;$</formula>. </para>        </briefdescription>
130        <detaileddescription>
131<para><parameterlist kind="param"><parameteritem>
132<parameternamelist>
133<parametername>C</parametername>
134</parameternamelist>
135<parameterdescription>
136<para>multiplying matrix, </para></parameterdescription>
137</parameteritem>
138</parameterlist>
139</para>        </detaileddescription>
140        <inbodydescription>
141        </inbodydescription>
142        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="118" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="10" bodyend="10"/>
143        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
144        <referencedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7" compoundref="libKF_8h" startline="364" endline="396">EKF&lt; sq_T &gt;::bayes</referencedby>
145      </memberdef>
146      <memberdef kind="function" id="classfsqmat_192052a8adc2054b63e42d1373d145c89" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
147        <type>void</type>
148        <definition>void fsqmat::mult_sym_t</definition>
149        <argsstring>(const mat &amp;C)</argsstring>
150        <name>mult_sym_t</name>
151        <reimplements refid="classsqmat_16909e906da17725b1b80f3cae7cf3325">mult_sym_t</reimplements>
152        <param>
153          <type>const mat &amp;</type>
154          <declname>C</declname>
155        </param>
156        <briefdescription>
157<para>Inplace symmetric multiplication by a SQUARE transpose of matrix <formula id="24">$C$</formula>, i.e. <formula id="26">$V = C&apos;*V*C$</formula>. </para>        </briefdescription>
158        <detaileddescription>
159<para><parameterlist kind="param"><parameteritem>
160<parameternamelist>
161<parametername>C</parametername>
162</parameternamelist>
163<parameterdescription>
164<para>multiplying matrix, </para></parameterdescription>
165</parameteritem>
166</parameterlist>
167</para>        </detaileddescription>
168        <inbodydescription>
169        </inbodydescription>
170        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="119" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="11" bodyend="11"/>
171        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
172      </memberdef>
173      <memberdef kind="function" id="classfsqmat_1d4eddc3743c8865cc5ed92d14de0e3e3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
174        <type>void</type>
175        <definition>void fsqmat::mult_sym</definition>
176        <argsstring>(const mat &amp;C, fsqmat &amp;U) const </argsstring>
177        <name>mult_sym</name>
178        <param>
179          <type>const mat &amp;</type>
180          <declname>C</declname>
181        </param>
182        <param>
183          <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
184          <declname>U</declname>
185        </param>
186        <briefdescription>
187<para>store result of <computeroutput>mult_sym</computeroutput> in external matrix <formula id="31">$U$</formula> </para>        </briefdescription>
188        <detaileddescription>
189        </detaileddescription>
190        <inbodydescription>
191        </inbodydescription>
192        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="121" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="12" bodyend="12"/>
193        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
194      </memberdef>
195      <memberdef kind="function" id="classfsqmat_1ae4949ad2a32553c7fa04d6d1483770a" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
196        <type>void</type>
197        <definition>void fsqmat::mult_sym_t</definition>
198        <argsstring>(const mat &amp;C, fsqmat &amp;U) const </argsstring>
199        <name>mult_sym_t</name>
200        <param>
201          <type>const mat &amp;</type>
202          <declname>C</declname>
203        </param>
204        <param>
205          <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
206          <declname>U</declname>
207        </param>
208        <briefdescription>
209<para>store result of <computeroutput>mult_sym_t</computeroutput> in external matrix <formula id="31">$U$</formula> </para>        </briefdescription>
210        <detaileddescription>
211        </detaileddescription>
212        <inbodydescription>
213        </inbodydescription>
214        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="123" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="13" bodyend="13"/>
215        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
216      </memberdef>
217      <memberdef kind="function" id="classfsqmat_1cfa4c359483d2322f32d1d50050f8ac4" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
218        <type>void</type>
219        <definition>void fsqmat::clear</definition>
220        <argsstring>()</argsstring>
221        <name>clear</name>
222        <reimplements refid="classsqmat_16fca246f9eabbdeb8cac03030e826b5e">clear</reimplements>
223        <briefdescription>
224<para>Clearing matrix so that it corresponds to zeros. </para>        </briefdescription>
225        <detaileddescription>
226        </detaileddescription>
227        <inbodydescription>
228        </inbodydescription>
229        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="124" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="15" bodyend="15"/>
230        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
231      </memberdef>
232      <memberdef kind="function" id="classfsqmat_179e3f73e0ccd663c7f7e08083d272940" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
233        <type></type>
234        <definition>fsqmat::fsqmat</definition>
235        <argsstring>()</argsstring>
236        <name>fsqmat</name>
237        <briefdescription>
238<para>Default initialization. </para>        </briefdescription>
239        <detaileddescription>
240        </detaileddescription>
241        <inbodydescription>
242        </inbodydescription>
243        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="127"/>
244      </memberdef>
245      <memberdef kind="function" id="classfsqmat_140eae99305e7c7240fa95cfec125b06f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
246        <type></type>
247        <definition>fsqmat::fsqmat</definition>
248        <argsstring>(const int dim0)</argsstring>
249        <name>fsqmat</name>
250        <param>
251          <type>const int</type>
252          <declname>dim0</declname>
253        </param>
254        <briefdescription>
255<para>Default initialization with proper size. </para>        </briefdescription>
256        <detaileddescription>
257        </detaileddescription>
258        <inbodydescription>
259        </inbodydescription>
260        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="129" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="24" bodyend="24"/>
261      </memberdef>
262      <memberdef kind="function" id="classfsqmat_11929fbc9fe375f1d67f979d0d302336f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
263        <type></type>
264        <definition>fsqmat::fsqmat</definition>
265        <argsstring>(const mat &amp;M)</argsstring>
266        <name>fsqmat</name>
267        <param>
268          <type>const mat &amp;</type>
269          <declname>M</declname>
270        </param>
271        <briefdescription>
272<para>Constructor. </para>        </briefdescription>
273        <detaileddescription>
274        </detaileddescription>
275        <inbodydescription>
276        </inbodydescription>
277        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="131" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="16" bodyend="20"/>
278        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
279      </memberdef>
280      <memberdef kind="function" id="classfsqmat_1c01f3e9bb590f2a2921369d672f3ce1e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
281        <type></type>
282        <definition>fsqmat::fsqmat</definition>
283        <argsstring>(const vec &amp;d)</argsstring>
284        <name>fsqmat</name>
285        <param>
286          <type>const vec &amp;</type>
287          <declname>d</declname>
288        </param>
289        <briefdescription>
290<para>Constructor. </para>        </briefdescription>
291        <detaileddescription>
292        </detaileddescription>
293        <inbodydescription>
294        </inbodydescription>
295        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="133" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="133" bodyend="133"/>
296        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
297      </memberdef>
298      <memberdef kind="function" id="classfsqmat_12a8f104e4befbc2aa90d8b11edfedb2e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
299        <type></type>
300        <definition>virtual fsqmat::~fsqmat</definition>
301        <argsstring>()</argsstring>
302        <name>~fsqmat</name>
303        <briefdescription>
304<para>Destructor for future use;. </para>        </briefdescription>
305        <detaileddescription>
306        </detaileddescription>
307        <inbodydescription>
308        </inbodydescription>
309        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="136" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="136" bodyend="136"/>
310      </memberdef>
311      <memberdef kind="function" id="classfsqmat_19fa853e1ca28f2a1a1c43377e798ecb1" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
312        <type>void</type>
313        <definition>void fsqmat::inv</definition>
314        <argsstring>(fsqmat &amp;Inv)</argsstring>
315        <name>inv</name>
316        <param>
317          <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
318          <declname>Inv</declname>
319        </param>
320        <briefdescription>
321<para>Matrix inversion preserving the chosen form. </para>        </briefdescription>
322        <detaileddescription>
323<para><parameterlist kind="param"><parameteritem>
324<parameternamelist>
325<parametername>Inv</parametername>
326</parameternamelist>
327<parameterdescription>
328<para>a space where the inverse is stored. </para></parameterdescription>
329</parameteritem>
330</parameterlist>
331</para>        </detaileddescription>
332        <inbodydescription>
333        </inbodydescription>
334        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="144" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="14" bodyend="14"/>
335        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
336        <referencedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7" compoundref="libKF_8h" startline="364" endline="396">EKF&lt; sq_T &gt;::bayes</referencedby>
337      </memberdef>
338      <memberdef kind="function" id="classfsqmat_1eb0d1358f536e4453b5f99d0418ca1e5" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
339        <type>double</type>
340        <definition>double fsqmat::logdet</definition>
341        <argsstring>() const </argsstring>
342        <name>logdet</name>
343        <reimplements refid="classsqmat_10a772b396750eeeed85d69fa72478b45">logdet</reimplements>
344        <briefdescription>
345<para>Logarithm of a determinant. </para>        </briefdescription>
346        <detaileddescription>
347        </detaileddescription>
348        <inbodydescription>
349        </inbodydescription>
350        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="146" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="146" bodyend="146"/>
351        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
352      </memberdef>
353      <memberdef kind="function" id="classfsqmat_1a6c91b0389e73404324b2314b08d6e87" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
354        <type>double</type>
355        <definition>double fsqmat::qform</definition>
356        <argsstring>(const vec &amp;v) const </argsstring>
357        <name>qform</name>
358        <reimplements refid="classsqmat_1fc026312eb02ba09f85d5aacd6f05ab3">qform</reimplements>
359        <param>
360          <type>const vec &amp;</type>
361          <declname>v</declname>
362        </param>
363        <briefdescription>
364<para>Evaluates quadratic form <formula id="29">$x= v&apos;*V*v$</formula>;. </para>        </briefdescription>
365        <detaileddescription>
366        </detaileddescription>
367        <inbodydescription>
368        </inbodydescription>
369        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="147" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="147" bodyend="147"/>
370        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
371      </memberdef>
372      <memberdef kind="function" id="classfsqmat_158075da64ddadd4df40654c35b928c6f" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
373        <type>double</type>
374        <definition>double fsqmat::invqform</definition>
375        <argsstring>(const vec &amp;v) const </argsstring>
376        <name>invqform</name>
377        <reimplements refid="classsqmat_16230e8e8a9341866aaa0ce008691aac2">invqform</reimplements>
378        <param>
379          <type>const vec &amp;</type>
380          <declname>v</declname>
381        </param>
382        <briefdescription>
383<para>Evaluates quadratic form <formula id="30">$x= v&apos;*inv(V)*v$</formula>;. </para>        </briefdescription>
384        <detaileddescription>
385        </detaileddescription>
386        <inbodydescription>
387        </inbodydescription>
388        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="148" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="148" bodyend="148"/>
389        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
390      </memberdef>
391      <memberdef kind="function" id="classfsqmat_1842a774077ee34ac3c36d180ab33e103" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
392        <type>vec</type>
393        <definition>vec fsqmat::sqrt_mult</definition>
394        <argsstring>(const vec &amp;v) const </argsstring>
395        <name>sqrt_mult</name>
396        <reimplements refid="classsqmat_16b79438b5d7544a9c8e110a145355d8f">sqrt_mult</reimplements>
397        <param>
398          <type>const vec &amp;</type>
399          <declname>v</declname>
400        </param>
401        <briefdescription>
402<para>Multiplies square root of <formula id="27">$V$</formula> by vector <formula id="28">$x$</formula>. </para>        </briefdescription>
403        <detaileddescription>
404<para>Used e.g. in generating normal samples. </para>        </detaileddescription>
405        <inbodydescription>
406        </inbodydescription>
407        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="149" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="149" bodyend="149"/>
408        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
409      </memberdef>
410      <memberdef kind="function" id="classfsqmat_1a2e0bf7dbbbbe1d3358064c4ad455f1f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
411        <type>void</type>
412        <definition>void fsqmat::add</definition>
413        <argsstring>(const fsqmat &amp;fsq2, double w=1.0)</argsstring>
414        <name>add</name>
415        <param>
416          <type>const <ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
417          <declname>fsq2</declname>
418        </param>
419        <param>
420          <type>double</type>
421          <declname>w</declname>
422          <defval>1.0</defval>
423        </param>
424        <briefdescription>
425<para>Add another matrix in fsq form with weight w. </para>        </briefdescription>
426        <detaileddescription>
427        </detaileddescription>
428        <inbodydescription>
429        </inbodydescription>
430        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="152" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="152" bodyend="152"/>
431        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
432      </memberdef>
433      <memberdef kind="function" id="classfsqmat_1922f8190c13987cbcdb33ec2bf5cf105" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
434        <type>void</type>
435        <definition>void fsqmat::setD</definition>
436        <argsstring>(const vec &amp;nD)</argsstring>
437        <name>setD</name>
438        <param>
439          <type>const vec &amp;</type>
440          <declname>nD</declname>
441        </param>
442        <briefdescription>
443<para>Access functions. </para>        </briefdescription>
444        <detaileddescription>
445        </detaileddescription>
446        <inbodydescription>
447        </inbodydescription>
448        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="155" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="155" bodyend="155"/>
449        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
450      </memberdef>
451      <memberdef kind="function" id="classfsqmat_1bcf837b2956745e8986044f5600dbd6e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
452        <type>vec</type>
453        <definition>vec fsqmat::getD</definition>
454        <argsstring>()</argsstring>
455        <name>getD</name>
456        <briefdescription>
457<para>Access functions. </para>        </briefdescription>
458        <detaileddescription>
459        </detaileddescription>
460        <inbodydescription>
461        </inbodydescription>
462        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="157" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="157" bodyend="157"/>
463        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
464      </memberdef>
465      <memberdef kind="function" id="classfsqmat_103a8f49eb4d38a054ecc522be59cd2ad" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
466        <type>void</type>
467        <definition>void fsqmat::setD</definition>
468        <argsstring>(const vec &amp;nD, int i)</argsstring>
469        <name>setD</name>
470        <param>
471          <type>const vec &amp;</type>
472          <declname>nD</declname>
473        </param>
474        <param>
475          <type>int</type>
476          <declname>i</declname>
477        </param>
478        <briefdescription>
479<para>Access functions. </para>        </briefdescription>
480        <detaileddescription>
481        </detaileddescription>
482        <inbodydescription>
483        </inbodydescription>
484        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="159" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="159" bodyend="159"/>
485        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
486      </memberdef>
487      <memberdef kind="function" id="classfsqmat_1514d1fdd8a382dbd6a774f2cf1ebd3de" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
488        <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
489        <definition>fsqmat&amp; fsqmat::operator+=</definition>
490        <argsstring>(const fsqmat &amp;A)</argsstring>
491        <name>operator+=</name>
492        <param>
493          <type>const <ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
494          <declname>A</declname>
495        </param>
496        <briefdescription>
497<para>add another <ref refid="classfsqmat" kindref="compound">fsqmat</ref> matrix </para>        </briefdescription>
498        <detaileddescription>
499        </detaileddescription>
500        <inbodydescription>
501        </inbodydescription>
502        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="163" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="163" bodyend="163"/>
503        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
504      </memberdef>
505      <memberdef kind="function" id="classfsqmat_1e976bc9d899961e1d2087b0630ed33b7" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
506        <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
507        <definition>fsqmat&amp; fsqmat::operator-=</definition>
508        <argsstring>(const fsqmat &amp;A)</argsstring>
509        <name>operator-=</name>
510        <param>
511          <type>const <ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
512          <declname>A</declname>
513        </param>
514        <briefdescription>
515<para>subtrack another <ref refid="classfsqmat" kindref="compound">fsqmat</ref> matrix </para>        </briefdescription>
516        <detaileddescription>
517        </detaileddescription>
518        <inbodydescription>
519        </inbodydescription>
520        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="165" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="165" bodyend="165"/>
521        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
522      </memberdef>
523      <memberdef kind="function" id="classfsqmat_1af800e7b2146da5e60897255dde80059" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
524        <type><ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
525        <definition>fsqmat&amp; fsqmat::operator*=</definition>
526        <argsstring>(double x)</argsstring>
527        <name>operator*=</name>
528        <param>
529          <type>double</type>
530          <declname>x</declname>
531        </param>
532        <briefdescription>
533<para>multiply by a scalar </para>        </briefdescription>
534        <detaileddescription>
535        </detaileddescription>
536        <inbodydescription>
537        </inbodydescription>
538        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="167" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="167" bodyend="167"/>
539        <references refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" compoundref="libDC_8h" startline="114">M</references>
540      </memberdef>
541      <memberdef kind="function" id="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
542        <type>int</type>
543        <definition>int sqmat::cols</definition>
544        <argsstring>() const </argsstring>
545        <name>cols</name>
546        <reimplementedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306">cols</reimplementedby>
547        <briefdescription>
548<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
549        <detaileddescription>
550        </detaileddescription>
551        <inbodydescription>
552        </inbodydescription>
553        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="91" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="91" bodyend="91"/>
554        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">sqmat::dim</references>
555      </memberdef>
556      <memberdef kind="function" id="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
557        <type>int</type>
558        <definition>int sqmat::rows</definition>
559        <argsstring>() const </argsstring>
560        <name>rows</name>
561        <reimplementedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163">rows</reimplementedby>
562        <briefdescription>
563<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
564        <detaileddescription>
565        </detaileddescription>
566        <inbodydescription>
567        </inbodydescription>
568        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="94" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="94" bodyend="94"/>
569        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">sqmat::dim</references>
570      </memberdef>
571      </sectiondef>
572      <sectiondef kind="friend">
573      <memberdef kind="friend" id="classfsqmat_1e06aba54d61e807b41bd68b5ee6ac22f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
574        <type>friend std::ostream &amp;</type>
575        <definition>std::ostream&amp; operator&lt;&lt;</definition>
576        <argsstring>(std::ostream &amp;os, const fsqmat &amp;sq)</argsstring>
577        <name>operator&lt;&lt;</name>
578        <param>
579          <type>std::ostream &amp;</type>
580          <declname>os</declname>
581        </param>
582        <param>
583          <type>const <ref refid="classfsqmat" kindref="compound">fsqmat</ref> &amp;</type>
584          <declname>sq</declname>
585        </param>
586        <briefdescription>
587<para>print full matrix </para>        </briefdescription>
588        <detaileddescription>
589        </detaileddescription>
590        <inbodydescription>
591        </inbodydescription>
592        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="170" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.cpp" bodystart="26" bodyend="29"/>
593      </memberdef>
594      </sectiondef>
595    <briefdescription>
596<para>Fake <ref refid="classsqmat" kindref="compound">sqmat</ref>. This class maps <ref refid="classsqmat" kindref="compound">sqmat</ref> operations to operations on full matrix. </para>    </briefdescription>
597    <detaileddescription>
598<para>This class can be used to compare performance of algorithms using decomposed matrices with perormance of the same algorithms using full matrices; </para>    </detaileddescription>
599    <inheritancegraph>
600      <node id="1039">
601        <label>fsqmat</label>
602        <link refid="classfsqmat"/>
603        <childnode refid="1040" relation="public-inheritance">
604        </childnode>
605      </node>
606      <node id="1040">
607        <label>sqmat</label>
608        <link refid="classsqmat"/>
609      </node>
610    </inheritancegraph>
611    <collaborationgraph>
612      <node id="1041">
613        <label>fsqmat</label>
614        <link refid="classfsqmat"/>
615        <childnode refid="1042" relation="public-inheritance">
616        </childnode>
617      </node>
618      <node id="1042">
619        <label>sqmat</label>
620        <link refid="classsqmat"/>
621      </node>
622    </collaborationgraph>
623    <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="111" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="110" bodyend="172"/>
624    <listofallmembers>
625      <member refid="classfsqmat_1a2e0bf7dbbbbe1d3358064c4ad455f1f" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>add</name></member>
626      <member refid="classfsqmat_1cfa4c359483d2322f32d1d50050f8ac4" prot="public" virt="virtual"><scope>fsqmat</scope><name>clear</name></member>
627      <member refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>cols</name></member>
628      <member refid="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" virt="non-virtual"><scope>fsqmat</scope><name>dim</name></member>
629      <member refid="classfsqmat_179e3f73e0ccd663c7f7e08083d272940" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>fsqmat</name></member>
630      <member refid="classfsqmat_140eae99305e7c7240fa95cfec125b06f" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>fsqmat</name></member>
631      <member refid="classfsqmat_11929fbc9fe375f1d67f979d0d302336f" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>fsqmat</name></member>
632      <member refid="classfsqmat_1c01f3e9bb590f2a2921369d672f3ce1e" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>fsqmat</name></member>
633      <member refid="classfsqmat_1bcf837b2956745e8986044f5600dbd6e" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>getD</name></member>
634      <member refid="classfsqmat_19fa853e1ca28f2a1a1c43377e798ecb1" prot="public" virt="virtual"><scope>fsqmat</scope><name>inv</name></member>
635      <member refid="classfsqmat_158075da64ddadd4df40654c35b928c6f" prot="public" virt="virtual"><scope>fsqmat</scope><name>invqform</name></member>
636      <member refid="classfsqmat_1eb0d1358f536e4453b5f99d0418ca1e5" prot="public" virt="virtual"><scope>fsqmat</scope><name>logdet</name></member>
637      <member refid="classfsqmat_1a7a1fcb9aae19d1e4daddfc9c22ce453" prot="protected" virt="non-virtual"><scope>fsqmat</scope><name>M</name></member>
638      <member refid="classfsqmat_15530d2756b5d991de755e6121c9a452e" prot="public" virt="virtual"><scope>fsqmat</scope><name>mult_sym</name></member>
639      <member refid="classfsqmat_1d4eddc3743c8865cc5ed92d14de0e3e3" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>mult_sym</name></member>
640      <member refid="classfsqmat_192052a8adc2054b63e42d1373d145c89" prot="public" virt="virtual"><scope>fsqmat</scope><name>mult_sym_t</name></member>
641      <member refid="classfsqmat_1ae4949ad2a32553c7fa04d6d1483770a" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>mult_sym_t</name></member>
642      <member refid="classfsqmat_1af800e7b2146da5e60897255dde80059" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>operator*=</name></member>
643      <member refid="classfsqmat_1514d1fdd8a382dbd6a774f2cf1ebd3de" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>operator+=</name></member>
644      <member refid="classfsqmat_1e976bc9d899961e1d2087b0630ed33b7" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>operator-=</name></member>
645      <member refid="classfsqmat_1e06aba54d61e807b41bd68b5ee6ac22f" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>operator&lt;&lt;</name></member>
646      <member refid="classfsqmat_1b36530e155667fe9f1bd58394e50c65a" prot="public" virt="virtual"><scope>fsqmat</scope><name>opupdt</name></member>
647      <member refid="classfsqmat_1a6c91b0389e73404324b2314b08d6e87" prot="public" virt="virtual"><scope>fsqmat</scope><name>qform</name></member>
648      <member refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>rows</name></member>
649      <member refid="classfsqmat_1922f8190c13987cbcdb33ec2bf5cf105" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>setD</name></member>
650      <member refid="classfsqmat_103a8f49eb4d38a054ecc522be59cd2ad" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>setD</name></member>
651      <member refid="classsqmat_14268750c040c716b2c05037f725078a2" prot="public" virt="non-virtual"><scope>fsqmat</scope><name>sqmat</name></member>
652      <member refid="classfsqmat_1842a774077ee34ac3c36d180ab33e103" prot="public" virt="virtual"><scope>fsqmat</scope><name>sqrt_mult</name></member>
653      <member refid="classfsqmat_1cedf4f048309056f4262c930914dfda8" prot="public" virt="virtual"><scope>fsqmat</scope><name>to_mat</name></member>
654      <member refid="classfsqmat_12a8f104e4befbc2aa90d8b11edfedb2e" prot="public" virt="virtual"><scope>fsqmat</scope><name>~fsqmat</name></member>
655      <member refid="classsqmat_10481f2067bb32aaea7e6d4f27e46b656" prot="public" virt="virtual"><scope>fsqmat</scope><name>~sqmat</name></member>
656    </listofallmembers>
657  </compounddef>
658</doxygen>
Note: See TracBrowser for help on using the browser.