root/doc/html/classmprod.html @ 219

Revision 219, 19.7 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: mprod 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>mprod Class Reference</h1><!-- doxytag: class="mprod" --><!-- doxytag: inherits="compositepdf,mpdf" -->Chain rule decomposition of <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. 
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 mprod:</div>
34<div class="dynsection">
35<p><center><img src="classmprod__inherit__graph.png" border="0" usemap="#mprod__inherit__map" alt="Inheritance graph"></center>
36<map name="mprod__inherit__map">
37<area shape="rect" href="classcompositepdf.html" title="Abstract composition of pdfs, a base for specific classes this abstract class is..." alt="" coords="5,7,112,33"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="136,7,189,33"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for mprod:</div>
41<div class="dynsection">
42<p><center><img src="classmprod__coll__graph.png" border="0" usemap="#mprod__coll__map" alt="Collaboration graph"></center>
43<map name="mprod__coll__map">
44<area shape="rect" href="classcompositepdf.html" title="Abstract composition of pdfs, a base for specific classes this abstract class is..." alt="" coords="5,204,112,231"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="136,204,189,231"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="137,7,175,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="172,105,220,132"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classmprod-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="419b303581a91ad85200bdcb4b3186f4"></a><!-- doxytag: member="mprod::mprod" ref="419b303581a91ad85200bdcb4b3186f4" args="(Array&lt; mpdf * &gt; mFacs)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#419b303581a91ad85200bdcb4b3186f4">mprod</a> (Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; mFacs)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor from list of mFacs,. <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5e1075f133f203113d92084b4a47c28"></a><!-- doxytag: member="mprod::evallogcond" ref="f5e1075f133f203113d92084b4a47c28" args="(const vec &amp;val, const vec &amp;cond)" -->
56double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#f5e1075f133f203113d92084b4a47c28">evallogcond</a> (const vec &amp;val, const vec &amp;cond)</td></tr>
57
58<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>
59<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">samplecond</a> (const vec &amp;cond, double &amp;ll)</td></tr>
60
61<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="#a48887eb8738a9e5550bfc38eb8e9d68"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e171c40e210539c2af01d6237785620b"></a><!-- doxytag: member="mprod::samplecond" ref="e171c40e210539c2af01d6237785620b" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
63mat&nbsp;</td><td class="memItemRight" valign="bottom"><b>samplecond</b> (const vec &amp;cond, vec &amp;ll, int N)</td></tr>
64
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#635d219fb3e32852400d6f98aa4bdc93">getrv</a> (bool checkoverlap=false)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">find common rv, flag  <a href="#635d219fb3e32852400d6f98aa4bdc93"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a4479785c1fdb2cc351fbea07b899ac"></a><!-- doxytag: member="mprod::setrvc" ref="5a4479785c1fdb2cc351fbea07b899ac" args="(const RV &amp;rv, RV &amp;rvc)" -->
69void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#5a4479785c1fdb2cc351fbea07b899ac">setrvc</a> (const <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>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">common rvc of all mpdfs is written to rvc <br></td></tr>
72<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>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#b1dae6171ee39a6a05976c7b1007a3c5"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f95a0cc6ab40611f46804682446ed83"></a><!-- doxytag: member="mprod::condition" ref="0f95a0cc6ab40611f46804682446ed83" args="(const vec &amp;cond)" -->
76virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">condition</a> (const vec &amp;cond)</td></tr>
77
78<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>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95fcff214848f66f1b489459370573fa"></a><!-- doxytag: member="mprod::evallogcond_m" ref="95fcff214848f66f1b489459370573fa" args="(const mat &amp;Dt, const vec &amp;cond)" -->
80virtual 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>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15ef062183b1ccdf794732d5fa0b77cd"></a><!-- doxytag: member="mprod::_rvc" ref="15ef062183b1ccdf794732d5fa0b77cd" args="() const " -->
84<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>
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="71256ffb5fbd08f41d650e606a5bd585"></a><!-- doxytag: member="mprod::_rv" ref="71256ffb5fbd08f41d650e606a5bd585" args="() const " -->
88<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>
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="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mprod::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
92<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>
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="0883ce383e8475546df138719918f70e"></a><!-- doxytag: member="mprod::epdfs" ref="0883ce383e8475546df138719918f70e" args="" -->
97Array&lt; <a class="el" href="classepdf.html">epdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#0883ce383e8475546df138719918f70e">epdfs</a></td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointers to epdfs - shortcut to <a class="el" href="classcompositepdf.html#637877061b917a16a0421bb5c4cd480d" title="Elements of composition.">mpdfs()</a>.<a class="el" href="classmpdf.html#e17780ee5b2cfe05922a6c56af1462f8" title="access function">_epdf()</a> <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5334777dda3dad9b9fa73e22e8d0f24c"></a><!-- doxytag: member="mprod::dls" ref="5334777dda3dad9b9fa73e22e8d0f24c" args="" -->
101Array&lt; <a class="el" href="classdatalink__m2m.html">datalink_m2m</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#5334777dda3dad9b9fa73e22e8d0f24c">dls</a></td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data link for each mpdfs. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1646fe41ff5934d010e54ccaa46133f"></a><!-- doxytag: member="mprod::n" ref="c1646fe41ff5934d010e54ccaa46133f" args="" -->
105int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#c1646fe41ff5934d010e54ccaa46133f">n</a></td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of mpdfs in the composite. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="637877061b917a16a0421bb5c4cd480d"></a><!-- doxytag: member="mprod::mpdfs" ref="637877061b917a16a0421bb5c4cd480d" args="" -->
109Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#637877061b917a16a0421bb5c4cd480d">mpdfs</a></td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mprod::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
113<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>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mprod::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
117<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>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mprod::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
121<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>
122
123<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>
124</table>
125<hr><a name="_details"></a><h2>Detailed Description</h2>
126Chain rule decomposition of <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
127<p>
128Probability density in the form of Chain-rule decomposition: \[ f(x_1,x_2,x_3) = f(x_1|x_2,x_3)f(x_2,x_3)f(x_3) \] Note that <hr><h2>Member Function Documentation</h2>
129<a class="anchor" name="a48887eb8738a9e5550bfc38eb8e9d68"></a><!-- doxytag: member="mprod::samplecond" ref="a48887eb8738a9e5550bfc38eb8e9d68" args="(const vec &amp;cond, double &amp;ll)" -->
130<div class="memitem">
131<div class="memproto">
132      <table class="memname">
133        <tr>
134          <td class="memname">vec mprod::samplecond           </td>
135          <td>(</td>
136          <td class="paramtype">const vec &amp;&nbsp;</td>
137          <td class="paramname"> <em>cond</em>, </td>
138        </tr>
139        <tr>
140          <td class="paramkey"></td>
141          <td></td>
142          <td class="paramtype">double &amp;&nbsp;</td>
143          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
144        </tr>
145        <tr>
146          <td></td>
147          <td>)</td>
148          <td></td><td></td><td><code> [inline, virtual]</code></td>
149        </tr>
150      </table>
151</div>
152<div class="memdoc">
153
154<p>
155Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
156<p>
157Returns 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>
158  <table border="0" cellspacing="2" cellpadding="0">
159    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
160    <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>
161  </table>
162</dl>
163
164<p>Reimplemented from <a class="el" href="classmpdf.html#3f172b79ec4a5ebc87898a5381141f1b">mpdf</a>.</p>
165
166<p>References <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="emix_8h-source.html#l00159">dls</a>, <a class="el" href="emix_8h-source.html#l00157">epdfs</a>, <a class="el" href="libBM_8h-source.html#l00357">compositepdf::mpdfs</a>, <a class="el" href="libBM_8h-source.html#l00355">compositepdf::n</a>, and <a class="el" href="libBM_8h-source.html#l00212">mpdf::rv</a>.</p>
167
168</div>
169</div><p>
170<a class="anchor" name="635d219fb3e32852400d6f98aa4bdc93"></a><!-- doxytag: member="mprod::getrv" ref="635d219fb3e32852400d6f98aa4bdc93" args="(bool checkoverlap=false)" -->
171<div class="memitem">
172<div class="memproto">
173      <table class="memname">
174        <tr>
175          <td class="memname"><a class="el" href="classRV.html">RV</a> compositepdf::getrv           </td>
176          <td>(</td>
177          <td class="paramtype">bool&nbsp;</td>
178          <td class="paramname"> <em>checkoverlap</em> = <code>false</code>          </td>
179          <td>&nbsp;)&nbsp;</td>
180          <td><code> [inherited]</code></td>
181        </tr>
182      </table>
183</div>
184<div class="memdoc">
185
186<p>
187find common rv, flag
188<p>
189<dl compact><dt><b>Parameters:</b></dt><dd>
190  <table border="0" cellspacing="2" cellpadding="0">
191    <tr><td valign="top"></td><td valign="top"><em>checkoverlap</em>&nbsp;</td><td>modifies whether overlaps are acceptable </td></tr>
192  </table>
193</dl>
194
195<p>References <a class="el" href="libBM_8cpp-source.html#l00053">RV::add()</a>, <a class="el" href="libBM_8h-source.html#l00357">compositepdf::mpdfs</a>, and <a class="el" href="libBM_8h-source.html#l00355">compositepdf::n</a>.</p>
196
197</div>
198</div><p>
199<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mprod::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
200<div class="memitem">
201<div class="memproto">
202      <table class="memname">
203        <tr>
204          <td class="memname">virtual mat mpdf::samplecond_m           </td>
205          <td>(</td>
206          <td class="paramtype">const vec &amp;&nbsp;</td>
207          <td class="paramname"> <em>cond</em>, </td>
208        </tr>
209        <tr>
210          <td class="paramkey"></td>
211          <td></td>
212          <td class="paramtype">vec &amp;&nbsp;</td>
213          <td class="paramname"> <em>ll</em>, </td>
214        </tr>
215        <tr>
216          <td class="paramkey"></td>
217          <td></td>
218          <td class="paramtype">int&nbsp;</td>
219          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
220        </tr>
221        <tr>
222          <td></td>
223          <td>)</td>
224          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
225        </tr>
226      </table>
227</div>
228<div class="memdoc">
229
230<p>
231Returns.
232<p>
233<dl compact><dt><b>Parameters:</b></dt><dd>
234  <table border="0" cellspacing="2" cellpadding="0">
235    <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>
236    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
237    <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>
238  </table>
239</dl>
240
241<p>References <a class="el" href="libBM_8h-source.html#l00235">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00216">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00212">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
242
243</div>
244</div><p>
245<hr>The documentation for this class was generated from the following file:<ul>
246<li>work/git/mixpp/bdm/stat/<a class="el" href="emix_8h-source.html">emix.h</a></ul>
247</div>
248<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 4 14:42:26 2008 for mixpp by&nbsp;
249<a href="http://www.doxygen.org/index.html">
250<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
251</body>
252</html>
Note: See TracBrowser for help on using the browser.