root/doc/xml/classsqmat.xml @ 266

Revision 187, 20.5 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="classsqmat" kind="class" prot="public">
4    <compoundname>sqmat</compoundname>
5    <derivedcompoundref refid="classchmat" prot="public" virt="non-virtual">chmat</derivedcompoundref>
6    <derivedcompoundref refid="classfsqmat" prot="public" virt="non-virtual">fsqmat</derivedcompoundref>
7    <derivedcompoundref refid="classldmat" prot="private" virt="non-virtual">ldmat</derivedcompoundref>
8    <includes refid="libDC_8h" local="no">libDC.h</includes>
9      <sectiondef kind="protected-attrib">
10      <memberdef kind="variable" id="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" static="no" mutable="no">
11        <type>int</type>
12        <definition>int sqmat::dim</definition>
13        <argsstring></argsstring>
14        <name>dim</name>
15        <briefdescription>
16<para>dimension of the square matrix </para>        </briefdescription>
17        <detaileddescription>
18        </detaileddescription>
19        <inbodydescription>
20        </inbodydescription>
21        <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"/>
22        <referencedby refid="classldmat_1a60f2c7e4f3c6a7738eaaaab81ffad20" compoundref="libDC_8cpp" startline="104" endline="114">ldmat::add</referencedby>
23        <referencedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306" compoundref="libDC_8h" startline="277" endline="277">ldmat::cols</referencedby>
24        <referencedby refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" compoundref="libDC_8h" startline="91" endline="91">cols</referencedby>
25        <referencedby refid="classldmat_1f291faa073e7bc8dfafc7ae93daa2506" compoundref="libDC_8cpp" startline="203" endline="297">ldmat::ldform</referencedby>
26        <referencedby refid="classldmat_1abe16e0f86668ef61a9a4896c8565dee" compoundref="libDC_8cpp" startline="41" endline="44">ldmat::ldmat</referencedby>
27        <referencedby refid="libDC_8h_16715d039e6d5d97005cf9e2522dfa474" compoundref="libDC_8cpp" startline="301" endline="320">ltuinv</referencedby>
28        <referencedby refid="classldmat_10f0f6e083e6d947cf58097ffce3ccd1a" compoundref="libDC_8cpp" startline="58" endline="72">ldmat::opupdt</referencedby>
29        <referencedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163" compoundref="libDC_8h" startline="279" endline="279">ldmat::rows</referencedby>
30        <referencedby refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" compoundref="libDC_8h" startline="94" endline="94">rows</referencedby>
31        <referencedby refid="classldmat_1fc380626ced6f9244fb58c5f0231174d" compoundref="libDC_8cpp" startline="189" endline="201">ldmat::sqrt_mult</referencedby>
32        <referencedby refid="classldmat_15b0515da8dc2293d9e4360b74cc26c9e" compoundref="libDC_8cpp" startline="80" endline="101">ldmat::to_mat</referencedby>
33      </memberdef>
34      </sectiondef>
35      <sectiondef kind="public-func">
36      <memberdef kind="function" id="classsqmat_1b223484796661f2dadb5607a86ce0581" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
37        <type>void</type>
38        <definition>virtual void sqmat::opupdt</definition>
39        <argsstring>(const vec &amp;v, double w)=0</argsstring>
40        <name>opupdt</name>
41        <reimplementedby refid="classldmat_10f0f6e083e6d947cf58097ffce3ccd1a">opupdt</reimplementedby>
42        <reimplementedby refid="classfsqmat_1b36530e155667fe9f1bd58394e50c65a">opupdt</reimplementedby>
43        <reimplementedby refid="classchmat_1bbc2d98d7455b1f38828907d442836bf">opupdt</reimplementedby>
44        <param>
45          <type>const vec &amp;</type>
46          <declname>v</declname>
47        </param>
48        <param>
49          <type>double</type>
50          <declname>w</declname>
51        </param>
52        <briefdescription>
53        </briefdescription>
54        <detaileddescription>
55<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>
56<parameternamelist>
57<parametername>v</parametername>
58</parameternamelist>
59<parameterdescription>
60<para>Vector forming the outer product to be added </para></parameterdescription>
61</parameteritem>
62<parameteritem>
63<parameternamelist>
64<parametername>w</parametername>
65</parameternamelist>
66<parameterdescription>
67<para>weight of updating; can be negative</para></parameterdescription>
68</parameteritem>
69</parameterlist>
70BLAS-2b operation. </para>        </detaileddescription>
71        <inbodydescription>
72        </inbodydescription>
73        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="41"/>
74      </memberdef>
75      <memberdef kind="function" id="classsqmat_19a5b6fddfeb42339e1dc9b978a2590fc" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
76        <type>mat</type>
77        <definition>virtual mat sqmat::to_mat</definition>
78        <argsstring>()=0</argsstring>
79        <name>to_mat</name>
80        <reimplementedby refid="classldmat_15b0515da8dc2293d9e4360b74cc26c9e">to_mat</reimplementedby>
81        <reimplementedby refid="classfsqmat_1cedf4f048309056f4262c930914dfda8">to_mat</reimplementedby>
82        <reimplementedby refid="classchmat_1a37e2c726e4fc3ad50b26ac2ca6c1452">to_mat</reimplementedby>
83        <briefdescription>
84<para>Conversion to full matrix. </para>        </briefdescription>
85        <detaileddescription>
86        </detaileddescription>
87        <inbodydescription>
88        </inbodydescription>
89        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="46"/>
90      </memberdef>
91      <memberdef kind="function" id="classsqmat_160fbbfa9e483b8187c135f787ee53afa" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
92        <type>void</type>
93        <definition>virtual void sqmat::mult_sym</definition>
94        <argsstring>(const mat &amp;C)=0</argsstring>
95        <name>mult_sym</name>
96        <reimplementedby refid="classldmat_1e967b9425007f0cb6cd59b845f9756d8">mult_sym</reimplementedby>
97        <reimplementedby refid="classfsqmat_15530d2756b5d991de755e6121c9a452e">mult_sym</reimplementedby>
98        <reimplementedby refid="classchmat_166f509f92b0ccf020e2a2a32566e0777">mult_sym</reimplementedby>
99        <param>
100          <type>const mat &amp;</type>
101          <declname>C</declname>
102        </param>
103        <briefdescription>
104<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>
105        <detaileddescription>
106<para><parameterlist kind="param"><parameteritem>
107<parameternamelist>
108<parametername>C</parametername>
109</parameternamelist>
110<parameterdescription>
111<para>multiplying matrix, </para></parameterdescription>
112</parameteritem>
113</parameterlist>
114</para>        </detaileddescription>
115        <inbodydescription>
116        </inbodydescription>
117        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="51"/>
118      </memberdef>
119      <memberdef kind="function" id="classsqmat_16909e906da17725b1b80f3cae7cf3325" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
120        <type>void</type>
121        <definition>virtual void sqmat::mult_sym_t</definition>
122        <argsstring>(const mat &amp;C)=0</argsstring>
123        <name>mult_sym_t</name>
124        <reimplementedby refid="classldmat_14fd155f38eb6dd5af4bdf9c98a7999a9">mult_sym_t</reimplementedby>
125        <reimplementedby refid="classfsqmat_192052a8adc2054b63e42d1373d145c89">mult_sym_t</reimplementedby>
126        <reimplementedby refid="classchmat_107f50d1332b901eee962e8b1913102f7">mult_sym_t</reimplementedby>
127        <param>
128          <type>const mat &amp;</type>
129          <declname>C</declname>
130        </param>
131        <briefdescription>
132<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>
133        <detaileddescription>
134<para><parameterlist kind="param"><parameteritem>
135<parameternamelist>
136<parametername>C</parametername>
137</parameternamelist>
138<parameterdescription>
139<para>multiplying matrix, </para></parameterdescription>
140</parameteritem>
141</parameterlist>
142</para>        </detaileddescription>
143        <inbodydescription>
144        </inbodydescription>
145        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="56"/>
146      </memberdef>
147      <memberdef kind="function" id="classsqmat_10a772b396750eeeed85d69fa72478b45" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
148        <type>double</type>
149        <definition>virtual double sqmat::logdet</definition>
150        <argsstring>() const =0</argsstring>
151        <name>logdet</name>
152        <reimplementedby refid="classldmat_12b42750ba4962d439aa52a77ae12949b">logdet</reimplementedby>
153        <reimplementedby refid="classfsqmat_1eb0d1358f536e4453b5f99d0418ca1e5">logdet</reimplementedby>
154        <reimplementedby refid="classchmat_1b504ca818203b13e667cb3c503980382">logdet</reimplementedby>
155        <briefdescription>
156<para>Logarithm of a determinant. </para>        </briefdescription>
157        <detaileddescription>
158        </detaileddescription>
159        <inbodydescription>
160        </inbodydescription>
161        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="63"/>
162      </memberdef>
163      <memberdef kind="function" id="classsqmat_16b79438b5d7544a9c8e110a145355d8f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
164        <type>vec</type>
165        <definition>virtual vec sqmat::sqrt_mult</definition>
166        <argsstring>(const vec &amp;v) const =0</argsstring>
167        <name>sqrt_mult</name>
168        <reimplementedby refid="classldmat_1fc380626ced6f9244fb58c5f0231174d">sqrt_mult</reimplementedby>
169        <reimplementedby refid="classfsqmat_1842a774077ee34ac3c36d180ab33e103">sqrt_mult</reimplementedby>
170        <reimplementedby refid="classchmat_1b22aa239dbaca33e3fb93b4f674d7051">sqrt_mult</reimplementedby>
171        <param>
172          <type>const vec &amp;</type>
173          <declname>v</declname>
174        </param>
175        <briefdescription>
176<para>Multiplies square root of <formula id="27">$V$</formula> by vector <formula id="28">$x$</formula>. </para>        </briefdescription>
177        <detaileddescription>
178<para>Used e.g. in generating normal samples. </para>        </detaileddescription>
179        <inbodydescription>
180        </inbodydescription>
181        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="70"/>
182      </memberdef>
183      <memberdef kind="function" id="classsqmat_1fc026312eb02ba09f85d5aacd6f05ab3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
184        <type>double</type>
185        <definition>virtual double sqmat::qform</definition>
186        <argsstring>(const vec &amp;v) const =0</argsstring>
187        <name>qform</name>
188        <reimplementedby refid="classldmat_1d64f331b781903e913cb2ee836886f3f">qform</reimplementedby>
189        <reimplementedby refid="classfsqmat_1a6c91b0389e73404324b2314b08d6e87">qform</reimplementedby>
190        <reimplementedby refid="classchmat_16807737c7ffdb7041256b51db7592248">qform</reimplementedby>
191        <param>
192          <type>const vec &amp;</type>
193          <declname>v</declname>
194        </param>
195        <briefdescription>
196<para>Evaluates quadratic form <formula id="29">$x= v&apos;*V*v$</formula>;. </para>        </briefdescription>
197        <detaileddescription>
198        </detaileddescription>
199        <inbodydescription>
200        </inbodydescription>
201        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="76"/>
202      </memberdef>
203      <memberdef kind="function" id="classsqmat_16230e8e8a9341866aaa0ce008691aac2" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
204        <type>double</type>
205        <definition>virtual double sqmat::invqform</definition>
206        <argsstring>(const vec &amp;v) const =0</argsstring>
207        <name>invqform</name>
208        <reimplementedby refid="classldmat_1d876c5f83e02b3e809b35c9de5068f14">invqform</reimplementedby>
209        <reimplementedby refid="classfsqmat_158075da64ddadd4df40654c35b928c6f">invqform</reimplementedby>
210        <reimplementedby refid="classchmat_1b49427cff186c62f5df3724e5d2c34b4">invqform</reimplementedby>
211        <param>
212          <type>const vec &amp;</type>
213          <declname>v</declname>
214        </param>
215        <briefdescription>
216<para>Evaluates quadratic form <formula id="30">$x= v&apos;*inv(V)*v$</formula>;. </para>        </briefdescription>
217        <detaileddescription>
218        </detaileddescription>
219        <inbodydescription>
220        </inbodydescription>
221        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="82"/>
222      </memberdef>
223      <memberdef kind="function" id="classsqmat_16fca246f9eabbdeb8cac03030e826b5e" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
224        <type>void</type>
225        <definition>virtual void sqmat::clear</definition>
226        <argsstring>()=0</argsstring>
227        <name>clear</name>
228        <reimplementedby refid="classldmat_14d6e401de9607332305c27e67972a07a">clear</reimplementedby>
229        <reimplementedby refid="classfsqmat_1cfa4c359483d2322f32d1d50050f8ac4">clear</reimplementedby>
230        <reimplementedby refid="classchmat_1d0a995d312ecc11d3b43693f5e224ba9">clear</reimplementedby>
231        <briefdescription>
232<para>Clearing matrix so that it corresponds to zeros. </para>        </briefdescription>
233        <detaileddescription>
234        </detaileddescription>
235        <inbodydescription>
236        </inbodydescription>
237        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="88"/>
238      </memberdef>
239      <memberdef kind="function" id="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
240        <type>int</type>
241        <definition>int sqmat::cols</definition>
242        <argsstring>() const </argsstring>
243        <name>cols</name>
244        <reimplementedby refid="classldmat_10fceb6b5b637cec89bb0a3d2e6be1306">cols</reimplementedby>
245        <briefdescription>
246<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
247        <detaileddescription>
248        </detaileddescription>
249        <inbodydescription>
250        </inbodydescription>
251        <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"/>
252        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">dim</references>
253      </memberdef>
254      <memberdef kind="function" id="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
255        <type>int</type>
256        <definition>int sqmat::rows</definition>
257        <argsstring>() const </argsstring>
258        <name>rows</name>
259        <reimplementedby refid="classldmat_196dfb21865db4f5bd36fa70f9b0b1163">rows</reimplementedby>
260        <briefdescription>
261<para>Reimplementing common functions of mat: <ref refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" kindref="member">cols()</ref>. </para>        </briefdescription>
262        <detaileddescription>
263        </detaileddescription>
264        <inbodydescription>
265        </inbodydescription>
266        <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"/>
267        <references refid="classsqmat_10abed904bdc0882373ba9adba919689d" compoundref="libDC_8h" startline="99">dim</references>
268      </memberdef>
269      <memberdef kind="function" id="classsqmat_10481f2067bb32aaea7e6d4f27e46b656" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
270        <type></type>
271        <definition>virtual sqmat::~sqmat</definition>
272        <argsstring>()</argsstring>
273        <name>~sqmat</name>
274        <briefdescription>
275<para>Destructor for future use;. </para>        </briefdescription>
276        <detaileddescription>
277        </detaileddescription>
278        <inbodydescription>
279        </inbodydescription>
280        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="97" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="97" bodyend="97"/>
281      </memberdef>
282      <memberdef kind="function" id="classsqmat_14268750c040c716b2c05037f725078a2" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
283        <type></type>
284        <definition>sqmat::sqmat</definition>
285        <argsstring>(const int dim0)</argsstring>
286        <name>sqmat</name>
287        <param>
288          <type>const int</type>
289          <declname>dim0</declname>
290        </param>
291        <briefdescription>
292<para>Default constructor. </para>        </briefdescription>
293        <detaileddescription>
294        </detaileddescription>
295        <inbodydescription>
296        </inbodydescription>
297        <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="99" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="99" bodyend="99"/>
298      </memberdef>
299      </sectiondef>
300    <briefdescription>
301<para>Virtual class for representation of double symmetric matrices in square-root form. </para>    </briefdescription>
302    <detaileddescription>
303<para>All operations defined on this class should be optimized for the chosen decomposition. </para>    </detaileddescription>
304    <inheritancegraph>
305      <node id="1293">
306        <label>ldmat</label>
307        <link refid="classldmat"/>
308        <childnode refid="1290" relation="private-inheritance">
309        </childnode>
310      </node>
311      <node id="1292">
312        <label>fsqmat</label>
313        <link refid="classfsqmat"/>
314        <childnode refid="1290" relation="public-inheritance">
315        </childnode>
316      </node>
317      <node id="1290">
318        <label>sqmat</label>
319        <link refid="classsqmat"/>
320      </node>
321      <node id="1291">
322        <label>chmat</label>
323        <link refid="classchmat"/>
324        <childnode refid="1290" relation="public-inheritance">
325        </childnode>
326      </node>
327    </inheritancegraph>
328    <location file="/home/smidl/work/git/mixpp/bdm/math/libDC.h" line="32" bodyfile="/home/smidl/work/git/mixpp/bdm/math/libDC.h" bodystart="31" bodyend="103"/>
329    <listofallmembers>
330      <member refid="classsqmat_16fca246f9eabbdeb8cac03030e826b5e" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>clear</name></member>
331      <member refid="classsqmat_1ecc2e2540f95a04f4449842588170f5b" prot="public" virt="non-virtual"><scope>sqmat</scope><name>cols</name></member>
332      <member refid="classsqmat_10abed904bdc0882373ba9adba919689d" prot="protected" virt="non-virtual"><scope>sqmat</scope><name>dim</name></member>
333      <member refid="classsqmat_16230e8e8a9341866aaa0ce008691aac2" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>invqform</name></member>
334      <member refid="classsqmat_10a772b396750eeeed85d69fa72478b45" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>logdet</name></member>
335      <member refid="classsqmat_160fbbfa9e483b8187c135f787ee53afa" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>mult_sym</name></member>
336      <member refid="classsqmat_16909e906da17725b1b80f3cae7cf3325" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>mult_sym_t</name></member>
337      <member refid="classsqmat_1b223484796661f2dadb5607a86ce0581" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>opupdt</name></member>
338      <member refid="classsqmat_1fc026312eb02ba09f85d5aacd6f05ab3" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>qform</name></member>
339      <member refid="classsqmat_1071e80ced9cc3b8cbb360fa7462eb646" prot="public" virt="non-virtual"><scope>sqmat</scope><name>rows</name></member>
340      <member refid="classsqmat_14268750c040c716b2c05037f725078a2" prot="public" virt="non-virtual"><scope>sqmat</scope><name>sqmat</name></member>
341      <member refid="classsqmat_16b79438b5d7544a9c8e110a145355d8f" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>sqrt_mult</name></member>
342      <member refid="classsqmat_19a5b6fddfeb42339e1dc9b978a2590fc" prot="public" virt="pure-virtual"><scope>sqmat</scope><name>to_mat</name></member>
343      <member refid="classsqmat_10481f2067bb32aaea7e6d4f27e46b656" prot="public" virt="virtual"><scope>sqmat</scope><name>~sqmat</name></member>
344    </listofallmembers>
345  </compounddef>
346</doxygen>
Note: See TracBrowser for help on using the browser.