root/doc/xml/classBM.xml @ 222

Revision 187, 20.0 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="classBM" kind="class" prot="public">
4    <compoundname>BM</compoundname>
5    <derivedcompoundref refid="classARX" prot="public" virt="non-virtual">ARX</derivedcompoundref>
6    <derivedcompoundref refid="classEKFfixed" prot="public" virt="non-virtual">EKFfixed</derivedcompoundref>
7    <derivedcompoundref refid="classEKFfull" prot="public" virt="non-virtual">EKFfull</derivedcompoundref>
8    <derivedcompoundref refid="classKalman" prot="public" virt="non-virtual">Kalman&lt; sq_T &gt;</derivedcompoundref>
9    <derivedcompoundref refid="classKalman" prot="public" virt="non-virtual">Kalman&lt; chmat &gt;</derivedcompoundref>
10    <derivedcompoundref refid="classKalman" prot="public" virt="non-virtual">Kalman&lt; fsqmat &gt;</derivedcompoundref>
11    <derivedcompoundref refid="classKalman" prot="public" virt="non-virtual">Kalman&lt; ldmat &gt;</derivedcompoundref>
12    <derivedcompoundref refid="classPF" prot="public" virt="non-virtual">PF</derivedcompoundref>
13    <includes refid="libBM_8h" local="no">libBM.h</includes>
14      <sectiondef kind="protected-attrib">
15      <memberdef kind="variable" id="classBM_1af00f0612fabe66241dd507188cdbf88" prot="protected" static="no" mutable="no">
16        <type><ref refid="classRV" kindref="compound">RV</ref></type>
17        <definition>RV BM::rv</definition>
18        <argsstring></argsstring>
19        <name>rv</name>
20        <briefdescription>
21<para>Random variable of the posterior. </para>        </briefdescription>
22        <detaileddescription>
23        </detaileddescription>
24        <inbodydescription>
25        </inbodydescription>
26        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="264" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="264" bodyend="-1"/>
27        <referencedby refid="classBM_1126bd2595c48e311fc2a7ab72876092a" compoundref="libBM_8h" startline="287" endline="287">_rv</referencedby>
28        <referencedby refid="classMPF_1fc5e11e11eec3195e3c6503937bf02bd" compoundref="libPF_8h" startline="104" endline="117">MPF&lt; BM_T &gt;::MPF</referencedby>
29        <referencedby refid="classEKFfull_1fc753106e0d4cf68e4f2160fd54458c0" compoundref="libKF_8cpp" startline="66" endline="84">EKFfull::set_parameters</referencedby>
30        <referencedby refid="classARX_1130bb7336aac681ce14b027b8f1409fa" compoundref="bdm_2estim_2arx_8cpp" startline="82" endline="86">ARX::structure_est</referencedby>
31      </memberdef>
32      <memberdef kind="variable" id="classBM_15623fef6572a08c2b53b8c87b82dc979" prot="protected" static="no" mutable="no">
33        <type>double</type>
34        <definition>double BM::ll</definition>
35        <argsstring></argsstring>
36        <name>ll</name>
37        <briefdescription>
38<para>Logarithm of marginalized data likelihood. </para>        </briefdescription>
39        <detaileddescription>
40        </detaileddescription>
41        <inbodydescription>
42        </inbodydescription>
43        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="266" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="266" bodyend="-1"/>
44        <referencedby refid="classBM_187f4a547d2c29180be88175e5eab9c88" compoundref="libBM_8h" startline="289" endline="289">_ll</referencedby>
45        <referencedby refid="classEKFfixed_1ddf5334bc1207658fd53698fffbac028" compoundref="ekf__obj_8cpp" startline="10" endline="38">EKFfixed::bayes</referencedby>
46        <referencedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7" compoundref="libKF_8h" startline="364" endline="396">EKF&lt; sq_T &gt;::bayes</referencedby>
47        <referencedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c" compoundref="libKF_8h" startline="302" endline="337">Kalman&lt; sq_T &gt;::bayes</referencedby>
48        <referencedby refid="classEKFCh_196f6edda324a0b7ef8b4e86cc7af60c1" compoundref="libKF_8cpp" startline="189" endline="236">EKFCh::bayes</referencedby>
49        <referencedby refid="classKalmanCh_1cca758192846940409822b9bd778d4e1" compoundref="libKF_8cpp" startline="128" endline="162">KalmanCh::bayes</referencedby>
50        <referencedby refid="classEKFfull_18ca46f177e395fa714bbd8bd29ea43e0" compoundref="libKF_8cpp" startline="86" endline="114">EKFfull::bayes</referencedby>
51        <referencedby refid="classARX_1ba82c956ca893826811aefe1e4af465d" compoundref="bdm_2estim_2arx_8cpp" startline="5" endline="24">ARX::bayes</referencedby>
52      </memberdef>
53      <memberdef kind="variable" id="classBM_1bf6fb59b30141074f8ee1e2f43d03129" prot="protected" static="no" mutable="no">
54        <type>bool</type>
55        <definition>bool BM::evalll</definition>
56        <argsstring></argsstring>
57        <name>evalll</name>
58        <briefdescription>
59<para>If true, the filter will compute likelihood of the data record and store it in <computeroutput>ll</computeroutput> . Set to false if you want to save time. </para>        </briefdescription>
60        <detaileddescription>
61        </detaileddescription>
62        <inbodydescription>
63        </inbodydescription>
64        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="268" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="268" bodyend="-1"/>
65        <referencedby refid="classEKFfixed_1ddf5334bc1207658fd53698fffbac028" compoundref="ekf__obj_8cpp" startline="10" endline="38">EKFfixed::bayes</referencedby>
66        <referencedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7" compoundref="libKF_8h" startline="364" endline="396">EKF&lt; sq_T &gt;::bayes</referencedby>
67        <referencedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c" compoundref="libKF_8h" startline="302" endline="337">Kalman&lt; sq_T &gt;::bayes</referencedby>
68        <referencedby refid="classEKFCh_196f6edda324a0b7ef8b4e86cc7af60c1" compoundref="libKF_8cpp" startline="189" endline="236">EKFCh::bayes</referencedby>
69        <referencedby refid="classKalmanCh_1cca758192846940409822b9bd778d4e1" compoundref="libKF_8cpp" startline="128" endline="162">KalmanCh::bayes</referencedby>
70        <referencedby refid="classEKFfull_18ca46f177e395fa714bbd8bd29ea43e0" compoundref="libKF_8cpp" startline="86" endline="114">EKFfull::bayes</referencedby>
71        <referencedby refid="classARX_1ba82c956ca893826811aefe1e4af465d" compoundref="bdm_2estim_2arx_8cpp" startline="5" endline="24">ARX::bayes</referencedby>
72      </memberdef>
73      </sectiondef>
74      <sectiondef kind="public-func">
75      <memberdef kind="function" id="classBM_1605d28b426adb677c86a57ddb525132a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
76        <type></type>
77        <definition>BM::BM</definition>
78        <argsstring>(const RV &amp;rv0)</argsstring>
79        <name>BM</name>
80        <param>
81          <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
82          <declname>rv0</declname>
83        </param>
84        <briefdescription>
85<para>Default constructor. </para>        </briefdescription>
86        <detaileddescription>
87        </detaileddescription>
88        <inbodydescription>
89        </inbodydescription>
90        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="272" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="272" bodyend="273"/>
91      </memberdef>
92      <memberdef kind="function" id="classBM_1a892eff438aab2dd1a9e2efcb7fb5bdf" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
93        <type>void</type>
94        <definition>virtual void BM::bayes</definition>
95        <argsstring>(const vec &amp;dt)=0</argsstring>
96        <name>bayes</name>
97        <reimplementedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c">bayes</reimplementedby>
98        <reimplementedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c">bayes</reimplementedby>
99        <reimplementedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c">bayes</reimplementedby>
100        <reimplementedby refid="classEKFfixed_1ddf5334bc1207658fd53698fffbac028">bayes</reimplementedby>
101        <reimplementedby refid="classMPF_155daf8e4b6553dd9f47c692de7931623">bayes</reimplementedby>
102        <reimplementedby refid="classPF_164f636bbd63bea9efd778214e6b631d3">bayes</reimplementedby>
103        <reimplementedby refid="classEKFCh_196f6edda324a0b7ef8b4e86cc7af60c1">bayes</reimplementedby>
104        <reimplementedby refid="classEKF_1c79c62c9b3e0b56b3aaa1b6f1d9a7af7">bayes</reimplementedby>
105        <reimplementedby refid="classEKFfull_18ca46f177e395fa714bbd8bd29ea43e0">bayes</reimplementedby>
106        <reimplementedby refid="classKalmanCh_1cca758192846940409822b9bd778d4e1">bayes</reimplementedby>
107        <reimplementedby refid="classKalman_17750ffd73f261828a32c18aaeb65c75c">bayes</reimplementedby>
108        <reimplementedby refid="classARX_1ba82c956ca893826811aefe1e4af465d">bayes</reimplementedby>
109        <param>
110          <type>const vec &amp;</type>
111          <declname>dt</declname>
112        </param>
113        <briefdescription>
114<para>Incremental Bayes rule. </para>        </briefdescription>
115        <detaileddescription>
116<para><parameterlist kind="param"><parameteritem>
117<parameternamelist>
118<parametername>dt</parametername>
119</parameternamelist>
120<parameterdescription>
121<para>vector of input data </para></parameterdescription>
122</parameteritem>
123</parameterlist>
124</para>        </detaileddescription>
125        <inbodydescription>
126        </inbodydescription>
127        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="278"/>
128      </memberdef>
129      <memberdef kind="function" id="classBM_187b07867fd4c133aa89a18543f68d9f9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
130        <type>void</type>
131        <definition>void BM::bayes</definition>
132        <argsstring>(mat Dt)</argsstring>
133        <name>bayes</name>
134        <param>
135          <type>mat</type>
136          <declname>Dt</declname>
137        </param>
138        <briefdescription>
139<para>Batch Bayes rule (columns of Dt are observations). </para>        </briefdescription>
140        <detaileddescription>
141        </detaileddescription>
142        <inbodydescription>
143        </inbodydescription>
144        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="280"/>
145      </memberdef>
146      <memberdef kind="function" id="classBM_13dc45554556926bde996a267636abe55" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
147        <type><ref refid="classepdf" kindref="compound">epdf</ref> &amp;</type>
148        <definition>virtual epdf&amp; BM::_epdf</definition>
149        <argsstring>()=0</argsstring>
150        <name>_epdf</name>
151        <reimplementedby refid="classKalman_1a213c57aef55b2645e550bed81cfc0d4">_epdf</reimplementedby>
152        <reimplementedby refid="classKalman_1a213c57aef55b2645e550bed81cfc0d4">_epdf</reimplementedby>
153        <reimplementedby refid="classKalman_1a213c57aef55b2645e550bed81cfc0d4">_epdf</reimplementedby>
154        <reimplementedby refid="classEKFfixed_1085cf16c573eda32d8d03619c6c4b518">_epdf</reimplementedby>
155        <reimplementedby refid="classMPF_1549e08268a46a250f21a33d06f19276a">_epdf</reimplementedby>
156        <reimplementedby refid="classEKFfull_14080d68f79dade36ccf547d57e64bdc2">_epdf</reimplementedby>
157        <reimplementedby refid="classKalman_1a213c57aef55b2645e550bed81cfc0d4">_epdf</reimplementedby>
158        <reimplementedby refid="classARX_19d8eff7a9df81786191a4c55b27e5b8a">_epdf</reimplementedby>
159        <briefdescription>
160<para>Returns a pointer to the <ref refid="classepdf" kindref="compound">epdf</ref> representing posterior density on parameters. Use with care! </para>        </briefdescription>
161        <detaileddescription>
162        </detaileddescription>
163        <inbodydescription>
164        </inbodydescription>
165        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="282"/>
166      </memberdef>
167      <memberdef kind="function" id="classBM_1ca0f02b3b4144e0895cc14f7e0374bdd" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
168        <type></type>
169        <definition>virtual BM::~BM</definition>
170        <argsstring>()</argsstring>
171        <name>~BM</name>
172        <briefdescription>
173<para>Destructor for future use;. </para>        </briefdescription>
174        <detaileddescription>
175        </detaileddescription>
176        <inbodydescription>
177        </inbodydescription>
178        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="285" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="285" bodyend="285"/>
179      </memberdef>
180      <memberdef kind="function" id="classBM_1126bd2595c48e311fc2a7ab72876092a" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
181        <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
182        <definition>const RV&amp; BM::_rv</definition>
183        <argsstring>() const </argsstring>
184        <name>_rv</name>
185        <briefdescription>
186<para>access function </para>        </briefdescription>
187        <detaileddescription>
188        </detaileddescription>
189        <inbodydescription>
190        </inbodydescription>
191        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="287" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="287" bodyend="287"/>
192        <references refid="classBM_1af00f0612fabe66241dd507188cdbf88" compoundref="libBM_8h" startline="264">rv</references>
193      </memberdef>
194      <memberdef kind="function" id="classBM_187f4a547d2c29180be88175e5eab9c88" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
195        <type>double</type>
196        <definition>double BM::_ll</definition>
197        <argsstring>() const </argsstring>
198        <name>_ll</name>
199        <briefdescription>
200<para>access function </para>        </briefdescription>
201        <detaileddescription>
202        </detaileddescription>
203        <inbodydescription>
204        </inbodydescription>
205        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="289" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="289" bodyend="289"/>
206        <references refid="classBM_15623fef6572a08c2b53b8c87b82dc979" compoundref="libBM_8h" startline="266">ll</references>
207      </memberdef>
208      </sectiondef>
209    <briefdescription>
210<para>Bayesian Model of the world, i.e. all uncertainty is modeled by probabilities. </para>    </briefdescription>
211    <detaileddescription>
212    </detaileddescription>
213    <inheritancegraph>
214      <node id="712">
215        <label>EKF&lt; sq_T &gt;</label>
216        <link refid="classEKF"/>
217        <childnode refid="711" relation="public-inheritance">
218        </childnode>
219      </node>
220      <node id="711">
221        <label>Kalman&lt; fsqmat &gt;</label>
222        <link refid="classKalman"/>
223        <childnode refid="703" relation="template-instance">
224          <edgelabel>&lt; fsqmat &gt;</edgelabel>
225        </childnode>
226        <childnode refid="697" relation="public-inheritance">
227        </childnode>
228      </node>
229      <node id="709">
230        <label>EKFCh</label>
231        <link refid="classEKFCh"/>
232        <childnode refid="708" relation="public-inheritance">
233        </childnode>
234      </node>
235      <node id="697">
236        <label>BM</label>
237        <link refid="classBM"/>
238      </node>
239      <node id="699">
240        <label>EKFfixed</label>
241        <link refid="classEKFfixed"/>
242        <childnode refid="697" relation="public-inheritance">
243        </childnode>
244      </node>
245      <node id="714">
246        <label>MPF&lt; BM_T &gt;</label>
247        <link refid="classMPF"/>
248        <childnode refid="713" relation="public-inheritance">
249        </childnode>
250      </node>
251      <node id="701">
252        <label>EKF_unQful</label>
253        <childnode refid="700" relation="public-inheritance">
254        </childnode>
255      </node>
256      <node id="706">
257        <label>KFcondR</label>
258        <link refid="classKFcondR"/>
259        <childnode refid="704" relation="public-inheritance">
260        </childnode>
261      </node>
262      <node id="713">
263        <label>PF</label>
264        <link refid="classPF"/>
265        <childnode refid="697" relation="public-inheritance">
266        </childnode>
267      </node>
268      <node id="710">
269        <label>EKF_unQ</label>
270        <link refid="classEKF__unQ"/>
271        <childnode refid="709" relation="public-inheritance">
272        </childnode>
273        <childnode refid="709" relation="public-inheritance">
274        </childnode>
275        <childnode refid="709" relation="public-inheritance">
276        </childnode>
277      </node>
278      <node id="705">
279        <label>KFcondQR</label>
280        <link refid="classKFcondQR"/>
281        <childnode refid="704" relation="public-inheritance">
282        </childnode>
283      </node>
284      <node id="708">
285        <label>KalmanCh</label>
286        <link refid="classKalmanCh"/>
287        <childnode refid="707" relation="public-inheritance">
288        </childnode>
289      </node>
290      <node id="704">
291        <label>Kalman&lt; ldmat &gt;</label>
292        <link refid="classKalman"/>
293        <childnode refid="703" relation="template-instance">
294          <edgelabel>&lt; ldmat &gt;</edgelabel>
295        </childnode>
296        <childnode refid="697" relation="public-inheritance">
297        </childnode>
298      </node>
299      <node id="707">
300        <label>Kalman&lt; chmat &gt;</label>
301        <link refid="classKalman"/>
302        <childnode refid="703" relation="template-instance">
303          <edgelabel>&lt; chmat &gt;</edgelabel>
304        </childnode>
305        <childnode refid="697" relation="public-inheritance">
306        </childnode>
307      </node>
308      <node id="703">
309        <label>Kalman&lt; sq_T &gt;</label>
310        <link refid="classKalman"/>
311        <childnode refid="697" relation="public-inheritance">
312        </childnode>
313      </node>
314      <node id="702">
315        <label>EKFful_unQR</label>
316        <link refid="classEKFful__unQR"/>
317        <childnode refid="700" relation="public-inheritance">
318        </childnode>
319      </node>
320      <node id="700">
321        <label>EKFfull</label>
322        <link refid="classEKFfull"/>
323        <childnode refid="697" relation="public-inheritance">
324        </childnode>
325      </node>
326      <node id="698">
327        <label>ARX</label>
328        <link refid="classARX"/>
329        <childnode refid="697" relation="public-inheritance">
330        </childnode>
331      </node>
332    </inheritancegraph>
333    <collaborationgraph>
334      <node id="715">
335        <label>BM</label>
336        <link refid="classBM"/>
337        <childnode refid="716" relation="usage">
338          <edgelabel>rv</edgelabel>
339        </childnode>
340      </node>
341      <node id="716">
342        <label>RV</label>
343        <link refid="classRV"/>
344      </node>
345    </collaborationgraph>
346    <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="261" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="261" bodyend="290"/>
347    <listofallmembers>
348      <member refid="classBM_13dc45554556926bde996a267636abe55" prot="public" virt="pure-virtual"><scope>BM</scope><name>_epdf</name></member>
349      <member refid="classBM_187f4a547d2c29180be88175e5eab9c88" prot="public" virt="non-virtual"><scope>BM</scope><name>_ll</name></member>
350      <member refid="classBM_1126bd2595c48e311fc2a7ab72876092a" prot="public" virt="non-virtual"><scope>BM</scope><name>_rv</name></member>
351      <member refid="classBM_1a892eff438aab2dd1a9e2efcb7fb5bdf" prot="public" virt="pure-virtual"><scope>BM</scope><name>bayes</name></member>
352      <member refid="classBM_187b07867fd4c133aa89a18543f68d9f9" prot="public" virt="non-virtual"><scope>BM</scope><name>bayes</name></member>
353      <member refid="classBM_1605d28b426adb677c86a57ddb525132a" prot="public" virt="non-virtual"><scope>BM</scope><name>BM</name></member>
354      <member refid="classBM_1bf6fb59b30141074f8ee1e2f43d03129" prot="protected" virt="non-virtual"><scope>BM</scope><name>evalll</name></member>
355      <member refid="classBM_15623fef6572a08c2b53b8c87b82dc979" prot="protected" virt="non-virtual"><scope>BM</scope><name>ll</name></member>
356      <member refid="classBM_1af00f0612fabe66241dd507188cdbf88" prot="protected" virt="non-virtual"><scope>BM</scope><name>rv</name></member>
357      <member refid="classBM_1ca0f02b3b4144e0895cc14f7e0374bdd" prot="public" virt="virtual"><scope>BM</scope><name>~BM</name></member>
358    </listofallmembers>
359  </compounddef>
360</doxygen>
Note: See TracBrowser for help on using the browser.