root/doc/html/classbdm_1_1mmix.html @ 264

Revision 264, 17.6 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[259]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: bdm::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>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[259]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[259]22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
[261]27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1mmix.html">mmix</a>
[259]28  </div>
29</div>
30<div class="contents">
31<h1>bdm::mmix Class Reference</h1><!-- doxytag: class="bdm::mmix" --><!-- doxytag: inherits="bdm::mpdf" -->Mixture of mpdfs with constant weights, all mpdfs are of equal type. 
32<a href="#_details">More...</a>
33<p>
34<code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::mmix:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1mmix__inherit__graph.png" border="0" usemap="#bdm_1_1mmix__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1mmix__inherit__map">
[261]41<area shape="rect" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="16,84,107,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
[259]42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43<div class="dynheader">
44Collaboration diagram for bdm::mmix:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1mmix__coll__graph.png" border="0" usemap="#bdm_1_1mmix__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1mmix__coll__map">
[261]48<area shape="rect" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,284,96,311"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="15,7,127,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="33,87,108,113"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="101,185,187,212"><area shape="rect" href="classbdm_1_1emix.html" title="Mixture of epdfs." alt="" coords="120,284,208,311"></map>
[259]49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
50
51<p>
52<a href="classbdm_1_1mmix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
53<tr><td></td></tr>
54<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="580a05ae61b179de3fccfcb60f11efd9"></a><!-- doxytag: member="bdm::mmix::mmix" ref="580a05ae61b179de3fccfcb60f11efd9" args="(RV &amp;rv, RV &amp;rvc)" -->
56&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#580a05ae61b179de3fccfcb60f11efd9">mmix</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1mpdf.html#9bcfb45435d30983f436d41c298cbb51">rv</a>, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288">rvc</a>)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad8d9df36cb0ca093a29af0eca12da32"></a><!-- doxytag: member="bdm::mmix::set_parameters" ref="ad8d9df36cb0ca093a29af0eca12da32" args="(const vec &amp;w, const Array&lt; mpdf * &gt; &amp;Coms)" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#ad8d9df36cb0ca093a29af0eca12da32">set_parameters</a> (const vec &amp;w, const Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; &amp;<a class="el" href="classbdm_1_1mmix.html#52e0bcc70d5b26babeba08097579da9c">Coms</a>)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set weights <code>w</code> and components <code>R</code>. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a5241ecc9911e816b00b92d5c7c8df0"></a><!-- doxytag: member="bdm::mmix::condition" ref="0a5241ecc9911e816b00b92d5c7c8df0" args="(const vec &amp;cond)" -->
64void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#0a5241ecc9911e816b00b92d5c7c8df0">condition</a> (const vec &amp;cond)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#e4848a428d8ef0549c6e4a9ed386d9f2">samplecond</a> (const vec &amp;cond, double &amp;ll)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.  <a href="#e4848a428d8ef0549c6e4a9ed386d9f2"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#ee26963a637b2ea1fb1933652981e652">samplecond_m</a> (const vec &amp;cond, vec &amp;ll, int N)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#ee26963a637b2ea1fb1933652981e652"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mmix::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
74virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#6336a8a72462e2a56a3989a220f18b1b">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classbdm_1_1epdf.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>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mmix::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
78virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#0b0ed1ed663071bb7cf4a1349eb94fcb">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3aba7311038bf990d706a64cab60cf8"></a><!-- doxytag: member="bdm::mmix::_rvc" ref="b3aba7311038bf990d706a64cab60cf8" args="() const " -->
82<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#b3aba7311038bf990d706a64cab60cf8">_rvc</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="222d5280e309c5a053ba73841e98c151"></a><!-- doxytag: member="bdm::mmix::_rv" ref="222d5280e309c5a053ba73841e98c151" args="() const " -->
86<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#222d5280e309c5a053ba73841e98c151">_rv</a> () const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mmix::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
90<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#1892fe3933488942253679f068e9e7f6">_epdf</a> ()</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mmix::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
94<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#05e843fd11c410a99dad2b88c55aca80">_e</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
97<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52e0bcc70d5b26babeba08097579da9c"></a><!-- doxytag: member="bdm::mmix::Coms" ref="52e0bcc70d5b26babeba08097579da9c" args="" -->
99Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#52e0bcc70d5b26babeba08097579da9c">Coms</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component (epdfs). <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c4dd6ca6556ddd8ae3c5f3257c04b60"></a><!-- doxytag: member="bdm::mmix::Epdf" ref="0c4dd6ca6556ddd8ae3c5f3257c04b60" args="" -->
103<a class="el" href="classbdm_1_1emix.html">emix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#0c4dd6ca6556ddd8ae3c5f3257c04b60">Epdf</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bcfb45435d30983f436d41c298cbb51"></a><!-- doxytag: member="bdm::mmix::rv" ref="9bcfb45435d30983f436d41c298cbb51" args="" -->
107<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#9bcfb45435d30983f436d41c298cbb51">rv</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mmix::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
111<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288">rvc</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mmix::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
115<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5eea43c56d38e4441bfb30270db949c0">ep</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
118</table>
119<hr><a name="_details"></a><h2>Detailed Description</h2>
120Mixture of mpdfs with constant weights, all mpdfs are of equal type.
121<p>
122<hr><h2>Member Function Documentation</h2>
123<a class="anchor" name="e4848a428d8ef0549c6e4a9ed386d9f2"></a><!-- doxytag: member="bdm::mmix::samplecond" ref="e4848a428d8ef0549c6e4a9ed386d9f2" args="(const vec &amp;cond, double &amp;ll)" -->
124<div class="memitem">
125<div class="memproto">
126      <table class="memname">
127        <tr>
128          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
129          <td>(</td>
130          <td class="paramtype">const vec &amp;&nbsp;</td>
131          <td class="paramname"> <em>cond</em>, </td>
132        </tr>
133        <tr>
134          <td class="paramkey"></td>
135          <td></td>
136          <td class="paramtype">double &amp;&nbsp;</td>
137          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
138        </tr>
139        <tr>
140          <td></td>
141          <td>)</td>
142          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
143        </tr>
144      </table>
145</div>
146<div class="memdoc">
147
148<p>
149Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
150<p>
151<dl compact><dt><b>Parameters:</b></dt><dd>
152  <table border="0" cellspacing="2" cellpadding="0">
153    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
154    <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>
155  </table>
156</dl>
157
158<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#1a37c2aaba8bde7fce5351c39b6e1168">bdm::mprod</a>.</p>
159
[264]160<p>References <a class="el" href="libBM_8h-source.html#l00248">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00231">bdm::mpdf::ep</a>, <a class="el" href="classbdm_1_1epdf.html#a8e39e2ff5e5cf5471bc159530d3b2d3">bdm::epdf::evallog()</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::epdf::sample()</a>.</p>
[259]161
[261]162<p>Referenced by <a class="el" href="libPF_8h-source.html#l00143">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="libPF_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="libDS_8cpp-source.html#l00044">bdm::ArxDS::step()</a>.</p>
[259]163
164</div>
165</div><p>
166<a class="anchor" name="ee26963a637b2ea1fb1933652981e652"></a><!-- doxytag: member="bdm::mmix::samplecond_m" ref="ee26963a637b2ea1fb1933652981e652" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
167<div class="memitem">
168<div class="memproto">
169      <table class="memname">
170        <tr>
171          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
172          <td>(</td>
173          <td class="paramtype">const vec &amp;&nbsp;</td>
174          <td class="paramname"> <em>cond</em>, </td>
175        </tr>
176        <tr>
177          <td class="paramkey"></td>
178          <td></td>
179          <td class="paramtype">vec &amp;&nbsp;</td>
180          <td class="paramname"> <em>ll</em>, </td>
181        </tr>
182        <tr>
183          <td class="paramkey"></td>
184          <td></td>
185          <td class="paramtype">int&nbsp;</td>
186          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
187        </tr>
188        <tr>
189          <td></td>
190          <td>)</td>
191          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
192        </tr>
193      </table>
194</div>
195<div class="memdoc">
196
197<p>
198Returns.
199<p>
200<dl compact><dt><b>Parameters:</b></dt><dd>
201  <table border="0" cellspacing="2" cellpadding="0">
202    <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>
203    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
204    <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>
205  </table>
206</dl>
207
[264]208<p>References <a class="el" href="libBM_8h-source.html#l00248">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00084">bdm::RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00231">bdm::mpdf::ep</a>, <a class="el" href="classbdm_1_1epdf.html#a8e39e2ff5e5cf5471bc159530d3b2d3">bdm::epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00227">bdm::mpdf::rv</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::epdf::sample()</a>.</p>
[259]209
210</div>
211</div><p>
212<hr>The documentation for this class was generated from the following file:<ul>
[261]213<li><a class="el" href="emix_8h-source.html">emix.h</a></ul>
[259]214</div>
[264]215<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 19:50:05 2009 for mixpp by&nbsp;
[259]216<a href="http://www.doxygen.org/index.html">
217<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
218</body>
219</html>
Note: See TracBrowser for help on using the browser.