root/doc/xml/classemix.xml @ 235

Revision 187, 20.0 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="classemix" kind="class" prot="public">
4    <compoundname>emix</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="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" prot="protected" static="no" mutable="no">
9        <type>vec</type>
10        <definition>vec emix::w</definition>
11        <argsstring></argsstring>
12        <name>w</name>
13        <briefdescription>
14<para>weights of the components </para>        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="35" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="35" bodyend="-1"/>
20        <referencedby refid="classemix_135baf0f62307455cebfbf462144b4dd8" compoundref="emix_8h" startline="59" endline="59">_w</referencedby>
21        <referencedby refid="classemix_1469e910479b3402589104ef3bb1b5741" compoundref="emix_8h" startline="50" endline="55">evalpdflog</referencedby>
22        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="45" endline="49">mean</referencedby>
23        <referencedby refid="classemix_10650601f24e633e0ab09aa1e46c14483" compoundref="emix_8cpp" startline="14" endline="23">sample</referencedby>
24        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">set_parameters</referencedby>
25      </memberdef>
26      <memberdef kind="variable" id="classemix_17155d827417b53fb6aa5cff1459e6eb4" prot="protected" static="no" mutable="no">
27        <type>Array&lt; <ref refid="classepdf" kindref="compound">epdf</ref> * &gt;</type>
28        <definition>Array&lt;epdf*&gt; emix::Coms</definition>
29        <argsstring></argsstring>
30        <name>Coms</name>
31        <briefdescription>
32<para>Component (epdfs). </para>        </briefdescription>
33        <detaileddescription>
34        </detaileddescription>
35        <inbodydescription>
36        </inbodydescription>
37        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="37" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="37" bodyend="-1"/>
38        <referencedby refid="classemix_1469e910479b3402589104ef3bb1b5741" compoundref="emix_8h" startline="50" endline="55">evalpdflog</referencedby>
39        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="45" endline="49">mean</referencedby>
40        <referencedby refid="classemix_10650601f24e633e0ab09aa1e46c14483" compoundref="emix_8cpp" startline="14" endline="23">sample</referencedby>
41        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">set_parameters</referencedby>
42      </memberdef>
43      <memberdef kind="variable" id="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" static="no" mutable="no">
44        <type><ref refid="classRV" kindref="compound">RV</ref></type>
45        <definition>RV epdf::rv</definition>
46        <argsstring></argsstring>
47        <name>rv</name>
48        <briefdescription>
49<para>Identified of the random variable. </para>        </briefdescription>
50        <detaileddescription>
51        </detaileddescription>
52        <inbodydescription>
53        </inbodydescription>
54        <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"/>
55        <referencedby refid="classepdf_14778ea61ef400813e47750e024e9fc2f" compoundref="libBM_8h" startline="164" endline="164">epdf::_rv</referencedby>
56        <referencedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef" compoundref="libEF_8cpp" startline="83" endline="92">egamma::evalpdflog</referencedby>
57        <referencedby refid="classegiw_1425cbc53b377274e28c6add942bab62d" compoundref="libEF_8cpp" startline="19" endline="29">egiw::evalpdflog</referencedby>
58        <referencedby refid="classegamma_1d6dbbdb72360f9e54d64501f80318bb6" compoundref="libEF_8cpp" startline="94" endline="103">egamma::lognc</referencedby>
59        <referencedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d" compoundref="libEF_8h" startline="334" endline="338">eEmp::mean</referencedby>
60        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="45" endline="49">mean</referencedby>
61        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">euni::sample</referencedby>
62        <referencedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425" compoundref="libEF_8cpp" startline="55" endline="66">egamma::sample</referencedby>
63        <referencedby refid="classepdf_154d7dd53a641b618771cd9bee135181f" compoundref="libBM_8cpp" startline="113" endline="117">epdf::sampleN</referencedby>
64        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">set_parameters</referencedby>
65      </memberdef>
66      </sectiondef>
67      <sectiondef kind="public-func">
68      <memberdef kind="function" id="classemix_13a10c8481115a5460877272ddb6532a6" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
69        <type></type>
70        <definition>emix::emix</definition>
71        <argsstring>(RV &amp;rv)</argsstring>
72        <name>emix</name>
73        <param>
74          <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
75          <declname>rv</declname>
76        </param>
77        <briefdescription>
78<para>Default constructor. </para>        </briefdescription>
79        <detaileddescription>
80        </detaileddescription>
81        <inbodydescription>
82        </inbodydescription>
83        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="40" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="40" bodyend="40"/>
84      </memberdef>
85      <memberdef kind="function" id="classemix_16ce82b24d7fe540ddbf44b472a005555" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
86        <type>void</type>
87        <definition>void emix::set_parameters</definition>
88        <argsstring>(const vec &amp;w, const Array&lt; epdf * &gt; &amp;Coms)</argsstring>
89        <name>set_parameters</name>
90        <param>
91          <type>const vec &amp;</type>
92          <declname>w</declname>
93        </param>
94        <param>
95          <type>const Array&lt; <ref refid="classepdf" kindref="compound">epdf</ref> * &gt; &amp;</type>
96          <declname>Coms</declname>
97        </param>
98        <briefdescription>
99<para>Set weights <computeroutput>w</computeroutput> and components <computeroutput>R</computeroutput>. </para>        </briefdescription>
100        <detaileddescription>
101        </detaileddescription>
102        <inbodydescription>
103        </inbodydescription>
104        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="42" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.cpp" bodystart="5" bodyend="12"/>
105        <references refid="classepdf_14778ea61ef400813e47750e024e9fc2f" compoundref="libBM_8h" startline="164" endline="164">epdf::_rv</references>
106        <references refid="classemix_17155d827417b53fb6aa5cff1459e6eb4" compoundref="emix_8h" startline="37">Coms</references>
107        <references refid="classRV_182cc7fa22ce91cf461a522ad62014c65" compoundref="libBM_8cpp" startline="109" endline="111">RV::equal</references>
108        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
109        <references refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" compoundref="emix_8h" startline="35">w</references>
110        <referencedby refid="classmmix_1e7681490a5c5b2d0a43f4e5842e10a9d" compoundref="emix_8h" startline="180" endline="187">mmix::set_parameters</referencedby>
111      </memberdef>
112      <memberdef kind="function" id="classemix_10650601f24e633e0ab09aa1e46c14483" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
113        <type>vec</type>
114        <definition>vec emix::sample</definition>
115        <argsstring>() const </argsstring>
116        <name>sample</name>
117        <reimplements refid="classepdf_18019654e494bf5e458f6fb947e11b262">sample</reimplements>
118        <briefdescription>
119<para>Returns the required moment of the <ref refid="classepdf" kindref="compound">epdf</ref>. </para>        </briefdescription>
120        <detaileddescription>
121<para>Returns a sample, <formula id="28">$x$</formula> from density <formula id="59">$epdf(rv)$</formula> </para>        </detaileddescription>
122        <inbodydescription>
123        </inbodydescription>
124        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="44" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.cpp" bodystart="14" bodyend="23"/>
125        <references refid="classemix_17155d827417b53fb6aa5cff1459e6eb4" compoundref="emix_8h" startline="37">Coms</references>
126        <references refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" compoundref="emix_8h" startline="35">w</references>
127      </memberdef>
128      <memberdef kind="function" id="classemix_1b662a51d042b062020460e64bff4e9e8" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
129        <type>vec</type>
130        <definition>vec emix::mean</definition>
131        <argsstring>() const </argsstring>
132        <name>mean</name>
133        <reimplements refid="classepdf_1bf0a070a8f3e67a93604ca724638b870">mean</reimplements>
134        <briefdescription>
135<para>return expected value </para>        </briefdescription>
136        <detaileddescription>
137        </detaileddescription>
138        <inbodydescription>
139        </inbodydescription>
140        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="45" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="45" bodyend="49"/>
141        <references refid="classemix_17155d827417b53fb6aa5cff1459e6eb4" compoundref="emix_8h" startline="37">Coms</references>
142        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
143        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
144        <references refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" compoundref="emix_8h" startline="35">w</references>
145      </memberdef>
146      <memberdef kind="function" id="classemix_1469e910479b3402589104ef3bb1b5741" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
147        <type>double</type>
148        <definition>double emix::evalpdflog</definition>
149        <argsstring>(const vec &amp;val) const </argsstring>
150        <name>evalpdflog</name>
151        <reimplements refid="classepdf_16aef3eca74899692503769c18add1a4c">evalpdflog</reimplements>
152        <param>
153          <type>const vec &amp;</type>
154          <declname>val</declname>
155        </param>
156        <briefdescription>
157<para>Compute log-probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
158        <detaileddescription>
159        </detaileddescription>
160        <inbodydescription>
161        </inbodydescription>
162        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="50" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="50" bodyend="55"/>
163        <references refid="classemix_17155d827417b53fb6aa5cff1459e6eb4" compoundref="emix_8h" startline="37">Coms</references>
164        <references refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" compoundref="emix_8h" startline="35">w</references>
165      </memberdef>
166      <memberdef kind="function" id="classemix_135baf0f62307455cebfbf462144b4dd8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
167        <type>vec &amp;</type>
168        <definition>vec&amp; emix::_w</definition>
169        <argsstring>()</argsstring>
170        <name>_w</name>
171        <briefdescription>
172<para>returns a pointer to the internal mean value. Use with Care! </para>        </briefdescription>
173        <detaileddescription>
174        </detaileddescription>
175        <inbodydescription>
176        </inbodydescription>
177        <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="59" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="59" bodyend="59"/>
178        <references refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" compoundref="emix_8h" startline="35">w</references>
179      </memberdef>
180      <memberdef kind="function" id="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
181        <type>mat</type>
182        <definition>mat epdf::sampleN</definition>
183        <argsstring>(int N) const </argsstring>
184        <name>sampleN</name>
185        <param>
186          <type>int</type>
187          <declname>N</declname>
188        </param>
189        <briefdescription>
190<para>Returns N samples from density <formula id="59">$epdf(rv)$</formula>. </para>        </briefdescription>
191        <detaileddescription>
192        </detaileddescription>
193        <inbodydescription>
194        </inbodydescription>
195        <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"/>
196        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
197        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
198      </memberdef>
199      <memberdef kind="function" id="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
200        <type>double</type>
201        <definition>virtual double epdf::eval</definition>
202        <argsstring>(const vec &amp;val) const </argsstring>
203        <name>eval</name>
204        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
205        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
206        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
207        <reimplementedby refid="classeuni_12723d4992900b5c5495bfa03628195ed">eval</reimplementedby>
208        <reimplementedby refid="classenorm_1b9e1dfd33692d7b3f1a59f17b0e61bd0">eval</reimplementedby>
209        <param>
210          <type>const vec &amp;</type>
211          <declname>val</declname>
212        </param>
213        <briefdescription>
214<para>Compute probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
215        <detaileddescription>
216        </detaileddescription>
217        <inbodydescription>
218        </inbodydescription>
219        <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"/>
220        <references refid="classepdf_16aef3eca74899692503769c18add1a4c">epdf::evalpdflog</references>
221        <referencedby refid="classmpdf_180b738ece5bd4f8c4edaee4b38906f91" compoundref="libBM_8h" startline="198" endline="198">mpdf::evalcond</referencedby>
222      </memberdef>
223      <memberdef kind="function" id="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
224        <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
225        <definition>RV&amp; epdf::_rv</definition>
226        <argsstring>()</argsstring>
227        <name>_rv</name>
228        <briefdescription>
229<para>access function, possibly dangerous! </para>        </briefdescription>
230        <detaileddescription>
231        </detaileddescription>
232        <inbodydescription>
233        </inbodydescription>
234        <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"/>
235        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
236        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">set_parameters</referencedby>
237      </memberdef>
238      </sectiondef>
239    <briefdescription>
240<para>Mixture of epdfs. </para>    </briefdescription>
241    <detaileddescription>
242<para>Density function: <formula id="63">\[ f(x) = \sum_{i=1}^{n} w_{i} f_i(x), \quad \sum_{i=1}^n w_i = 1. \]</formula> where <formula id="64">$f_i(x)$</formula> is any density on random variable <formula id="28">$x$</formula>, called <emphasis>component</emphasis>, </para>    </detaileddescription>
243    <inheritancegraph>
244      <node id="996">
245        <label>epdf</label>
246        <link refid="classepdf"/>
247      </node>
248      <node id="995">
249        <label>emix</label>
250        <link refid="classemix"/>
251        <childnode refid="996" relation="public-inheritance">
252        </childnode>
253      </node>
254    </inheritancegraph>
255    <collaborationgraph>
256      <node id="998">
257        <label>epdf</label>
258        <link refid="classepdf"/>
259        <childnode refid="999" relation="usage">
260          <edgelabel>rv</edgelabel>
261        </childnode>
262      </node>
263      <node id="999">
264        <label>RV</label>
265        <link refid="classRV"/>
266      </node>
267      <node id="997">
268        <label>emix</label>
269        <link refid="classemix"/>
270        <childnode refid="998" relation="public-inheritance">
271        </childnode>
272      </node>
273    </collaborationgraph>
274    <location file="/home/smidl/work/git/mixpp/bdm/stat/emix.h" line="32" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/emix.h" bodystart="32" bodyend="60"/>
275    <listofallmembers>
276      <member refid="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" virt="non-virtual"><scope>emix</scope><name>_rv</name></member>
277      <member refid="classemix_135baf0f62307455cebfbf462144b4dd8" prot="public" virt="non-virtual"><scope>emix</scope><name>_w</name></member>
278      <member refid="classemix_17155d827417b53fb6aa5cff1459e6eb4" prot="protected" virt="non-virtual"><scope>emix</scope><name>Coms</name></member>
279      <member refid="classemix_13a10c8481115a5460877272ddb6532a6" prot="public" virt="non-virtual"><scope>emix</scope><name>emix</name></member>
280      <member refid="classepdf_1d8eb760037b3bad5a0d64081606697cd" prot="public" virt="non-virtual"><scope>emix</scope><name>epdf</name></member>
281      <member refid="classepdf_1c95b1a27a8dd9507bb9a5a3cb2809c7a" prot="public" virt="non-virtual"><scope>emix</scope><name>epdf</name></member>
282      <member refid="classepdf_13ea597362e11a0040fe7c990269d072c" prot="public" virt="virtual"><scope>emix</scope><name>eval</name></member>
283      <member refid="classemix_1469e910479b3402589104ef3bb1b5741" prot="public" virt="virtual"><scope>emix</scope><name>evalpdflog</name></member>
284      <member refid="classemix_1b662a51d042b062020460e64bff4e9e8" prot="public" virt="virtual"><scope>emix</scope><name>mean</name></member>
285      <member refid="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" virt="non-virtual"><scope>emix</scope><name>rv</name></member>
286      <member refid="classemix_10650601f24e633e0ab09aa1e46c14483" prot="public" virt="virtual"><scope>emix</scope><name>sample</name></member>
287      <member refid="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" virt="virtual"><scope>emix</scope><name>sampleN</name></member>
288      <member refid="classemix_16ce82b24d7fe540ddbf44b472a005555" prot="public" virt="non-virtual"><scope>emix</scope><name>set_parameters</name></member>
289      <member refid="classemix_1cdc8f4e2a5e43595ac5450d8a7f9d1ab" prot="protected" virt="non-virtual"><scope>emix</scope><name>w</name></member>
290      <member refid="classepdf_10a322dd106f04c0a2915e3d4f4227396" prot="public" virt="virtual"><scope>emix</scope><name>~epdf</name></member>
291    </listofallmembers>
292  </compounddef>
293</doxygen>
Note: See TracBrowser for help on using the browser.