root/doc/xml/classepdf.xml @ 187

Revision 187, 19.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="classepdf" kind="class" prot="public">
4    <compoundname>epdf</compoundname>
5    <derivedcompoundref refid="classeEF" prot="public" virt="non-virtual">eEF</derivedcompoundref>
6    <derivedcompoundref refid="classeEmp" prot="public" virt="non-virtual">eEmp</derivedcompoundref>
7    <derivedcompoundref refid="classemix" prot="public" virt="non-virtual">emix</derivedcompoundref>
8    <derivedcompoundref refid="classeuni" prot="public" virt="non-virtual">euni</derivedcompoundref>
9    <derivedcompoundref refid="classMPF_1_1mpfepdf" prot="public" virt="non-virtual">MPF&lt; BM_T &gt;::mpfepdf</derivedcompoundref>
10    <includes refid="libBM_8h" local="no">libBM.h</includes>
11      <sectiondef kind="protected-attrib">
12      <memberdef kind="variable" id="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" static="no" mutable="no">
13        <type><ref refid="classRV" kindref="compound">RV</ref></type>
14        <definition>RV epdf::rv</definition>
15        <argsstring></argsstring>
16        <name>rv</name>
17        <briefdescription>
18<para>Identified of the random variable. </para>        </briefdescription>
19        <detaileddescription>
20        </detaileddescription>
21        <inbodydescription>
22        </inbodydescription>
23        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="138" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="138" bodyend="-1"/>
24        <referencedby refid="classepdf_14778ea61ef400813e47750e024e9fc2f" compoundref="libBM_8h" startline="164" endline="164">_rv</referencedby>
25        <referencedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef" compoundref="libEF_8cpp" startline="83" endline="92">egamma::evalpdflog</referencedby>
26        <referencedby refid="classegiw_1425cbc53b377274e28c6add942bab62d" compoundref="libEF_8cpp" startline="19" endline="29">egiw::evalpdflog</referencedby>
27        <referencedby refid="classegamma_1d6dbbdb72360f9e54d64501f80318bb6" compoundref="libEF_8cpp" startline="94" endline="103">egamma::lognc</referencedby>
28        <referencedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d" compoundref="libEF_8h" startline="334" endline="338">eEmp::mean</referencedby>
29        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="45" endline="49">emix::mean</referencedby>
30        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">euni::sample</referencedby>
31        <referencedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425" compoundref="libEF_8cpp" startline="55" endline="66">egamma::sample</referencedby>
32        <referencedby refid="classepdf_154d7dd53a641b618771cd9bee135181f" compoundref="libBM_8cpp" startline="113" endline="117">sampleN</referencedby>
33        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
34      </memberdef>
35      </sectiondef>
36      <sectiondef kind="public-func">
37      <memberdef kind="function" id="classepdf_1d8eb760037b3bad5a0d64081606697cd" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
38        <type></type>
39        <definition>epdf::epdf</definition>
40        <argsstring>()</argsstring>
41        <name>epdf</name>
42        <briefdescription>
43<para>default constructor </para>        </briefdescription>
44        <detaileddescription>
45        </detaileddescription>
46        <inbodydescription>
47        </inbodydescription>
48        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="141" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="141" bodyend="141"/>
49      </memberdef>
50      <memberdef kind="function" id="classepdf_1c95b1a27a8dd9507bb9a5a3cb2809c7a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
51        <type></type>
52        <definition>epdf::epdf</definition>
53        <argsstring>(const RV &amp;rv0)</argsstring>
54        <name>epdf</name>
55        <param>
56          <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
57          <declname>rv0</declname>
58        </param>
59        <briefdescription>
60<para>default constructor </para>        </briefdescription>
61        <detaileddescription>
62        </detaileddescription>
63        <inbodydescription>
64        </inbodydescription>
65        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="144" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="144" bodyend="144"/>
66      </memberdef>
67      <memberdef kind="function" id="classepdf_18019654e494bf5e458f6fb947e11b262" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
68        <type>vec</type>
69        <definition>virtual vec epdf::sample</definition>
70        <argsstring>() const =0</argsstring>
71        <name>sample</name>
72        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
73        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
74        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
75        <reimplementedby refid="classeEmp_183f9283f92b805508d896479dc1ccf12">sample</reimplementedby>
76        <reimplementedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd">sample</reimplementedby>
77        <reimplementedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425">sample</reimplementedby>
78        <reimplementedby refid="classegiw_13d2c1f2ba0f9966781f1e0ae695e8a6f">sample</reimplementedby>
79        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
80        <reimplementedby refid="classemix_10650601f24e633e0ab09aa1e46c14483">sample</reimplementedby>
81        <briefdescription>
82<para>Returns the required moment of the <ref refid="classepdf" kindref="compound">epdf</ref>. </para>        </briefdescription>
83        <detaileddescription>
84<para>Returns a sample, <formula id="28">$x$</formula> from density <formula id="59">$epdf(rv)$</formula> </para>        </detaileddescription>
85        <inbodydescription>
86        </inbodydescription>
87        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="149"/>
88        <referencedby refid="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" compoundref="libBM_8h" startline="184" endline="186">mpdf::samplecond</referencedby>
89        <referencedby refid="classPF_104d38fbcc0348b558212f530d9ec183e" compoundref="libPF_8cpp" startline="35" endline="41">PF::set_est</referencedby>
90        <referencedby refid="classeEmp_16606a656c1b28114f7384c25aaf80e8d" compoundref="libEF_8cpp" startline="199" endline="207">eEmp::set_parameters</referencedby>
91      </memberdef>
92      <memberdef kind="function" id="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
93        <type>mat</type>
94        <definition>mat epdf::sampleN</definition>
95        <argsstring>(int N) const </argsstring>
96        <name>sampleN</name>
97        <param>
98          <type>int</type>
99          <declname>N</declname>
100        </param>
101        <briefdescription>
102<para>Returns N samples from density <formula id="59">$epdf(rv)$</formula>. </para>        </briefdescription>
103        <detaileddescription>
104        </detaileddescription>
105        <inbodydescription>
106        </inbodydescription>
107        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="151" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.cpp" bodystart="113" bodyend="117"/>
108        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
109        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">rv</references>
110      </memberdef>
111      <memberdef kind="function" id="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
112        <type>double</type>
113        <definition>virtual double epdf::eval</definition>
114        <argsstring>(const vec &amp;val) const </argsstring>
115        <name>eval</name>
116        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
117        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
118        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
119        <reimplementedby refid="classeuni_12723d4992900b5c5495bfa03628195ed">eval</reimplementedby>
120        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
121        <param>
122          <type>const vec &amp;</type>
123          <declname>val</declname>
124        </param>
125        <briefdescription>
126<para>Compute probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
127        <detaileddescription>
128        </detaileddescription>
129        <inbodydescription>
130        </inbodydescription>
131        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="153" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="153" bodyend="153"/>
132        <references refid="classepdf_16aef3eca74899692503769c18add1a4c">evalpdflog</references>
133        <referencedby refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" compoundref="libBM_8h" startline="198" endline="198">mpdf::evalcond</referencedby>
134      </memberdef>
135      <memberdef kind="function" id="classepdf_16aef3eca74899692503769c18add1a4c" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
136        <type>double</type>
137        <definition>virtual double epdf::evalpdflog</definition>
138        <argsstring>(const vec &amp;val) const =0</argsstring>
139        <name>evalpdflog</name>
140        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
141        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
142        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
143        <reimplementedby refid="classeEmp_123e7358995400865ad2e278945922fb3">evalpdflog</reimplementedby>
144        <reimplementedby refid="classeuni_106af95d514a6623ad4688bd2ad50ad71">evalpdflog</reimplementedby>
145        <reimplementedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef">evalpdflog</reimplementedby>
146        <reimplementedby refid="classegiw_1425cbc53b377274e28c6add942bab62d">evalpdflog</reimplementedby>
147        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
148        <reimplementedby refid="classemix_1469e910479b3402589104ef3bb1b5741">evalpdflog</reimplementedby>
149        <param>
150          <type>const vec &amp;</type>
151          <declname>val</declname>
152        </param>
153        <briefdescription>
154<para>Compute log-probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
155        <detaileddescription>
156        </detaileddescription>
157        <inbodydescription>
158        </inbodydescription>
159        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="156"/>
160        <referencedby refid="classepdf_13ea597362e11a0040fe7c990269d072c" compoundref="libBM_8h" startline="153" endline="153">eval</referencedby>
161        <referencedby refid="classmpdf_13f172b79ec4a5ebc87898a5381141f1b" compoundref="libBM_8h" startline="184" endline="186">mpdf::samplecond</referencedby>
162      </memberdef>
163      <memberdef kind="function" id="classepdf_1bf0a070a8f3e67a93604ca724638b870" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
164        <type>vec</type>
165        <definition>virtual vec epdf::mean</definition>
166        <argsstring>() const =0</argsstring>
167        <name>mean</name>
168        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
169        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
170        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
171        <reimplementedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d">mean</reimplementedby>
172        <reimplementedby refid="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1">mean</reimplementedby>
173        <reimplementedby refid="classegamma_16ab5ba56f7cdb2e5921c3e77524fa50a">mean</reimplementedby>
174        <reimplementedby refid="classegiw_16deb0ff2859f41ef7cbdf6a842cabb29">mean</reimplementedby>
175        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
176        <reimplementedby refid="classemix_1b662a51d042b062020460e64bff4e9e8">mean</reimplementedby>
177        <briefdescription>
178<para>return expected value </para>        </briefdescription>
179        <detaileddescription>
180        </detaileddescription>
181        <inbodydescription>
182        </inbodydescription>
183        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="159"/>
184        <referencedby refid="sim__var_8cpp_1e66f6b31b5ad750f1fe042a706a4e3d4" compoundref="sim__var_8cpp" startline="28" endline="166">main</referencedby>
185      </memberdef>
186      <memberdef kind="function" id="classepdf_10a322dd106f04c0a2915e3d4f4227396" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
187        <type></type>
188        <definition>virtual epdf::~epdf</definition>
189        <argsstring>()</argsstring>
190        <name>~epdf</name>
191        <briefdescription>
192<para>Destructor for future use;. </para>        </briefdescription>
193        <detaileddescription>
194        </detaileddescription>
195        <inbodydescription>
196        </inbodydescription>
197        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="162" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="162" bodyend="162"/>
198      </memberdef>
199      <memberdef kind="function" id="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
200        <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
201        <definition>RV&amp; epdf::_rv</definition>
202        <argsstring>()</argsstring>
203        <name>_rv</name>
204        <briefdescription>
205<para>access function, possibly dangerous! </para>        </briefdescription>
206        <detaileddescription>
207        </detaileddescription>
208        <inbodydescription>
209        </inbodydescription>
210        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="164" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="164" bodyend="164"/>
211        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">rv</references>
212        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
213      </memberdef>
214      </sectiondef>
215    <briefdescription>
216<para>Probability density function with numerical statistics, e.g. posterior density. </para>    </briefdescription>
217    <detaileddescription>
218    </detaileddescription>
219    <inheritancegraph>
220      <node id="1015">
221        <label>enorm&lt; sq_T &gt;</label>
222        <link refid="classenorm"/>
223        <childnode refid="1012" relation="public-inheritance">
224        </childnode>
225      </node>
226      <node id="1011">
227        <label>epdf</label>
228        <link refid="classepdf"/>
229      </node>
230      <node id="1018">
231        <label>enorm&lt; fsqmat &gt;</label>
232        <link refid="classenorm"/>
233        <childnode refid="1015" relation="template-instance">
234          <edgelabel>&lt; fsqmat &gt;</edgelabel>
235        </childnode>
236        <childnode refid="1012" relation="public-inheritance">
237        </childnode>
238      </node>
239      <node id="1019">
240        <label>eEmp</label>
241        <link refid="classeEmp"/>
242        <childnode refid="1011" relation="public-inheritance">
243        </childnode>
244      </node>
245      <node id="1020">
246        <label>emix</label>
247        <link refid="classemix"/>
248        <childnode refid="1011" relation="public-inheritance">
249        </childnode>
250      </node>
251      <node id="1017">
252        <label>enorm&lt; chmat &gt;</label>
253        <link refid="classenorm"/>
254        <childnode refid="1015" relation="template-instance">
255          <edgelabel>&lt; chmat &gt;</edgelabel>
256        </childnode>
257        <childnode refid="1012" relation="public-inheritance">
258        </childnode>
259      </node>
260      <node id="1021">
261        <label>euni</label>
262        <link refid="classeuni"/>
263        <childnode refid="1011" relation="public-inheritance">
264        </childnode>
265      </node>
266      <node id="1016">
267        <label>enorm&lt; ldmat &gt;</label>
268        <link refid="classenorm"/>
269        <childnode refid="1015" relation="template-instance">
270          <edgelabel>&lt; ldmat &gt;</edgelabel>
271        </childnode>
272        <childnode refid="1012" relation="public-inheritance">
273        </childnode>
274      </node>
275      <node id="1013">
276        <label>egamma</label>
277        <link refid="classegamma"/>
278        <childnode refid="1012" relation="public-inheritance">
279        </childnode>
280      </node>
281      <node id="1012">
282        <label>eEF</label>
283        <link refid="classeEF"/>
284        <childnode refid="1011" relation="public-inheritance">
285        </childnode>
286      </node>
287      <node id="1022">
288        <label>MPF&lt; BM_T &gt;::mpfepdf</label>
289        <childnode refid="1011" relation="public-inheritance">
290        </childnode>
291      </node>
292      <node id="1014">
293        <label>egiw</label>
294        <link refid="classegiw"/>
295        <childnode refid="1012" relation="public-inheritance">
296        </childnode>
297      </node>
298    </inheritancegraph>
299    <collaborationgraph>
300      <node id="1023">
301        <label>epdf</label>
302        <link refid="classepdf"/>
303        <childnode refid="1024" relation="usage">
304          <edgelabel>rv</edgelabel>
305        </childnode>
306      </node>
307      <node id="1024">
308        <label>RV</label>
309        <link refid="classRV"/>
310      </node>
311    </collaborationgraph>
312    <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="135" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="135" bodyend="165"/>
313    <listofallmembers>
314      <member refid="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" virt="non-virtual"><scope>epdf</scope><name>_rv</name></member>
315      <member refid="classepdf_1d8eb760037b3bad5a0d64081606697cd" prot="public" virt="non-virtual"><scope>epdf</scope><name>epdf</name></member>
316      <member refid="classepdf_1c95b1a27a8dd9507bb9a5a3cb2809c7a" prot="public" virt="non-virtual"><scope>epdf</scope><name>epdf</name></member>
317      <member refid="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" virt="virtual"><scope>epdf</scope><name>eval</name></member>
318      <member refid="classepdf_16aef3eca74899692503769c18add1a4c" prot="public" virt="pure-virtual"><scope>epdf</scope><name>evalpdflog</name></member>
319      <member refid="classepdf_1bf0a070a8f3e67a93604ca724638b870" prot="public" virt="pure-virtual"><scope>epdf</scope><name>mean</name></member>
320      <member refid="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" virt="non-virtual"><scope>epdf</scope><name>rv</name></member>
321      <member refid="classepdf_18019654e494bf5e458f6fb947e11b262" prot="public" virt="pure-virtual"><scope>epdf</scope><name>sample</name></member>
322      <member refid="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" virt="virtual"><scope>epdf</scope><name>sampleN</name></member>
323      <member refid="classepdf_10a322dd106f04c0a2915e3d4f4227396" prot="public" virt="virtual"><scope>epdf</scope><name>~epdf</name></member>
324    </listofallmembers>
325  </compounddef>
326</doxygen>
Note: See TracBrowser for help on using the browser.