root/doc/xml/classmepdf.xml @ 187

Revision 187, 20.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="classmepdf" kind="class" prot="public">
4    <compoundname>mepdf</compoundname>
5    <basecompoundref refid="classmpdf" prot="public" virt="non-virtual">mpdf</basecompoundref>
6    <includes refid="libBM_8h" local="no">libBM.h</includes>
7      <sectiondef kind="public-func">
8      <memberdef kind="function" id="classmepdf_17ab1c50f0aa16230117436dee500f2e0" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
9        <type></type>
10        <definition>mepdf::mepdf</definition>
11        <argsstring>(epdf &amp;em)</argsstring>
12        <name>mepdf</name>
13        <param>
14          <type><ref refid="classepdf" kindref="compound">epdf</ref> &amp;</type>
15          <declname>em</declname>
16        </param>
17        <briefdescription>
18<para>Default constructor. </para>        </briefdescription>
19        <detaileddescription>
20        </detaileddescription>
21        <inbodydescription>
22        </inbodydescription>
23        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="220" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="220" bodyend="220"/>
24        <references refid="classmpdf_17aa894208a32f3487827df6d5054424c" compoundref="libBM_8h" startline="178">mpdf::ep</references>
25      </memberdef>
26      <memberdef kind="function" id="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
27        <type>vec</type>
28        <definition>virtual vec mpdf::samplecond</definition>
29        <argsstring>(const vec &amp;cond, double &amp;ll)</argsstring>
30        <name>samplecond</name>
31        <param>
32          <type>const vec &amp;</type>
33          <declname>cond</declname>
34        </param>
35        <param>
36          <type>double &amp;</type>
37          <declname>ll</declname>
38        </param>
39        <briefdescription>
40<para>Returns the required moment of the <ref refid="classepdf" kindref="compound">epdf</ref>. </para>        </briefdescription>
41        <detaileddescription>
42<para>Returns a sample from the density conditioned on <computeroutput>cond</computeroutput>, <formula id="10">$x \sim epdf(rv|cond)$</formula>. <parameterlist kind="param"><parameteritem>
43<parameternamelist>
44<parametername>cond</parametername>
45</parameternamelist>
46<parameterdescription>
47<para>is numeric value of <computeroutput>rv</computeroutput> </para></parameterdescription>
48</parameteritem>
49<parameteritem>
50<parameternamelist>
51<parametername>ll</parametername>
52</parameternamelist>
53<parameterdescription>
54<para>is a return value of log-likelihood of the sample. </para></parameterdescription>
55</parameteritem>
56</parameterlist>
57</para>        </detaileddescription>
58        <inbodydescription>
59        </inbodydescription>
60        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="184" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="184" bodyend="186"/>
61        <references refid="classmpdf_10f95a0cc6ab40611f46804682446ed83" compoundref="libBM_8h" startline="195" endline="195">mpdf::condition</references>
62        <references refid="classmpdf_17aa894208a32f3487827df6d5054424c" compoundref="libBM_8h" startline="178">mpdf::ep</references>
63        <references refid="classepdf_16aef3eca74899692503769c18add1a4c">epdf::evalpdflog</references>
64        <references refid="classepdf_18019654e494bf5e458f6fb947e11b262">epdf::sample</references>
65        <referencedby refid="classMPF_155daf8e4b6553dd9f47c692de7931623" compoundref="libPF_8h" startline="137" endline="205">MPF&lt; BM_T &gt;::bayes</referencedby>
66        <referencedby refid="classPF_164f636bbd63bea9efd778214e6b631d3" compoundref="libPF_8cpp" startline="7" endline="33">PF::bayes</referencedby>
67      </memberdef>
68      <memberdef kind="function" id="classmpdf_10e37163660f93df2a4d723cedb1da89c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
69        <type>mat</type>
70        <definition>virtual mat mpdf::samplecond</definition>
71        <argsstring>(const vec &amp;cond, vec &amp;ll, int N)</argsstring>
72        <name>samplecond</name>
73        <param>
74          <type>const vec &amp;</type>
75          <declname>cond</declname>
76        </param>
77        <param>
78          <type>vec &amp;</type>
79          <declname>ll</declname>
80        </param>
81        <param>
82          <type>int</type>
83          <declname>N</declname>
84        </param>
85        <briefdescription>
86<para>Returns. </para>        </briefdescription>
87        <detaileddescription>
88<para><parameterlist kind="param"><parameteritem>
89<parameternamelist>
90<parametername>N</parametername>
91</parameternamelist>
92<parameterdescription>
93<para>samples from the density conditioned on <computeroutput>cond</computeroutput>, <formula id="10">$x \sim epdf(rv|cond)$</formula>. </para></parameterdescription>
94</parameteritem>
95<parameteritem>
96<parameternamelist>
97<parametername>cond</parametername>
98</parameternamelist>
99<parameterdescription>
100<para>is numeric value of <computeroutput>rv</computeroutput> </para></parameterdescription>
101</parameteritem>
102<parameteritem>
103<parameternamelist>
104<parametername>ll</parametername>
105</parameternamelist>
106<parameterdescription>
107<para>is a return value of log-likelihood of the sample. </para></parameterdescription>
108</parameteritem>
109</parameterlist>
110</para>        </detaileddescription>
111        <inbodydescription>
112        </inbodydescription>
113        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="188" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="188" bodyend="193"/>
114        <references refid="classmpdf_10f95a0cc6ab40611f46804682446ed83" compoundref="libBM_8h" startline="195" endline="195">mpdf::condition</references>
115        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
116        <references refid="classmpdf_17aa894208a32f3487827df6d5054424c" compoundref="libBM_8h" startline="178">mpdf::ep</references>
117        <references refid="classepdf_16aef3eca74899692503769c18add1a4c">epdf::evalpdflog</references>
118        <references refid="classmpdf_1f6687c07ff07d47812dd565368ca59eb" compoundref="libBM_8h" startline="174">mpdf::rv</references>
119        <references refid="classepdf_18019654e494bf5e458f6fb947e11b262">epdf::sample</references>
120      </memberdef>
121      <memberdef kind="function" id="classmpdf_10f95a0cc6ab40611f46804682446ed83" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
122        <type>void</type>
123        <definition>virtual void mpdf::condition</definition>
124        <argsstring>(const vec &amp;cond)</argsstring>
125        <name>condition</name>
126        <reimplementedby refid="classmgamma__fix_16ea3931eec7b7da7b693e45981052460">condition</reimplementedby>
127        <reimplementedby refid="classmgamma_1a61094c9f7a2d64ea77b130cbc031f97">condition</reimplementedby>
128        <reimplementedby refid="classmmix_11a66629ec5c2b6f4740606cf737f0193">condition</reimplementedby>
129        <param>
130          <type>const vec &amp;</type>
131          <declname>cond</declname>
132        </param>
133        <briefdescription>
134<para>Update <computeroutput>ep</computeroutput> so that it represents this <ref refid="classmpdf" kindref="compound">mpdf</ref> conditioned on <computeroutput>rvc</computeroutput> = cond. </para>        </briefdescription>
135        <detaileddescription>
136        </detaileddescription>
137        <inbodydescription>
138        </inbodydescription>
139        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="195" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="195" bodyend="195"/>
140        <referencedby refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" compoundref="libBM_8h" startline="198" endline="198">mpdf::evalcond</referencedby>
141        <referencedby refid="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" compoundref="libBM_8h" startline="184" endline="186">mpdf::samplecond</referencedby>
142      </memberdef>
143      <memberdef kind="function" id="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
144        <type>double</type>
145        <definition>virtual double mpdf::evalcond</definition>
146        <argsstring>(const vec &amp;dt, const vec &amp;cond)</argsstring>
147        <name>evalcond</name>
148        <param>
149          <type>const vec &amp;</type>
150          <declname>dt</declname>
151        </param>
152        <param>
153          <type>const vec &amp;</type>
154          <declname>cond</declname>
155        </param>
156        <briefdescription>
157<para>Shortcut for conditioning and evaluation of the internal <ref refid="classepdf" kindref="compound">epdf</ref>. In some cases, this operation can be implemented efficiently. </para>        </briefdescription>
158        <detaileddescription>
159        </detaileddescription>
160        <inbodydescription>
161        </inbodydescription>
162        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="198" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="198" bodyend="198"/>
163        <references refid="classmpdf_10f95a0cc6ab40611f46804682446ed83" compoundref="libBM_8h" startline="195" endline="195">mpdf::condition</references>
164        <references refid="classmpdf_17aa894208a32f3487827df6d5054424c" compoundref="libBM_8h" startline="178">mpdf::ep</references>
165        <references refid="classepdf_13ea597362e11a0040fe7c990269d072c" compoundref="libBM_8h" startline="153" endline="153">epdf::eval</references>
166        <referencedby refid="classPF_164f636bbd63bea9efd778214e6b631d3" compoundref="libPF_8cpp" startline="7" endline="33">PF::bayes</referencedby>
167      </memberdef>
168      <memberdef kind="function" id="classmpdf_1ec9c850305984582548e8deb64f0ffe8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
169        <type><ref refid="classRV" kindref="compound">RV</ref></type>
170        <definition>RV mpdf::_rvc</definition>
171        <argsstring>()</argsstring>
172        <name>_rvc</name>
173        <briefdescription>
174<para>access function </para>        </briefdescription>
175        <detaileddescription>
176        </detaileddescription>
177        <inbodydescription>
178        </inbodydescription>
179        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="206" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="206" bodyend="206"/>
180        <references refid="classmpdf_1acb7dda792b3cd5576f39fa3129abbab" compoundref="libBM_8h" startline="176">mpdf::rvc</references>
181        <referencedby refid="classmerger_11a6a721294321c2e412ca0084c636b69" compoundref="merger_8h" startline="36" endline="38">merger::merger</referencedby>
182      </memberdef>
183      <memberdef kind="function" id="classmpdf_11e71ad4c66d5884c82d4a3b06b42fe32" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
184        <type><ref refid="classRV" kindref="compound">RV</ref></type>
185        <definition>RV mpdf::_rv</definition>
186        <argsstring>()</argsstring>
187        <name>_rv</name>
188        <briefdescription>
189<para>access function </para>        </briefdescription>
190        <detaileddescription>
191        </detaileddescription>
192        <inbodydescription>
193        </inbodydescription>
194        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="208" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="208" bodyend="208"/>
195        <references refid="classmpdf_1f6687c07ff07d47812dd565368ca59eb" compoundref="libBM_8h" startline="174">mpdf::rv</references>
196        <referencedby refid="classmprod_1419b303581a91ad85200bdcb4b3186f4" compoundref="emix_8h" startline="90" endline="115">mprod::mprod</referencedby>
197      </memberdef>
198      <memberdef kind="function" id="classmpdf_1e17780ee5b2cfe05922a6c56af1462f8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
199        <type><ref refid="classepdf" kindref="compound">epdf</ref> &amp;</type>
200        <definition>epdf&amp; mpdf::_epdf</definition>
201        <argsstring>()</argsstring>
202        <name>_epdf</name>
203        <briefdescription>
204<para>access function </para>        </briefdescription>
205        <detaileddescription>
206        </detaileddescription>
207        <inbodydescription>
208        </inbodydescription>
209        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="210" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="210" bodyend="210"/>
210        <references refid="classmpdf_17aa894208a32f3487827df6d5054424c" compoundref="libBM_8h" startline="178">mpdf::ep</references>
211      </memberdef>
212      </sectiondef>
213      <sectiondef kind="protected-attrib">
214      <memberdef kind="variable" id="classmpdf_1f6687c07ff07d47812dd565368ca59eb" prot="protected" static="no" mutable="no">
215        <type><ref refid="classRV" kindref="compound">RV</ref></type>
216        <definition>RV mpdf::rv</definition>
217        <argsstring></argsstring>
218        <name>rv</name>
219        <briefdescription>
220<para>modeled random variable </para>        </briefdescription>
221        <detaileddescription>
222        </detaileddescription>
223        <inbodydescription>
224        </inbodydescription>
225        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="174" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="174" bodyend="-1"/>
226        <referencedby refid="classmpdf_11e71ad4c66d5884c82d4a3b06b42fe32" compoundref="libBM_8h" startline="208" endline="208">mpdf::_rv</referencedby>
227        <referencedby refid="classmprod_1419b303581a91ad85200bdcb4b3186f4" compoundref="emix_8h" startline="90" endline="115">mprod::mprod</referencedby>
228        <referencedby refid="classmlnorm_1215fb88cc8b95d64cdefd6849abdd1e8" compoundref="libEF_8h" startline="430" endline="444">mlnorm&lt; sq_T &gt;::samplecond</referencedby>
229        <referencedby refid="classmpdf_10e37163660f93df2a4d723cedb1da89c" compoundref="libBM_8h" startline="188" endline="193">mpdf::samplecond</referencedby>
230        <referencedby refid="classmlnorm_1b6749030c5d5abcb3eb6898f74cea3c0" compoundref="libEF_8h" startline="416" endline="419">mlnorm&lt; sq_T &gt;::set_parameters</referencedby>
231        <referencedby refid="classmgamma_1a9d646cf758a70126dde7c48790b6e94" compoundref="libEF_8cpp" startline="108" endline="112">mgamma::set_parameters</referencedby>
232      </memberdef>
233      <memberdef kind="variable" id="classmpdf_1acb7dda792b3cd5576f39fa3129abbab" prot="protected" static="no" mutable="no">
234        <type><ref refid="classRV" kindref="compound">RV</ref></type>
235        <definition>RV mpdf::rvc</definition>
236        <argsstring></argsstring>
237        <name>rvc</name>
238        <briefdescription>
239<para>random variable in condition </para>        </briefdescription>
240        <detaileddescription>
241        </detaileddescription>
242        <inbodydescription>
243        </inbodydescription>
244        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="176" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="176" bodyend="-1"/>
245        <referencedby refid="classmpdf_1ec9c850305984582548e8deb64f0ffe8" compoundref="libBM_8h" startline="206" endline="206">mpdf::_rvc</referencedby>
246        <referencedby refid="classmprod_1419b303581a91ad85200bdcb4b3186f4" compoundref="emix_8h" startline="90" endline="115">mprod::mprod</referencedby>
247      </memberdef>
248      <memberdef kind="variable" id="classmpdf_17aa894208a32f3487827df6d5054424c" prot="protected" static="no" mutable="no">
249        <type><ref refid="classepdf" kindref="compound">epdf</ref> *</type>
250        <definition>epdf* mpdf::ep</definition>
251        <argsstring></argsstring>
252        <name>ep</name>
253        <briefdescription>
254<para>pointer to internal <ref refid="classepdf" kindref="compound">epdf</ref> </para>        </briefdescription>
255        <detaileddescription>
256        </detaileddescription>
257        <inbodydescription>
258        </inbodydescription>
259        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="178" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="178" bodyend="-1"/>
260        <referencedby refid="classmpdf_1e17780ee5b2cfe05922a6c56af1462f8" compoundref="libBM_8h" startline="210" endline="210">mpdf::_epdf</referencedby>
261        <referencedby refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" compoundref="libBM_8h" startline="198" endline="198">mpdf::evalcond</referencedby>
262        <referencedby refid="classmepdf_17ab1c50f0aa16230117436dee500f2e0" compoundref="libBM_8h" startline="220" endline="220">mepdf</referencedby>
263        <referencedby refid="classmlnorm_1f927203b3f31171c5c10ffc7caa797f5" compoundref="libEF_8h" startline="412" endline="413">mlnorm&lt; sq_T &gt;::mlnorm</referencedby>
264        <referencedby refid="classmmix_16769a962f1f4d0ecc5b903b5f7d26ad3" compoundref="emix_8h" startline="178" endline="178">mmix::mmix</referencedby>
265        <referencedby refid="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" compoundref="libBM_8h" startline="184" endline="186">mpdf::samplecond</referencedby>
266        <referencedby refid="classmgamma_1a9d646cf758a70126dde7c48790b6e94" compoundref="libEF_8cpp" startline="108" endline="112">mgamma::set_parameters</referencedby>
267      </memberdef>
268      </sectiondef>
269    <briefdescription>
270<para>Unconditional <ref refid="classmpdf" kindref="compound">mpdf</ref>, allows using <ref refid="classepdf" kindref="compound">epdf</ref> in the role of <ref refid="classmpdf" kindref="compound">mpdf</ref>. </para>    </briefdescription>
271    <detaileddescription>
272<para>WARNING: the class does not check validity of the <computeroutput>ep</computeroutput> pointer nor its existence. </para>    </detaileddescription>
273    <inheritancegraph>
274      <node id="1185">
275        <label>mpdf</label>
276        <link refid="classmpdf"/>
277      </node>
278      <node id="1184">
279        <label>mepdf</label>
280        <link refid="classmepdf"/>
281        <childnode refid="1185" relation="public-inheritance">
282        </childnode>
283      </node>
284    </inheritancegraph>
285    <collaborationgraph>
286      <node id="1189">
287        <label>epdf</label>
288        <link refid="classepdf"/>
289        <childnode refid="1188" relation="usage">
290          <edgelabel>rv</edgelabel>
291        </childnode>
292      </node>
293      <node id="1188">
294        <label>RV</label>
295        <link refid="classRV"/>
296      </node>
297      <node id="1187">
298        <label>mpdf</label>
299        <link refid="classmpdf"/>
300        <childnode refid="1188" relation="usage">
301          <edgelabel>rv
302rvc</edgelabel>
303        </childnode>
304        <childnode refid="1189" relation="usage">
305          <edgelabel>ep</edgelabel>
306        </childnode>
307      </node>
308      <node id="1186">
309        <label>mepdf</label>
310        <link refid="classmepdf"/>
311        <childnode refid="1187" relation="public-inheritance">
312        </childnode>
313      </node>
314    </collaborationgraph>
315    <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="217" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="217" bodyend="221"/>
316    <listofallmembers>
317      <member refid="classmpdf_1e17780ee5b2cfe05922a6c56af1462f8" prot="public" virt="non-virtual"><scope>mepdf</scope><name>_epdf</name></member>
318      <member refid="classmpdf_11e71ad4c66d5884c82d4a3b06b42fe32" prot="public" virt="non-virtual"><scope>mepdf</scope><name>_rv</name></member>
319      <member refid="classmpdf_1ec9c850305984582548e8deb64f0ffe8" prot="public" virt="non-virtual"><scope>mepdf</scope><name>_rvc</name></member>
320      <member refid="classmpdf_10f95a0cc6ab40611f46804682446ed83" prot="public" virt="virtual"><scope>mepdf</scope><name>condition</name></member>
321      <member refid="classmpdf_17aa894208a32f3487827df6d5054424c" prot="protected" virt="non-virtual"><scope>mepdf</scope><name>ep</name></member>
322      <member refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" prot="public" virt="virtual"><scope>mepdf</scope><name>evalcond</name></member>
323      <member refid="classmepdf_17ab1c50f0aa16230117436dee500f2e0" prot="public" virt="non-virtual"><scope>mepdf</scope><name>mepdf</name></member>
324      <member refid="classmpdf_1581ecf362185d37c08bb31cb9d046d6f" prot="public" virt="non-virtual"><scope>mepdf</scope><name>mpdf</name></member>
325      <member refid="classmpdf_1f6687c07ff07d47812dd565368ca59eb" prot="protected" virt="non-virtual"><scope>mepdf</scope><name>rv</name></member>
326      <member refid="classmpdf_1acb7dda792b3cd5576f39fa3129abbab" prot="protected" virt="non-virtual"><scope>mepdf</scope><name>rvc</name></member>
327      <member refid="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" prot="public" virt="virtual"><scope>mepdf</scope><name>samplecond</name></member>
328      <member refid="classmpdf_10e37163660f93df2a4d723cedb1da89c" prot="public" virt="virtual"><scope>mepdf</scope><name>samplecond</name></member>
329      <member refid="classmpdf_16788be9f3a888796499c5293a318fcfb" prot="public" virt="virtual"><scope>mepdf</scope><name>~mpdf</name></member>
330    </listofallmembers>
331  </compounddef>
332</doxygen>
Note: See TracBrowser for help on using the browser.