root/doc/html/classbdm_1_1mmix.html @ 259

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