root/doc/html/classmmix.html @ 224

Revision 224, 16.3 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: mmix Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>mmix Class Reference</h1><!-- doxytag: class="mmix" --><!-- doxytag: inherits="mpdf" -->Mixture of mpdfs with constant weights, all mpdfs are of equal type. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for mmix:</div>
34<div class="dynsection">
35<p><center><img src="classmmix__inherit__graph.png" border="0" usemap="#mmix__inherit__map" alt="Inheritance graph"></center>
36<map name="mmix__inherit__map">
37<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="7,7,60,33"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for mmix:</div>
41<div class="dynsection">
42<p><center><img src="classmmix__coll__graph.png" border="0" usemap="#mmix__coll__map" alt="Collaboration graph"></center>
43<map name="mmix__coll__map">
44<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,204,59,231"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="36,7,73,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="71,105,119,132"><area shape="rect" href="classemix.html" title="Mixture of epdfs." alt="" coords="83,204,133,231"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classmmix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6769a962f1f4d0ecc5b903b5f7d26ad3"></a><!-- doxytag: member="mmix::mmix" ref="6769a962f1f4d0ecc5b903b5f7d26ad3" args="(RV &amp;rv, RV &amp;rvc)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#6769a962f1f4d0ecc5b903b5f7d26ad3">mmix</a> (<a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a>, <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a>)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7681490a5c5b2d0a43f4e5842e10a9d"></a><!-- doxytag: member="mmix::set_parameters" ref="e7681490a5c5b2d0a43f4e5842e10a9d" args="(const vec &amp;w, const Array&lt; mpdf * &gt; &amp;Coms)" -->
56void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#e7681490a5c5b2d0a43f4e5842e10a9d">set_parameters</a> (const vec &amp;w, const Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; &amp;<a class="el" href="classmmix.html#460632c7a0afd41b7840902181a7d85f">Coms</a>)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set weights <code>w</code> and components <code>R</code>. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a66629ec5c2b6f4740606cf737f0193"></a><!-- doxytag: member="mmix::condition" ref="1a66629ec5c2b6f4740606cf737f0193" args="(const vec &amp;cond)" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#1a66629ec5c2b6f4740606cf737f0193">condition</a> (const vec &amp;cond)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#3f172b79ec4a5ebc87898a5381141f1b">samplecond</a> (const vec &amp;cond, double &amp;ll)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.  <a href="#3f172b79ec4a5ebc87898a5381141f1b"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#b1dae6171ee39a6a05976c7b1007a3c5">samplecond_m</a> (const vec &amp;cond, vec &amp;ll, int N)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#b1dae6171ee39a6a05976c7b1007a3c5"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ef8a6374029d990a678782f6decebbe"></a><!-- doxytag: member="mmix::evallogcond" ref="2ef8a6374029d990a678782f6decebbe" args="(const vec &amp;dt, const vec &amp;cond)" -->
70virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#2ef8a6374029d990a678782f6decebbe">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. In some cases, this operation can be implemented efficiently. <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95fcff214848f66f1b489459370573fa"></a><!-- doxytag: member="mmix::evallogcond_m" ref="95fcff214848f66f1b489459370573fa" args="(const mat &amp;Dt, const vec &amp;cond)" -->
74virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#95fcff214848f66f1b489459370573fa">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15ef062183b1ccdf794732d5fa0b77cd"></a><!-- doxytag: member="mmix::_rvc" ref="15ef062183b1ccdf794732d5fa0b77cd" args="() const " -->
78<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#15ef062183b1ccdf794732d5fa0b77cd">_rvc</a> () const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71256ffb5fbd08f41d650e606a5bd585"></a><!-- doxytag: member="mmix::_rv" ref="71256ffb5fbd08f41d650e606a5bd585" args="() const " -->
82<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#71256ffb5fbd08f41d650e606a5bd585">_rv</a> () const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mmix::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
86<a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#e17780ee5b2cfe05922a6c56af1462f8">_epdf</a> ()</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
89<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460632c7a0afd41b7840902181a7d85f"></a><!-- doxytag: member="mmix::Coms" ref="460632c7a0afd41b7840902181a7d85f" args="" -->
91Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#460632c7a0afd41b7840902181a7d85f">Coms</a></td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component (epdfs). <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="507a5e6df53e6e9a6a330f1271cf0914"></a><!-- doxytag: member="mmix::Epdf" ref="507a5e6df53e6e9a6a330f1271cf0914" args="" -->
95<a class="el" href="classemix.html">emix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#507a5e6df53e6e9a6a330f1271cf0914">Epdf</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mmix::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
99<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mmix::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
103<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mmix::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
107<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#7aa894208a32f3487827df6d5054424c">ep</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
110</table>
111<hr><a name="_details"></a><h2>Detailed Description</h2>
112Mixture of mpdfs with constant weights, all mpdfs are of equal type.
113<p>
114<hr><h2>Member Function Documentation</h2>
115<a class="anchor" name="3f172b79ec4a5ebc87898a5381141f1b"></a><!-- doxytag: member="mmix::samplecond" ref="3f172b79ec4a5ebc87898a5381141f1b" args="(const vec &amp;cond, double &amp;ll)" -->
116<div class="memitem">
117<div class="memproto">
118      <table class="memname">
119        <tr>
120          <td class="memname">virtual vec mpdf::samplecond           </td>
121          <td>(</td>
122          <td class="paramtype">const vec &amp;&nbsp;</td>
123          <td class="paramname"> <em>cond</em>, </td>
124        </tr>
125        <tr>
126          <td class="paramkey"></td>
127          <td></td>
128          <td class="paramtype">double &amp;&nbsp;</td>
129          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
130        </tr>
131        <tr>
132          <td></td>
133          <td>)</td>
134          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
135        </tr>
136      </table>
137</div>
138<div class="memdoc">
139
140<p>
141Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
142<p>
143Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
144  <table border="0" cellspacing="2" cellpadding="0">
145    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
146    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
147  </table>
148</dl>
149
150<p>Reimplemented in <a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">mprod</a>.</p>
151
152<p>References <a class="el" href="libBM_8h-source.html#l00238">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00219">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
153
154<p>Referenced by <a class="el" href="libPF_8h-source.html#l00138">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p>
155
156</div>
157</div><p>
158<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mmix::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
159<div class="memitem">
160<div class="memproto">
161      <table class="memname">
162        <tr>
163          <td class="memname">virtual mat mpdf::samplecond_m           </td>
164          <td>(</td>
165          <td class="paramtype">const vec &amp;&nbsp;</td>
166          <td class="paramname"> <em>cond</em>, </td>
167        </tr>
168        <tr>
169          <td class="paramkey"></td>
170          <td></td>
171          <td class="paramtype">vec &amp;&nbsp;</td>
172          <td class="paramname"> <em>ll</em>, </td>
173        </tr>
174        <tr>
175          <td class="paramkey"></td>
176          <td></td>
177          <td class="paramtype">int&nbsp;</td>
178          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
179        </tr>
180        <tr>
181          <td></td>
182          <td>)</td>
183          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
184        </tr>
185      </table>
186</div>
187<div class="memdoc">
188
189<p>
190Returns.
191<p>
192<dl compact><dt><b>Parameters:</b></dt><dd>
193  <table border="0" cellspacing="2" cellpadding="0">
194    <tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">. </td></tr>
195    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
196    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
197  </table>
198</dl>
199
200<p>References <a class="el" href="libBM_8h-source.html#l00238">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00219">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00215">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
201
202</div>
203</div><p>
204<hr>The documentation for this class was generated from the following file:<ul>
205<li>work/git/mixpp/bdm/stat/<a class="el" href="emix_8h-source.html">emix.h</a></ul>
206</div>
207<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:29:18 2009 for mixpp by&nbsp;
208<a href="http://www.doxygen.org/index.html">
209<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
210</body>
211</html>
Note: See TracBrowser for help on using the browser.