root/doc/xml/classchmat.xml @ 235

Revision 187, 36.9 kB (checked in by smidl, 16 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="classchmat" kind="class" prot="public">
4    <compoundname>chmat</compoundname>
5    <basecompoundref refid="classsqmat" prot="public" virt="non-virtual">sqmat</basecompoundref>
6    <includes refid="chmat_8h" local="no">chmat.h</includes>
7      <sectiondef kind="protected-attrib">
8      <memberdef kind="variable" id="classchmat_195158bb150f5e7f939168abcd577fd9c" prot="protected" static="no" mutable="no">
9        <type>mat</type>
10        <definition>mat chmat::Ch</definition>
11        <argsstring></argsstring>
12        <name>Ch</name>
13        <briefdescription>
14<para>Upper triangle of the cholesky matrix. </para>        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="30" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="30" bodyend="-1"/>
20        <referencedby refid="classchmat_19c50d31c999d85d8e9d8cf2b69b6ac8c" compoundref="chmat_8h" startline="66" endline="66">_Ch</referencedby>
21        <referencedby refid="classchmat_1d92f3bd9a727b8c88a8c7385feb3449a" compoundref="chmat_8h" startline="58" endline="58">chmat</referencedby>
22        <referencedby refid="classchmat_1d0a995d312ecc11d3b43693f5e224ba9" compoundref="chmat_8cpp" startline="46" endline="46">clear</referencedby>
23        <referencedby refid="classchmat_15ce4e21a9012a4e98c1f0ed1ca5669bd" compoundref="chmat_8h" startline="47" endline="47">inv</referencedby>
24        <referencedby refid="classchmat_1b49427cff186c62f5df3724e5d2c34b4" compoundref="chmat_8cpp" startline="41" endline="45">invqform</referencedby>
25        <referencedby refid="classchmat_1b504ca818203b13e667cb3c503980382" compoundref="chmat_8cpp" startline="32" endline="37">logdet</referencedby>
26        <referencedby refid="classchmat_1bbc2d98d7455b1f38828907d442836bf" compoundref="chmat_8cpp" startline="9" endline="18">opupdt</referencedby>
27        <referencedby refid="classchmat_16807737c7ffdb7041256b51db7592248" compoundref="chmat_8cpp" startline="40" endline="40">qform</referencedby>
28        <referencedby refid="classchmat_1a4fc7f9b0539b97c414442a22f3db6e8" compoundref="chmat_8h" startline="68" endline="68">setD</referencedby>
29        <referencedby refid="classchmat_1b22aa239dbaca33e3fb93b4f674d7051" compoundref="chmat_8cpp" startline="39" endline="39">sqrt_mult</referencedby>
30        <referencedby refid="classchmat_1a37e2c726e4fc3ad50b26ac2ca6c1452" compoundref="chmat_8cpp" startline="19" endline="19">to_mat</referencedby>
31      </memberdef>
32      <memberdef kind="variable" id="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" static="no" mutable="no">
33        <type>int</type>
34        <definition>int sqmat::dim</definition>
35        <argsstring></argsstring>
36        <name>dim</name>
37        <briefdescription>
38<para>dimension of the square matrix </para>        </briefdescription>
39        <detaileddescription>
40        </detaileddescription>
41        <inbodydescription>
42        </inbodydescription>
43        <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"/>
44        <referencedby refid="classldmat_1a60f2c7e4f3c6a7738eaaaab81ffad20" compoundref="libDC_8cpp" startline="104" endline="114">ldmat::add</referencedby>
45        <referencedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306" compoundref="libDC_8h" startline="277" endline="277">ldmat::cols</referencedby>
46        <referencedby refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" compoundref="libDC_8h" startline="91" endline="91">sqmat::cols</referencedby>
47        <referencedby refid="classldmat_1f291faa073e7bc8dfafc7ae93daa2506" compoundref="libDC_8cpp" startline="203" endline="297">ldmat::ldform</referencedby>
48        <referencedby refid="classldmat_1abe16e0f86668ef61a9a4896c8565dee" compoundref="libDC_8cpp" startline="41" endline="44">ldmat::ldmat</referencedby>
49        <referencedby refid="libDC_8h_16715d039e6d5d97005cf9e2522dfa474" compoundref="libDC_8cpp" startline="301" endline="320">ltuinv</referencedby>
50        <referencedby refid="classldmat_10f0f6e083e6d947cf58097ffce3ccd1a" compoundref="libDC_8cpp" startline="58" endline="72">ldmat::opupdt</referencedby>
51        <referencedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163" compoundref="libDC_8h" startline="279" endline="279">ldmat::rows</referencedby>
52        <referencedby refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" compoundref="libDC_8h" startline="94" endline="94">sqmat::rows</referencedby>
53        <referencedby refid="classldmat_1fc380626ced6f9244fb58c5f0231174d" compoundref="libDC_8cpp" startline="189" endline="201">ldmat::sqrt_mult</referencedby>
54        <referencedby refid="classldmat_15b0515da8dc2293d9e4360b74cc26c9e" compoundref="libDC_8cpp" startline="80" endline="101">ldmat::to_mat</referencedby>
55      </memberdef>
56      </sectiondef>
57      <sectiondef kind="public-func">
58      <memberdef kind="function" id="classchmat_1bbc2d98d7455b1f38828907d442836bf" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
59        <type>void</type>
60        <definition>void chmat::opupdt</definition>
61        <argsstring>(const vec &amp;v, double w)</argsstring>
62        <name>opupdt</name>
63        <reimplements refid="classsqmat_1b223484796661f2dadb5607a86ce0581">opupdt</reimplements>
64        <param>
65          <type>const vec &amp;</type>
66          <declname>v</declname>
67        </param>
68        <param>
69          <type>double</type>
70          <declname>w</declname>
71        </param>
72        <briefdescription>
73        </briefdescription>
74        <detaileddescription>
75<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>
76<parameternamelist>
77<parametername>v</parametername>
78</parameternamelist>
79<parameterdescription>
80<para>Vector forming the outer product to be added </para></parameterdescription>
81</parameteritem>
82<parameteritem>
83<parameternamelist>
84<parametername>w</parametername>
85</parameternamelist>
86<parameterdescription>
87<para>weight of updating; can be negative</para></parameterdescription>
88</parameteritem>
89</parameterlist>
90BLAS-2b operation. </para>        </detaileddescription>
91        <inbodydescription>
92        </inbodydescription>
93        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="33" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="9" bodyend="18"/>
94        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
95      </memberdef>
96      <memberdef kind="function" id="classchmat_1a37e2c726e4fc3ad50b26ac2ca6c1452" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
97        <type>mat</type>
98        <definition>mat chmat::to_mat</definition>
99        <argsstring>()</argsstring>
100        <name>to_mat</name>
101        <reimplements refid="classsqmat_19a5b6fddfeb42339e1dc9b978a2590fc">to_mat</reimplements>
102        <briefdescription>
103<para>Conversion to full matrix. </para>        </briefdescription>
104        <detaileddescription>
105        </detaileddescription>
106        <inbodydescription>
107        </inbodydescription>
108        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="34" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="19" bodyend="19"/>
109        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
110        <referencedby refid="classEKFCh_196f6edda324a0b7ef8b4e86cc7af60c1" compoundref="libKF_8cpp" startline="189" endline="236">EKFCh::bayes</referencedby>
111        <referencedby refid="classKalmanCh_1cca758192846940409822b9bd778d4e1" compoundref="libKF_8cpp" startline="128" endline="162">KalmanCh::bayes</referencedby>
112      </memberdef>
113      <memberdef kind="function" id="classchmat_166f509f92b0ccf020e2a2a32566e0777" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
114        <type>void</type>
115        <definition>void chmat::mult_sym</definition>
116        <argsstring>(const mat &amp;C)</argsstring>
117        <name>mult_sym</name>
118        <reimplements refid="classsqmat_160fbbfa9e483b8187c135f787ee53afa">mult_sym</reimplements>
119        <param>
120          <type>const mat &amp;</type>
121          <declname>C</declname>
122        </param>
123        <briefdescription>
124<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>
125        <detaileddescription>
126<para><parameterlist kind="param"><parameteritem>
127<parameternamelist>
128<parametername>C</parametername>
129</parameternamelist>
130<parameterdescription>
131<para>multiplying matrix, </para></parameterdescription>
132</parameteritem>
133</parameterlist>
134</para>        </detaileddescription>
135        <inbodydescription>
136        </inbodydescription>
137        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="35" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="20" bodyend="22"/>
138      </memberdef>
139      <memberdef kind="function" id="classchmat_1d558ab63475a2f2ebc0c0e149796dcc6" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
140        <type>void</type>
141        <definition>void chmat::mult_sym</definition>
142        <argsstring>(const mat &amp;C, chmat &amp;U) const </argsstring>
143        <name>mult_sym</name>
144        <param>
145          <type>const mat &amp;</type>
146          <declname>C</declname>
147        </param>
148        <param>
149          <type><ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
150          <declname>U</declname>
151        </param>
152        <briefdescription>
153        </briefdescription>
154        <detaileddescription>
155        </detaileddescription>
156        <inbodydescription>
157        </inbodydescription>
158        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="36" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="23" bodyend="25"/>
159      </memberdef>
160      <memberdef kind="function" id="classchmat_107f50d1332b901eee962e8b1913102f7" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
161        <type>void</type>
162        <definition>void chmat::mult_sym_t</definition>
163        <argsstring>(const mat &amp;C)</argsstring>
164        <name>mult_sym_t</name>
165        <reimplements refid="classsqmat_16909e906da17725b1b80f3cae7cf3325">mult_sym_t</reimplements>
166        <param>
167          <type>const mat &amp;</type>
168          <declname>C</declname>
169        </param>
170        <briefdescription>
171<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>
172        <detaileddescription>
173<para><parameterlist kind="param"><parameteritem>
174<parameternamelist>
175<parametername>C</parametername>
176</parameternamelist>
177<parameterdescription>
178<para>multiplying matrix, </para></parameterdescription>
179</parameteritem>
180</parameterlist>
181</para>        </detaileddescription>
182        <inbodydescription>
183        </inbodydescription>
184        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="37" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="26" bodyend="28"/>
185      </memberdef>
186      <memberdef kind="function" id="classchmat_131c3b985214a150b2a6b4be3b0fd40e3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
187        <type>void</type>
188        <definition>void chmat::mult_sym_t</definition>
189        <argsstring>(const mat &amp;C, chmat &amp;U) const </argsstring>
190        <name>mult_sym_t</name>
191        <param>
192          <type>const mat &amp;</type>
193          <declname>C</declname>
194        </param>
195        <param>
196          <type><ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
197          <declname>U</declname>
198        </param>
199        <briefdescription>
200        </briefdescription>
201        <detaileddescription>
202        </detaileddescription>
203        <inbodydescription>
204        </inbodydescription>
205        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="38" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="29" bodyend="31"/>
206      </memberdef>
207      <memberdef kind="function" id="classchmat_1b504ca818203b13e667cb3c503980382" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
208        <type>double</type>
209        <definition>double chmat::logdet</definition>
210        <argsstring>() const </argsstring>
211        <name>logdet</name>
212        <reimplements refid="classsqmat_10a772b396750eeeed85d69fa72478b45">logdet</reimplements>
213        <briefdescription>
214<para>Logarithm of a determinant. </para>        </briefdescription>
215        <detaileddescription>
216        </detaileddescription>
217        <inbodydescription>
218        </inbodydescription>
219        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="39" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="32" bodyend="37"/>
220        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
221      </memberdef>
222      <memberdef kind="function" id="classchmat_1b22aa239dbaca33e3fb93b4f674d7051" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
223        <type>vec</type>
224        <definition>vec chmat::sqrt_mult</definition>
225        <argsstring>(const vec &amp;v) const </argsstring>
226        <name>sqrt_mult</name>
227        <reimplements refid="classsqmat_16b79438b5d7544a9c8e110a145355d8f">sqrt_mult</reimplements>
228        <param>
229          <type>const vec &amp;</type>
230          <declname>v</declname>
231        </param>
232        <briefdescription>
233<para>Multiplies square root of <formula id="27">$V$</formula> by vector <formula id="28">$x$</formula>. </para>        </briefdescription>
234        <detaileddescription>
235<para>Used e.g. in generating normal samples. </para>        </detaileddescription>
236        <inbodydescription>
237        </inbodydescription>
238        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="40" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="39" bodyend="39"/>
239        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
240      </memberdef>
241      <memberdef kind="function" id="classchmat_16807737c7ffdb7041256b51db7592248" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
242        <type>double</type>
243        <definition>double chmat::qform</definition>
244        <argsstring>(const vec &amp;v) const </argsstring>
245        <name>qform</name>
246        <reimplements refid="classsqmat_1fc026312eb02ba09f85d5aacd6f05ab3">qform</reimplements>
247        <param>
248          <type>const vec &amp;</type>
249          <declname>v</declname>
250        </param>
251        <briefdescription>
252<para>Evaluates quadratic form <formula id="29">$x= v&apos;*V*v$</formula>;. </para>        </briefdescription>
253        <detaileddescription>
254        </detaileddescription>
255        <inbodydescription>
256        </inbodydescription>
257        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="41" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="40" bodyend="40"/>
258        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
259      </memberdef>
260      <memberdef kind="function" id="classchmat_1b49427cff186c62f5df3724e5d2c34b4" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
261        <type>double</type>
262        <definition>double chmat::invqform</definition>
263        <argsstring>(const vec &amp;v) const </argsstring>
264        <name>invqform</name>
265        <reimplements refid="classsqmat_16230e8e8a9341866aaa0ce008691aac2">invqform</reimplements>
266        <param>
267          <type>const vec &amp;</type>
268          <declname>v</declname>
269        </param>
270        <briefdescription>
271<para>Evaluates quadratic form <formula id="30">$x= v&apos;*inv(V)*v$</formula>;. </para>        </briefdescription>
272        <detaileddescription>
273        </detaileddescription>
274        <inbodydescription>
275        </inbodydescription>
276        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="42" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="41" bodyend="45"/>
277        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
278      </memberdef>
279      <memberdef kind="function" id="classchmat_1d0a995d312ecc11d3b43693f5e224ba9" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
280        <type>void</type>
281        <definition>void chmat::clear</definition>
282        <argsstring>()</argsstring>
283        <name>clear</name>
284        <reimplements refid="classsqmat_16fca246f9eabbdeb8cac03030e826b5e">clear</reimplements>
285        <briefdescription>
286<para>Clearing matrix so that it corresponds to zeros. </para>        </briefdescription>
287        <detaileddescription>
288        </detaileddescription>
289        <inbodydescription>
290        </inbodydescription>
291        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="43" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.cpp" bodystart="46" bodyend="46"/>
292        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
293      </memberdef>
294      <memberdef kind="function" id="classchmat_1f3921e3e5e31337cdbda40a3a5467257" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
295        <type>void</type>
296        <definition>void chmat::add</definition>
297        <argsstring>(const chmat &amp;A2, double w=1.0)</argsstring>
298        <name>add</name>
299        <param>
300          <type>const <ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
301          <declname>A2</declname>
302        </param>
303        <param>
304          <type>double</type>
305          <declname>w</declname>
306          <defval>1.0</defval>
307        </param>
308        <briefdescription>
309<para>add another <ref refid="classchmat" kindref="compound">chmat</ref> <computeroutput>A2</computeroutput> with weight <computeroutput>w</computeroutput>. </para>        </briefdescription>
310        <detaileddescription>
311        </detaileddescription>
312        <inbodydescription>
313        </inbodydescription>
314        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="45" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="45" bodyend="45"/>
315      </memberdef>
316      <memberdef kind="function" id="classchmat_15ce4e21a9012a4e98c1f0ed1ca5669bd" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
317        <type>void</type>
318        <definition>void chmat::inv</definition>
319        <argsstring>(chmat &amp;Inv) const </argsstring>
320        <name>inv</name>
321        <param>
322          <type><ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
323          <declname>Inv</declname>
324        </param>
325        <briefdescription>
326<para>Inversion in the same form, i.e. cholesky. </para>        </briefdescription>
327        <detaileddescription>
328        </detaileddescription>
329        <inbodydescription>
330        </inbodydescription>
331        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="47" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="47" bodyend="47"/>
332        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
333      </memberdef>
334      <memberdef kind="function" id="classchmat_1ba62fbf7cb8e065a4f3d24457824e89b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
335        <type></type>
336        <definition>virtual chmat::~chmat</definition>
337        <argsstring>()</argsstring>
338        <name>~chmat</name>
339        <briefdescription>
340<para>Destructor for future use;. </para>        </briefdescription>
341        <detaileddescription>
342        </detaileddescription>
343        <inbodydescription>
344        </inbodydescription>
345        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="52" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="52" bodyend="52"/>
346      </memberdef>
347      <memberdef kind="function" id="classchmat_1fdd73b0c596161637fd25bdf2c670c39" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
348        <type></type>
349        <definition>chmat::chmat</definition>
350        <argsstring>(const int dim0)</argsstring>
351        <name>chmat</name>
352        <param>
353          <type>const int</type>
354          <declname>dim0</declname>
355        </param>
356        <briefdescription>
357<para>Default constructor. </para>        </briefdescription>
358        <detaileddescription>
359        </detaileddescription>
360        <inbodydescription>
361        </inbodydescription>
362        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="54" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="54" bodyend="54"/>
363      </memberdef>
364      <memberdef kind="function" id="classchmat_1d4f0a94e81279295e60e72812130f9d4" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
365        <type></type>
366        <definition>chmat::chmat</definition>
367        <argsstring>(const vec &amp;v)</argsstring>
368        <name>chmat</name>
369        <param>
370          <type>const vec &amp;</type>
371          <declname>v</declname>
372        </param>
373        <briefdescription>
374<para>Default constructor. </para>        </briefdescription>
375        <detaileddescription>
376        </detaileddescription>
377        <inbodydescription>
378        </inbodydescription>
379        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="56" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="56" bodyend="56"/>
380      </memberdef>
381      <memberdef kind="function" id="classchmat_1d92f3bd9a727b8c88a8c7385feb3449a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
382        <type></type>
383        <definition>chmat::chmat</definition>
384        <argsstring>(const chmat &amp;Ch0)</argsstring>
385        <name>chmat</name>
386        <param>
387          <type>const <ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
388          <declname>Ch0</declname>
389        </param>
390        <briefdescription>
391<para>Copy constructor. </para>        </briefdescription>
392        <detaileddescription>
393        </detaileddescription>
394        <inbodydescription>
395        </inbodydescription>
396        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="58" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="58" bodyend="58"/>
397        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
398      </memberdef>
399      <memberdef kind="function" id="classchmat_18334a00f30f0a05f893c2aeec395ef10" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
400        <type></type>
401        <definition>chmat::chmat</definition>
402        <argsstring>(const mat &amp;M)</argsstring>
403        <name>chmat</name>
404        <param>
405          <type>const mat &amp;</type>
406          <declname>M</declname>
407        </param>
408        <briefdescription>
409<para>Default constructor (m3k:cholform). </para>        </briefdescription>
410        <detaileddescription>
411        </detaileddescription>
412        <inbodydescription>
413        </inbodydescription>
414        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="60" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="60" bodyend="64"/>
415        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
416      </memberdef>
417      <memberdef kind="function" id="classchmat_19c50d31c999d85d8e9d8cf2b69b6ac8c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
418        <type>mat &amp;</type>
419        <definition>mat&amp; chmat::_Ch</definition>
420        <argsstring>()</argsstring>
421        <name>_Ch</name>
422        <briefdescription>
423<para>Access function. </para>        </briefdescription>
424        <detaileddescription>
425        </detaileddescription>
426        <inbodydescription>
427        </inbodydescription>
428        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="66" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="66" bodyend="66"/>
429        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
430        <referencedby refid="classEKFCh_196f6edda324a0b7ef8b4e86cc7af60c1" compoundref="libKF_8cpp" startline="189" endline="236">EKFCh::bayes</referencedby>
431        <referencedby refid="classKalmanCh_1cca758192846940409822b9bd778d4e1" compoundref="libKF_8cpp" startline="128" endline="162">KalmanCh::bayes</referencedby>
432        <referencedby refid="classEKF__unQ_1cd06a8c662da244cf61bb5bd39688c99" compoundref="pmsm__sim_8cpp" startline="27" endline="31">EKF_unQ::condition</referencedby>
433        <referencedby refid="classEKFCh_10216bed270df59fe65d0d62d41f8257c" compoundref="libKF_8cpp" startline="167" endline="186">EKFCh::set_parameters</referencedby>
434        <referencedby refid="classKalmanCh_192fb227287af05c9f0078d523c7c9793" compoundref="libKF_8cpp" startline="118" endline="125">KalmanCh::set_parameters</referencedby>
435      </memberdef>
436      <memberdef kind="function" id="classchmat_1a4fc7f9b0539b97c414442a22f3db6e8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
437        <type>void</type>
438        <definition>void chmat::setD</definition>
439        <argsstring>(const vec &amp;nD)</argsstring>
440        <name>setD</name>
441        <param>
442          <type>const vec &amp;</type>
443          <declname>nD</declname>
444        </param>
445        <briefdescription>
446<para>Access functions. </para>        </briefdescription>
447        <detaileddescription>
448        </detaileddescription>
449        <inbodydescription>
450        </inbodydescription>
451        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="68" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="68" bodyend="68"/>
452        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
453        <referencedby refid="classEKF__unQ_1cd06a8c662da244cf61bb5bd39688c99" compoundref="pmsm__sim_8cpp" startline="27" endline="31">EKF_unQ::condition</referencedby>
454      </memberdef>
455      <memberdef kind="function" id="classchmat_14b9271097d8317d9514c5d0d62cccb39" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
456        <type>void</type>
457        <definition>void chmat::setD</definition>
458        <argsstring>(const vec &amp;nD, int i)</argsstring>
459        <name>setD</name>
460        <param>
461          <type>const vec &amp;</type>
462          <declname>nD</declname>
463        </param>
464        <param>
465          <type>int</type>
466          <declname>i</declname>
467        </param>
468        <briefdescription>
469<para>Access functions. </para>        </briefdescription>
470        <detaileddescription>
471        </detaileddescription>
472        <inbodydescription>
473        </inbodydescription>
474        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="70" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="70" bodyend="70"/>
475        <references refid="classchmat_195158bb150f5e7f939168abcd577fd9c" compoundref="chmat_8h" startline="30">Ch</references>
476      </memberdef>
477      <memberdef kind="function" id="classchmat_16a8b39fe3a28d2c8e3fc0d74141229fb" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
478        <type><ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
479        <definition>chmat &amp; chmat::operator+=</definition>
480        <argsstring>(const chmat &amp;A2)</argsstring>
481        <name>operator+=</name>
482        <param>
483          <type>const <ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
484          <declname>A2</declname>
485        </param>
486        <briefdescription>
487<para>Operators. </para>        </briefdescription>
488        <detaileddescription>
489<para>Operations: mapping of add operation to operators </para>        </detaileddescription>
490        <inbodydescription>
491        </inbodydescription>
492        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="73" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="80" bodyend="80"/>
493      </memberdef>
494      <memberdef kind="function" id="classchmat_1a8c3628a8c15eb0009e57c66fcac1a76" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
495        <type><ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
496        <definition>chmat &amp; chmat::operator-=</definition>
497        <argsstring>(const chmat &amp;A2)</argsstring>
498        <name>operator-=</name>
499        <param>
500          <type>const <ref refid="classchmat" kindref="compound">chmat</ref> &amp;</type>
501          <declname>A2</declname>
502        </param>
503        <briefdescription>
504<para>mapping of negative add operation to operators </para>        </briefdescription>
505        <detaileddescription>
506        </detaileddescription>
507        <inbodydescription>
508        </inbodydescription>
509        <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="74" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="82" bodyend="82"/>
510      </memberdef>
511      <memberdef kind="function" id="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
512        <type>int</type>
513        <definition>int sqmat::cols</definition>
514        <argsstring>() const </argsstring>
515        <name>cols</name>
516        <reimplementedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306">cols</reimplementedby>
517        <briefdescription>
518<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
519        <detaileddescription>
520        </detaileddescription>
521        <inbodydescription>
522        </inbodydescription>
523        <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"/>
524        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">sqmat::dim</references>
525      </memberdef>
526      <memberdef kind="function" id="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
527        <type>int</type>
528        <definition>int sqmat::rows</definition>
529        <argsstring>() const </argsstring>
530        <name>rows</name>
531        <reimplementedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163">rows</reimplementedby>
532        <briefdescription>
533<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
534        <detaileddescription>
535        </detaileddescription>
536        <inbodydescription>
537        </inbodydescription>
538        <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"/>
539        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">sqmat::dim</references>
540      </memberdef>
541      </sectiondef>
542    <briefdescription>
543<para>Symmetric matrix stored in square root decomposition using upper cholesky. </para>    </briefdescription>
544    <detaileddescription>
545<para>This matrix represent <formula id="19">$A=Ch&apos; Ch$</formula> where only the upper triangle <formula id="20">$Ch$</formula> is stored; </para>    </detaileddescription>
546    <inheritancegraph>
547      <node id="764">
548        <label>sqmat</label>
549        <link refid="classsqmat"/>
550      </node>
551      <node id="763">
552        <label>chmat</label>
553        <link refid="classchmat"/>
554        <childnode refid="764" relation="public-inheritance">
555        </childnode>
556      </node>
557    </inheritancegraph>
558    <collaborationgraph>
559      <node id="766">
560        <label>sqmat</label>
561        <link refid="classsqmat"/>
562      </node>
563      <node id="765">
564        <label>chmat</label>
565        <link refid="classchmat"/>
566        <childnode refid="766" relation="public-inheritance">
567        </childnode>
568      </node>
569    </collaborationgraph>
570    <location file="/home/smidl/work/git/mixpp/bdm/math/chmat.h" line="27" bodyfile="/home/smidl/work/git/mixpp/bdm/math/chmat.h" bodystart="27" bodyend="75"/>
571    <listofallmembers>
572      <member refid="classchmat_19c50d31c999d85d8e9d8cf2b69b6ac8c" prot="public" virt="non-virtual"><scope>chmat</scope><name>_Ch</name></member>
573      <member refid="classchmat_1f3921e3e5e31337cdbda40a3a5467257" prot="public" virt="non-virtual"><scope>chmat</scope><name>add</name></member>
574      <member refid="classchmat_195158bb150f5e7f939168abcd577fd9c" prot="protected" virt="non-virtual"><scope>chmat</scope><name>Ch</name></member>
575      <member refid="classchmat_1fdd73b0c596161637fd25bdf2c670c39" prot="public" virt="non-virtual"><scope>chmat</scope><name>chmat</name></member>
576      <member refid="classchmat_1d4f0a94e81279295e60e72812130f9d4" prot="public" virt="non-virtual"><scope>chmat</scope><name>chmat</name></member>
577      <member refid="classchmat_1d92f3bd9a727b8c88a8c7385feb3449a" prot="public" virt="non-virtual"><scope>chmat</scope><name>chmat</name></member>
578      <member refid="classchmat_18334a00f30f0a05f893c2aeec395ef10" prot="public" virt="non-virtual"><scope>chmat</scope><name>chmat</name></member>
579      <member refid="classchmat_1d0a995d312ecc11d3b43693f5e224ba9" prot="public" virt="virtual"><scope>chmat</scope><name>clear</name></member>
580      <member refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" virt="non-virtual"><scope>chmat</scope><name>cols</name></member>
581      <member refid="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" virt="non-virtual"><scope>chmat</scope><name>dim</name></member>
582      <member refid="classchmat_15ce4e21a9012a4e98c1f0ed1ca5669bd" prot="public" virt="non-virtual"><scope>chmat</scope><name>inv</name></member>
583      <member refid="classchmat_1b49427cff186c62f5df3724e5d2c34b4" prot="public" virt="virtual"><scope>chmat</scope><name>invqform</name></member>
584      <member refid="classchmat_1b504ca818203b13e667cb3c503980382" prot="public" virt="virtual"><scope>chmat</scope><name>logdet</name></member>
585      <member refid="classchmat_166f509f92b0ccf020e2a2a32566e0777" prot="public" virt="virtual"><scope>chmat</scope><name>mult_sym</name></member>
586      <member refid="classchmat_1d558ab63475a2f2ebc0c0e149796dcc6" prot="public" virt="non-virtual"><scope>chmat</scope><name>mult_sym</name></member>
587      <member refid="classchmat_107f50d1332b901eee962e8b1913102f7" prot="public" virt="virtual"><scope>chmat</scope><name>mult_sym_t</name></member>
588      <member refid="classchmat_131c3b985214a150b2a6b4be3b0fd40e3" prot="public" virt="non-virtual"><scope>chmat</scope><name>mult_sym_t</name></member>
589      <member refid="classchmat_16a8b39fe3a28d2c8e3fc0d74141229fb" prot="public" virt="non-virtual"><scope>chmat</scope><name>operator+=</name></member>
590      <member refid="classchmat_1a8c3628a8c15eb0009e57c66fcac1a76" prot="public" virt="non-virtual"><scope>chmat</scope><name>operator-=</name></member>
591      <member refid="classchmat_1bbc2d98d7455b1f38828907d442836bf" prot="public" virt="virtual"><scope>chmat</scope><name>opupdt</name></member>
592      <member refid="classchmat_16807737c7ffdb7041256b51db7592248" prot="public" virt="virtual"><scope>chmat</scope><name>qform</name></member>
593      <member refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" virt="non-virtual"><scope>chmat</scope><name>rows</name></member>
594      <member refid="classchmat_1a4fc7f9b0539b97c414442a22f3db6e8" prot="public" virt="non-virtual"><scope>chmat</scope><name>setD</name></member>
595      <member refid="classchmat_14b9271097d8317d9514c5d0d62cccb39" prot="public" virt="non-virtual"><scope>chmat</scope><name>setD</name></member>
596      <member refid="classsqmat_14268750c040c716b2c05037f725078a2" prot="public" virt="non-virtual"><scope>chmat</scope><name>sqmat</name></member>
597      <member refid="classchmat_1b22aa239dbaca33e3fb93b4f674d7051" prot="public" virt="virtual"><scope>chmat</scope><name>sqrt_mult</name></member>
598      <member refid="classchmat_1a37e2c726e4fc3ad50b26ac2ca6c1452" prot="public" virt="virtual"><scope>chmat</scope><name>to_mat</name></member>
599      <member refid="classchmat_1ba62fbf7cb8e065a4f3d24457824e89b" prot="public" virt="virtual"><scope>chmat</scope><name>~chmat</name></member>
600      <member refid="classsqmat_10481f2067bb32aaea7e6d4f27e46b656" prot="public" virt="virtual"><scope>chmat</scope><name>~sqmat</name></member>
601    </listofallmembers>
602  </compounddef>
603</doxygen>
Note: See TracBrowser for help on using the browser.