root/doc/html/classbdm_1_1mmix.html @ 270

Revision 270, 16.4 kB (checked in by smidl, 15 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
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>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1mmix.html">mmix</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::mmix Class Reference</h1><!-- doxytag: class="bdm::mmix" --><!-- doxytag: inherits="bdm::mpdf" --><code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::mmix:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1mmix__inherit__graph.png" border="0" usemap="#bdm_1_1mmix__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1mmix__inherit__map">
38<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>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
42<a href="classbdm_1_1mmix-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Mixture of mpdfs with constant weights, all mpdfs are of equal type.
44<p>
45<table border="0" cellpadding="0" cellspacing="0">
46<tr><td></td></tr>
47<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0cf51b7daeb6751103e94e6b96213fb"></a><!-- doxytag: member="bdm::mmix::mmix" ref="a0cf51b7daeb6751103e94e6b96213fb" args="()" -->
49&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#a0cf51b7daeb6751103e94e6b96213fb">mmix</a> ()</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
52<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)" -->
53void&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>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set weights <code>w</code> and components <code>R</code>. <br></td></tr>
56<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)" -->
57void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#0a5241ecc9911e816b00b92d5c7c8df0">condition</a> (const vec &amp;cond)</td></tr>
58
59<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>
60<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
61<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#f0c1db6fcbb3aae2dd6123884457a367">samplecond</a> (const vec &amp;cond)</td></tr>
62
63<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="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
64<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#afe4185b26baeb03688202e254d3b005">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
67<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)" -->
68virtual 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>
69
70<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>
71<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)" -->
72virtual 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>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
75<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mmix::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
77<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
78
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mmix::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
80<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
81
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mmix::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
83int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
84
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mmix::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
86int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
87
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mmix::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
89<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
90
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"><b>_e</b> ()</td></tr>
93
94<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mmix::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
96void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvc</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvc0)</td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mmix::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
99void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
100
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mmix::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
102bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
103
104<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52e0bcc70d5b26babeba08097579da9c"></a><!-- doxytag: member="bdm::mmix::Coms" ref="52e0bcc70d5b26babeba08097579da9c" args="" -->
106Array&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>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component (epdfs). <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c4dd6ca6556ddd8ae3c5f3257c04b60"></a><!-- doxytag: member="bdm::mmix::Epdf" ref="0c4dd6ca6556ddd8ae3c5f3257c04b60" args="" -->
110<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>
111
112<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>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mmix::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
114int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mmix::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
118<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>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mmix::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
122<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>
123
124<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>
125</table>
126<hr><h2>Member Function Documentation</h2>
127<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mmix::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
128<div class="memitem">
129<div class="memproto">
130      <table class="memname">
131        <tr>
132          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
133          <td>(</td>
134          <td class="paramtype">const vec &amp;&nbsp;</td>
135          <td class="paramname"> <em>cond</em>          </td>
136          <td>&nbsp;)&nbsp;</td>
137          <td><code> [inline, virtual, inherited]</code></td>
138        </tr>
139      </table>
140</div>
141<div class="memdoc">
142
143<p>
144Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
145<p>
146<dl compact><dt><b>Parameters:</b></dt><dd>
147  <table border="0" cellspacing="2" cellpadding="0">
148    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
149  </table>
150</dl>
151
152<p>References <a class="el" href="libBM_8h-source.html#l00315">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00288">bdm::mpdf::ep</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::epdf::sample()</a>.</p>
153
154<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>
155
156</div>
157</div><p>
158<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mmix::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
159<div class="memitem">
160<div class="memproto">
161      <table class="memname">
162        <tr>
163          <td class="memname">virtual mat bdm::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">int&nbsp;</td>
172          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
173        </tr>
174        <tr>
175          <td></td>
176          <td>)</td>
177          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
178        </tr>
179      </table>
180</div>
181<div class="memdoc">
182
183<p>
184Returns.
185<p>
186<dl compact><dt><b>Parameters:</b></dt><dd>
187  <table border="0" cellspacing="2" cellpadding="0">
188    <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>
189    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
190    <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>
191  </table>
192</dl>
193
194<p>References <a class="el" href="libBM_8h-source.html#l00315">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00272">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00288">bdm::mpdf::ep</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::epdf::sample()</a>.</p>
195
196</div>
197</div><p>
198<hr>The documentation for this class was generated from the following file:<ul>
199<li><a class="el" href="emix_8h-source.html">emix.h</a></ul>
200</div>
201<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:03 2009 for mixpp by&nbsp;
202<a href="http://www.doxygen.org/index.html">
203<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
204</body>
205</html>
Note: See TracBrowser for help on using the browser.