root/doc/xml/classmEF.xml @ 266

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