root/doc/xml/classeprod.xml @ 222

Revision 187, 18.5 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="classeprod" kind="class" prot="public">
4    <compoundname>eprod</compoundname>
5    <basecompoundref refid="classepdf" prot="public" virt="non-virtual">epdf</basecompoundref>
6    <includes refid="emix_8h" local="no">emix.h</includes>
7      <sectiondef kind="protected-attrib">
8      <memberdef kind="variable" id="classeprod_15307a27aaf48be8213294b05ac533c39" prot="protected" static="no" mutable="no">
9        <type>Array&lt; <ref refid="classepdf" kindref="compound">epdf</ref> * &gt;</type>
10        <definition>Array&lt;epdf*&gt; eprod::epdfs</definition>
11        <argsstring></argsstring>
12        <name>epdfs</name>
13        <briefdescription>
14        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="76" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="76" bodyend="-1"/>
20      </memberdef>
21      <memberdef kind="variable" id="classeprod_1a4387c81276ca66c1ca9336cf8bf74a8" prot="protected" static="no" mutable="no">
22        <type>Array&lt; <ref refid="classmpdf" kindref="compound">mpdf</ref> * &gt;</type>
23        <definition>Array&lt;mpdf*&gt; eprod::mpdfs</definition>
24        <argsstring></argsstring>
25        <name>mpdfs</name>
26        <briefdescription>
27        </briefdescription>
28        <detaileddescription>
29        </detaileddescription>
30        <inbodydescription>
31        </inbodydescription>
32        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="77" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="77" bodyend="-1"/>
33      </memberdef>
34      <memberdef kind="variable" id="classeprod_168b66b05b3b6987472247f541846a366" prot="protected" static="no" mutable="no">
35        <type>ivec</type>
36        <definition>ivec eprod::sizes</definition>
37        <argsstring></argsstring>
38        <name>sizes</name>
39        <briefdescription>
40        </briefdescription>
41        <detaileddescription>
42        </detaileddescription>
43        <inbodydescription>
44        </inbodydescription>
45        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="78" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="78" bodyend="-1"/>
46      </memberdef>
47      <memberdef kind="variable" id="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" static="no" mutable="no">
48        <type><ref refid="classRV" kindref="compound">RV</ref></type>
49        <definition>RV epdf::rv</definition>
50        <argsstring></argsstring>
51        <name>rv</name>
52        <briefdescription>
53<para>Identified of the random variable. </para>        </briefdescription>
54        <detaileddescription>
55        </detaileddescription>
56        <inbodydescription>
57        </inbodydescription>
58        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="123" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="123" bodyend="-1"/>
59        <referencedby refid="classepdf_1b89143f12c9b49282e30841e4fb5f337" compoundref="libBM_8h" startline="149" endline="149">epdf::_rv</referencedby>
60        <referencedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef" compoundref="libEF_8cpp" startline="83" endline="92">egamma::evalpdflog</referencedby>
61        <referencedby refid="classegiw_1425cbc53b377274e28c6add942bab62d" compoundref="libEF_8cpp" startline="19" endline="29">egiw::evalpdflog</referencedby>
62        <referencedby refid="classegamma_1d6dbbdb72360f9e54d64501f80318bb6" compoundref="libEF_8cpp" startline="94" endline="103">egamma::lognc</referencedby>
63        <referencedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d" compoundref="libEF_8h" startline="338" endline="342">eEmp::mean</referencedby>
64        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="46" endline="51">emix::mean</referencedby>
65        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">euni::sample</referencedby>
66        <referencedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425" compoundref="libEF_8cpp" startline="55" endline="66">egamma::sample</referencedby>
67        <referencedby refid="classepdf_154d7dd53a641b618771cd9bee135181f" compoundref="libBM_8cpp" startline="74" endline="78">epdf::sampleN</referencedby>
68        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
69      </memberdef>
70      </sectiondef>
71      <sectiondef kind="public-func">
72      <memberdef kind="function" id="classeprod_16c76cb1658c345cc30374c340608006c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
73        <type></type>
74        <definition>eprod::eprod</definition>
75        <argsstring>(Array&lt; epdf &gt; Facs)</argsstring>
76        <name>eprod</name>
77        <param>
78          <type>Array&lt; <ref refid="classepdf" kindref="compound">epdf</ref> &gt;</type>
79          <declname>Facs</declname>
80        </param>
81        <briefdescription>
82        </briefdescription>
83        <detaileddescription>
84        </detaileddescription>
85        <inbodydescription>
86        </inbodydescription>
87        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="80" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="80" bodyend="82"/>
88      </memberdef>
89      <memberdef kind="function" id="classepdf_18019654e494bf5e458f6fb947e11b262" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
90        <type>vec</type>
91        <definition>virtual vec epdf::sample</definition>
92        <argsstring>() const =0</argsstring>
93        <name>sample</name>
94        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
95        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
96        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
97        <reimplementedby refid="classeEmp_183f9283f92b805508d896479dc1ccf12">sample</reimplementedby>
98        <reimplementedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd">sample</reimplementedby>
99        <reimplementedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425">sample</reimplementedby>
100        <reimplementedby refid="classegiw_13d2c1f2ba0f9966781f1e0ae695e8a6f">sample</reimplementedby>
101        <reimplementedby refid="classenorm_160b47544f6181ffd4530d3e415ce12c5">sample</reimplementedby>
102        <reimplementedby refid="classemix_10650601f24e633e0ab09aa1e46c14483">sample</reimplementedby>
103        <briefdescription>
104<para>Returns the required moment of the <ref refid="classepdf" kindref="compound">epdf</ref>. </para>        </briefdescription>
105        <detaileddescription>
106<para>Returns a sample, <formula id="28">$x$</formula> from density <formula id="59">$epdf(rv)$</formula> </para>        </detaileddescription>
107        <inbodydescription>
108        </inbodydescription>
109        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="134"/>
110        <referencedby refid="classmpdf_1b0193a350c97933ddf15b15a130da352" compoundref="libBM_8h" startline="169" endline="171">mpdf::samplecond</referencedby>
111        <referencedby refid="classPF_104d38fbcc0348b558212f530d9ec183e" compoundref="libPF_8cpp" startline="35" endline="41">PF::set_est</referencedby>
112        <referencedby refid="classeEmp_16606a656c1b28114f7384c25aaf80e8d" compoundref="libEF_8cpp" startline="223" endline="231">eEmp::set_parameters</referencedby>
113      </memberdef>
114      <memberdef kind="function" id="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
115        <type>mat</type>
116        <definition>mat epdf::sampleN</definition>
117        <argsstring>(int N) const </argsstring>
118        <name>sampleN</name>
119        <param>
120          <type>int</type>
121          <declname>N</declname>
122        </param>
123        <briefdescription>
124<para>Returns N samples from density <formula id="59">$epdf(rv)$</formula>. </para>        </briefdescription>
125        <detaileddescription>
126        </detaileddescription>
127        <inbodydescription>
128        </inbodydescription>
129        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="136" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.cpp" bodystart="74" bodyend="78"/>
130        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="57" endline="57">RV::count</references>
131        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="123">epdf::rv</references>
132      </memberdef>
133      <memberdef kind="function" id="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
134        <type>double</type>
135        <definition>virtual double epdf::eval</definition>
136        <argsstring>(const vec &amp;val) const </argsstring>
137        <name>eval</name>
138        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
139        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
140        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
141        <reimplementedby refid="classeuni_12723d4992900b5c5495bfa03628195ed">eval</reimplementedby>
142        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
143        <param>
144          <type>const vec &amp;</type>
145          <declname>val</declname>
146        </param>
147        <briefdescription>
148<para>Compute probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
149        <detaileddescription>
150        </detaileddescription>
151        <inbodydescription>
152        </inbodydescription>
153        <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="138"/>
154        <references refid="classepdf_16aef3eca74899692503769c18add1a4c">epdf::evalpdflog</references>
155        <referencedby refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" compoundref="libBM_8h" startline="183" endline="183">mpdf::evalcond</referencedby>
156      </memberdef>
157      <memberdef kind="function" id="classepdf_16aef3eca74899692503769c18add1a4c" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
158        <type>double</type>
159        <definition>virtual double epdf::evalpdflog</definition>
160        <argsstring>(const vec &amp;val) const =0</argsstring>
161        <name>evalpdflog</name>
162        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
163        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
164        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
165        <reimplementedby refid="classeEmp_123e7358995400865ad2e278945922fb3">evalpdflog</reimplementedby>
166        <reimplementedby refid="classeuni_106af95d514a6623ad4688bd2ad50ad71">evalpdflog</reimplementedby>
167        <reimplementedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef">evalpdflog</reimplementedby>
168        <reimplementedby refid="classegiw_1425cbc53b377274e28c6add942bab62d">evalpdflog</reimplementedby>
169        <reimplementedby refid="classenorm_1609a7c33dbb4fdfab050f3bdd1122401">evalpdflog</reimplementedby>
170        <reimplementedby refid="classemix_1469e910479b3402589104ef3bb1b5741">evalpdflog</reimplementedby>
171        <param>
172          <type>const vec &amp;</type>
173          <declname>val</declname>
174        </param>
175        <briefdescription>
176<para>Compute log-probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
177        <detaileddescription>
178        </detaileddescription>
179        <inbodydescription>
180        </inbodydescription>
181        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="141"/>
182        <referencedby refid="classepdf_13ea597362e11a0040fe7c990269d072c" compoundref="libBM_8h" startline="138" endline="138">epdf::eval</referencedby>
183        <referencedby refid="classmpdf_1b0193a350c97933ddf15b15a130da352" compoundref="libBM_8h" startline="169" endline="171">mpdf::samplecond</referencedby>
184      </memberdef>
185      <memberdef kind="function" id="classepdf_1bf0a070a8f3e67a93604ca724638b870" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
186        <type>vec</type>
187        <definition>virtual vec epdf::mean</definition>
188        <argsstring>() const =0</argsstring>
189        <name>mean</name>
190        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
191        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
192        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
193        <reimplementedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d">mean</reimplementedby>
194        <reimplementedby refid="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1">mean</reimplementedby>
195        <reimplementedby refid="classegamma_16ab5ba56f7cdb2e5921c3e77524fa50a">mean</reimplementedby>
196        <reimplementedby refid="classegiw_16deb0ff2859f41ef7cbdf6a842cabb29">mean</reimplementedby>
197        <reimplementedby refid="classenorm_150fa84da7bae02f7af17a98f37566899">mean</reimplementedby>
198        <reimplementedby refid="classemix_1b662a51d042b062020460e64bff4e9e8">mean</reimplementedby>
199        <briefdescription>
200<para>return expected value </para>        </briefdescription>
201        <detaileddescription>
202        </detaileddescription>
203        <inbodydescription>
204        </inbodydescription>
205        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="144"/>
206        <referencedby refid="sim__var_8cpp_1e66f6b31b5ad750f1fe042a706a4e3d4" compoundref="sim__var_8cpp" startline="28" endline="166">main</referencedby>
207      </memberdef>
208      <memberdef kind="function" id="classepdf_1b89143f12c9b49282e30841e4fb5f337" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
209        <type><ref refid="classRV" kindref="compound">RV</ref></type>
210        <definition>RV epdf::_rv</definition>
211        <argsstring>() const </argsstring>
212        <name>_rv</name>
213        <briefdescription>
214<para>access function </para>        </briefdescription>
215        <detaileddescription>
216        </detaileddescription>
217        <inbodydescription>
218        </inbodydescription>
219        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="149" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="149" bodyend="149"/>
220        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="123">epdf::rv</references>
221        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
222      </memberdef>
223      </sectiondef>
224    <briefdescription>
225<para>Chain rule decomposition of <ref refid="classepdf" kindref="compound">epdf</ref>. </para>    </briefdescription>
226    <detaileddescription>
227<para>Probability density in the form of Chain-rule decomposition: \[ f(x_1,x_2,x_3) = f(x_1|x_2,x_3)f(x_2,x_3)f(x_3) \] Note that </para>    </detaileddescription>
228    <inheritancegraph>
229      <node id="870">
230        <label>epdf</label>
231        <link refid="classepdf"/>
232      </node>
233      <node id="869">
234        <label>eprod</label>
235        <link refid="classeprod"/>
236        <childnode refid="870" relation="public-inheritance">
237        </childnode>
238      </node>
239    </inheritancegraph>
240    <collaborationgraph>
241      <node id="872">
242        <label>epdf</label>
243        <link refid="classepdf"/>
244        <childnode refid="873" relation="usage">
245          <edgelabel>rv</edgelabel>
246        </childnode>
247      </node>
248      <node id="873">
249        <label>RV</label>
250        <link refid="classRV"/>
251      </node>
252      <node id="871">
253        <label>eprod</label>
254        <link refid="classeprod"/>
255        <childnode refid="872" relation="public-inheritance">
256        </childnode>
257      </node>
258    </collaborationgraph>
259    <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="74" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="73" bodyend="84"/>
260    <listofallmembers>
261      <member refid="classepdf_1b89143f12c9b49282e30841e4fb5f337" prot="public" virt="non-virtual"><scope>eprod</scope><name>_rv</name></member>
262      <member refid="classepdf_1d8eb760037b3bad5a0d64081606697cd" prot="public" virt="non-virtual"><scope>eprod</scope><name>epdf</name></member>
263      <member refid="classepdf_1c95b1a27a8dd9507bb9a5a3cb2809c7a" prot="public" virt="non-virtual"><scope>eprod</scope><name>epdf</name></member>
264      <member refid="classeprod_15307a27aaf48be8213294b05ac533c39" prot="protected" virt="non-virtual"><scope>eprod</scope><name>epdfs</name></member>
265      <member refid="classeprod_16c76cb1658c345cc30374c340608006c" prot="public" virt="non-virtual"><scope>eprod</scope><name>eprod</name></member>
266      <member refid="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" virt="virtual"><scope>eprod</scope><name>eval</name></member>
267      <member refid="classepdf_16aef3eca74899692503769c18add1a4c" prot="public" virt="pure-virtual"><scope>eprod</scope><name>evalpdflog</name></member>
268      <member refid="classepdf_1bf0a070a8f3e67a93604ca724638b870" prot="public" virt="pure-virtual"><scope>eprod</scope><name>mean</name></member>
269      <member refid="classeprod_1a4387c81276ca66c1ca9336cf8bf74a8" prot="protected" virt="non-virtual"><scope>eprod</scope><name>mpdfs</name></member>
270      <member refid="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" virt="non-virtual"><scope>eprod</scope><name>rv</name></member>
271      <member refid="classepdf_18019654e494bf5e458f6fb947e11b262" prot="public" virt="pure-virtual"><scope>eprod</scope><name>sample</name></member>
272      <member refid="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" virt="virtual"><scope>eprod</scope><name>sampleN</name></member>
273      <member refid="classeprod_168b66b05b3b6987472247f541846a366" prot="protected" virt="non-virtual"><scope>eprod</scope><name>sizes</name></member>
274      <member refid="classepdf_10a322dd106f04c0a2915e3d4f4227396" prot="public" virt="virtual"><scope>eprod</scope><name>~epdf</name></member>
275    </listofallmembers>
276  </compounddef>
277</doxygen>
Note: See TracBrowser for help on using the browser.