root/doc/xml/classBMcond.xml @ 269

Revision 187, 9.7 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="classBMcond" kind="class" prot="public">
4    <compoundname>BMcond</compoundname>
5    <derivedcompoundref refid="classEKF__unQ" prot="public" virt="non-virtual">EKF_unQ</derivedcompoundref>
6    <derivedcompoundref refid="classEKF__unQ" prot="public" virt="non-virtual">EKF_unQ</derivedcompoundref>
7    <derivedcompoundref refid="classEKF__unQ" prot="public" virt="non-virtual">EKF_unQ</derivedcompoundref>
8    <derivedcompoundref refid="classEKF__unQful" prot="public" virt="non-virtual">EKF_unQful</derivedcompoundref>
9    <derivedcompoundref refid="classEKFfixed" prot="public" virt="non-virtual">EKFfixed</derivedcompoundref>
10    <derivedcompoundref refid="classEKFful__unQR" prot="public" virt="non-virtual">EKFful_unQR</derivedcompoundref>
11    <derivedcompoundref refid="classKFcondQR" prot="public" virt="non-virtual">KFcondQR</derivedcompoundref>
12    <derivedcompoundref refid="classKFcondR" prot="public" virt="non-virtual">KFcondR</derivedcompoundref>
13    <includes refid="libBM_8h" local="no">libBM.h</includes>
14      <sectiondef kind="protected-attrib">
15      <memberdef kind="variable" id="classBMcond_19ba793c8ec453f04d372d17195ed8dec" prot="protected" static="no" mutable="no">
16        <type><ref refid="classRV" kindref="compound">RV</ref></type>
17        <definition>RV BMcond::rvc</definition>
18        <argsstring></argsstring>
19        <name>rvc</name>
20        <briefdescription>
21<para>Identificator of the conditioning variable. </para>        </briefdescription>
22        <detaileddescription>
23        </detaileddescription>
24        <inbodydescription>
25        </inbodydescription>
26        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="304" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="304" bodyend="-1"/>
27        <referencedby refid="classBMcond_13fa60348b2da6b4208bb95b8d146900a" compoundref="libBM_8h" startline="313" endline="313">_rvc</referencedby>
28        <referencedby refid="classKFcondR_18c0721e47879bb8840d829db7a174a7f" compoundref="libKF_8cpp" startline="245" endline="249">KFcondR::condition</referencedby>
29        <referencedby refid="classKFcondQR_1c9ecf292a85327aa6309c9fd70ceb606" compoundref="libKF_8cpp" startline="238" endline="243">KFcondQR::condition</referencedby>
30      </memberdef>
31      </sectiondef>
32      <sectiondef kind="public-func">
33      <memberdef kind="function" id="classBMcond_13543cfe274c35f9033c24d8036a96c4d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
34        <type>void</type>
35        <definition>virtual void BMcond::condition</definition>
36        <argsstring>(const vec &amp;val)=0</argsstring>
37        <name>condition</name>
38        <reimplementedby refid="classEKFfixed_1c7fee79e75ad7f0c0e96c5a322cbf44e">condition</reimplementedby>
39        <reimplementedby refid="classEKF__unQ_1cd06a8c662da244cf61bb5bd39688c99">condition</reimplementedby>
40        <reimplementedby refid="classEKF__unQ_1cd06a8c662da244cf61bb5bd39688c99">condition</reimplementedby>
41        <reimplementedby refid="classEKF__unQ_1cd06a8c662da244cf61bb5bd39688c99">condition</reimplementedby>
42        <reimplementedby refid="classKFcondR_18c0721e47879bb8840d829db7a174a7f">condition</reimplementedby>
43        <reimplementedby refid="classKFcondQR_1c9ecf292a85327aa6309c9fd70ceb606">condition</reimplementedby>
44        <reimplementedby refid="classEKFful__unQR_1b586e534c8a8d219561b0c020329d412">condition</reimplementedby>
45        <param>
46          <type>const vec &amp;</type>
47          <declname>val</declname>
48        </param>
49        <briefdescription>
50<para>Substitute <computeroutput>val</computeroutput> for <computeroutput>rvc</computeroutput>. </para>        </briefdescription>
51        <detaileddescription>
52        </detaileddescription>
53        <inbodydescription>
54        </inbodydescription>
55        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="307"/>
56      </memberdef>
57      <memberdef kind="function" id="classBMcond_19a38dcdabef902fd91da3c9fb6ac27f7" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
58        <type></type>
59        <definition>BMcond::BMcond</definition>
60        <argsstring>(RV &amp;rv0)</argsstring>
61        <name>BMcond</name>
62        <param>
63          <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
64          <declname>rv0</declname>
65        </param>
66        <briefdescription>
67<para>Default constructor. </para>        </briefdescription>
68        <detaileddescription>
69        </detaileddescription>
70        <inbodydescription>
71        </inbodydescription>
72        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="309" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="309" bodyend="309"/>
73      </memberdef>
74      <memberdef kind="function" id="classBMcond_1d40c72250cf93640f982d06de20815b2" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
75        <type></type>
76        <definition>virtual BMcond::~BMcond</definition>
77        <argsstring>()</argsstring>
78        <name>~BMcond</name>
79        <briefdescription>
80<para>Destructor for future use. </para>        </briefdescription>
81        <detaileddescription>
82        </detaileddescription>
83        <inbodydescription>
84        </inbodydescription>
85        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="311" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="311" bodyend="311"/>
86      </memberdef>
87      <memberdef kind="function" id="classBMcond_13fa60348b2da6b4208bb95b8d146900a" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
88        <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
89        <definition>const RV&amp; BMcond::_rvc</definition>
90        <argsstring>() const </argsstring>
91        <name>_rvc</name>
92        <briefdescription>
93<para>access function </para>        </briefdescription>
94        <detaileddescription>
95        </detaileddescription>
96        <inbodydescription>
97        </inbodydescription>
98        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="313" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="313" bodyend="313"/>
99        <references refid="classBMcond_19ba793c8ec453f04d372d17195ed8dec" compoundref="libBM_8h" startline="304">rvc</references>
100      </memberdef>
101      </sectiondef>
102    <briefdescription>
103<para>Conditional Bayesian Filter. </para>    </briefdescription>
104    <detaileddescription>
105<para>Evaluates conditional filtering density <formula id="36">$f(rv|rvc,data)$</formula> for a given <computeroutput>rvc</computeroutput> which is specified in each step by calling function <computeroutput>condition</computeroutput>.</para><para>This is an interface class used to assure that certain <ref refid="classBM" kindref="compound">BM</ref> has operation <computeroutput>condition</computeroutput> . </para>    </detaileddescription>
106    <inheritancegraph>
107      <node id="720">
108        <label>EKFfixed</label>
109        <link refid="classEKFfixed"/>
110        <childnode refid="717" relation="public-inheritance">
111        </childnode>
112      </node>
113      <node id="719">
114        <label>EKF_unQful</label>
115        <childnode refid="717" relation="public-inheritance">
116        </childnode>
117      </node>
118      <node id="723">
119        <label>KFcondR</label>
120        <link refid="classKFcondR"/>
121        <childnode refid="717" relation="public-inheritance">
122        </childnode>
123      </node>
124      <node id="718">
125        <label>EKF_unQ</label>
126        <link refid="classEKF__unQ"/>
127        <childnode refid="717" relation="public-inheritance">
128        </childnode>
129        <childnode refid="717" relation="public-inheritance">
130        </childnode>
131        <childnode refid="717" relation="public-inheritance">
132        </childnode>
133      </node>
134      <node id="722">
135        <label>KFcondQR</label>
136        <link refid="classKFcondQR"/>
137        <childnode refid="717" relation="public-inheritance">
138        </childnode>
139      </node>
140      <node id="721">
141        <label>EKFful_unQR</label>
142        <link refid="classEKFful__unQR"/>
143        <childnode refid="717" relation="public-inheritance">
144        </childnode>
145      </node>
146      <node id="717">
147        <label>BMcond</label>
148        <link refid="classBMcond"/>
149      </node>
150    </inheritancegraph>
151    <collaborationgraph>
152      <node id="725">
153        <label>RV</label>
154        <link refid="classRV"/>
155      </node>
156      <node id="724">
157        <label>BMcond</label>
158        <link refid="classBMcond"/>
159        <childnode refid="725" relation="usage">
160          <edgelabel>rvc</edgelabel>
161        </childnode>
162      </node>
163    </collaborationgraph>
164    <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="301" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="301" bodyend="314"/>
165    <listofallmembers>
166      <member refid="classBMcond_13fa60348b2da6b4208bb95b8d146900a" prot="public" virt="non-virtual"><scope>BMcond</scope><name>_rvc</name></member>
167      <member refid="classBMcond_19a38dcdabef902fd91da3c9fb6ac27f7" prot="public" virt="non-virtual"><scope>BMcond</scope><name>BMcond</name></member>
168      <member refid="classBMcond_13543cfe274c35f9033c24d8036a96c4d" prot="public" virt="pure-virtual"><scope>BMcond</scope><name>condition</name></member>
169      <member refid="classBMcond_19ba793c8ec453f04d372d17195ed8dec" prot="protected" virt="non-virtual"><scope>BMcond</scope><name>rvc</name></member>
170      <member refid="classBMcond_1d40c72250cf93640f982d06de20815b2" prot="public" virt="virtual"><scope>BMcond</scope><name>~BMcond</name></member>
171    </listofallmembers>
172  </compounddef>
173</doxygen>
Note: See TracBrowser for help on using the browser.