root/doc/html/classmEF.html @ 255

Revision 234, 15.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: mEF 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>mEF Class Reference</h1><!-- doxytag: class="mEF" --><!-- doxytag: inherits="mpdf" -->Exponential family model. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for mEF:</div>
34<div class="dynsection">
35<p><center><img src="classmEF__inherit__graph.png" border="0" usemap="#mEF__inherit__map" alt="Inheritance graph"></center>
36<map name="mEF__inherit__map">
37<area shape="rect" href="classmgamma.html" title="Gamma random walk." alt="" coords="21,167,104,193"><area shape="rect" href="classmigamma.html" title="Inverse&#45;Gamma random walk." alt="" coords="137,167,225,193"><area shape="rect" href="classmlnorm.html" title="Normal distributed linear function with linear function of mean value;." alt="" coords="249,167,380,193"><area shape="rect" href="classmlnorm.html" title="mlnorm\&lt; ldmat \&gt;" alt="" coords="305,263,444,289"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="209,7,263,33"><area shape="rect" href="classmgamma__fix.html" title="Gamma random walk around a fixed point." alt="" coords="5,263,109,289"><area shape="rect" href="classmigamma__fix.html" title="Inverse&#45;Gamma random walk around a fixed point." alt="" coords="133,263,240,289"><area shape="rect" href="classmlstudent.html" title="mlstudent" alt="" coords="332,343,417,369"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for mEF:</div>
41<div class="dynsection">
42<p><center><img src="classmEF__coll__graph.png" border="0" usemap="#mEF__coll__map" alt="Collaboration graph"></center>
43<map name="mEF__coll__map">
44<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,185,56,209"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="17,6,55,30"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="51,96,96,120"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classmEF-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="8bf51fe8654d7b83c8c8afeb19409d4f"></a><!-- doxytag: member="mEF::mEF" ref="8bf51fe8654d7b83c8c8afeb19409d4f" args="(const RV &amp;rv0, const RV &amp;rvc0)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmEF.html#8bf51fe8654d7b83c8c8afeb19409d4f">mEF</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv0, const <a class="el" href="classRV.html">RV</a> &amp;rvc0)</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">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>
56
57<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="#3f172b79ec4a5ebc87898a5381141f1b"></a><br></td></tr>
58<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>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#b1dae6171ee39a6a05976c7b1007a3c5"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f95a0cc6ab40611f46804682446ed83"></a><!-- doxytag: member="mEF::condition" ref="0f95a0cc6ab40611f46804682446ed83" args="(const vec &amp;cond)" -->
62virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">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="classmpdf.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"><a class="anchor" name="2ef8a6374029d990a678782f6decebbe"></a><!-- doxytag: member="mEF::evallogcond" ref="2ef8a6374029d990a678782f6decebbe" args="(const vec &amp;dt, const vec &amp;cond)" -->
66virtual 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>
67
68<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>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95fcff214848f66f1b489459370573fa"></a><!-- doxytag: member="mEF::evallogcond_m" ref="95fcff214848f66f1b489459370573fa" args="(const mat &amp;Dt, const vec &amp;cond)" -->
70virtual 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>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15ef062183b1ccdf794732d5fa0b77cd"></a><!-- doxytag: member="mEF::_rvc" ref="15ef062183b1ccdf794732d5fa0b77cd" args="() const " -->
74<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>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71256ffb5fbd08f41d650e606a5bd585"></a><!-- doxytag: member="mEF::_rv" ref="71256ffb5fbd08f41d650e606a5bd585" args="() const " -->
78<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>
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="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mEF::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
82<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>
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="75ded3b0f657cd7da6590691a810963c"></a><!-- doxytag: member="mEF::_e" ref="75ded3b0f657cd7da6590691a810963c" args="()" -->
86<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#75ded3b0f657cd7da6590691a810963c">_e</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="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mEF::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
91<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>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mEF::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
95<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>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mEF::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
99<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>
100
101<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>
102</table>
103<hr><a name="_details"></a><h2>Detailed Description</h2>
104Exponential family model.
105<p>
106More?... <hr><h2>Member Function Documentation</h2>
107<a class="anchor" name="3f172b79ec4a5ebc87898a5381141f1b"></a><!-- doxytag: member="mEF::samplecond" ref="3f172b79ec4a5ebc87898a5381141f1b" args="(const vec &amp;cond, double &amp;ll)" -->
108<div class="memitem">
109<div class="memproto">
110      <table class="memname">
111        <tr>
112          <td class="memname">virtual vec mpdf::samplecond           </td>
113          <td>(</td>
114          <td class="paramtype">const vec &amp;&nbsp;</td>
115          <td class="paramname"> <em>cond</em>, </td>
116        </tr>
117        <tr>
118          <td class="paramkey"></td>
119          <td></td>
120          <td class="paramtype">double &amp;&nbsp;</td>
121          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
122        </tr>
123        <tr>
124          <td></td>
125          <td>)</td>
126          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
127        </tr>
128      </table>
129</div>
130<div class="memdoc">
131
132<p>
133Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
134<p>
135<dl compact><dt><b>Parameters:</b></dt><dd>
136  <table border="0" cellspacing="2" cellpadding="0">
137    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
138    <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>
139  </table>
140</dl>
141
142<p>Reimplemented in <a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">mprod</a>.</p>
143
144<p>References <a class="el" href="libBM_8h-source.html#l00239">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00222">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>
145
146<p>Referenced by <a class="el" href="libPF_8h-source.html#l00147">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p>
147
148</div>
149</div><p>
150<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mEF::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
151<div class="memitem">
152<div class="memproto">
153      <table class="memname">
154        <tr>
155          <td class="memname">virtual mat mpdf::samplecond_m           </td>
156          <td>(</td>
157          <td class="paramtype">const vec &amp;&nbsp;</td>
158          <td class="paramname"> <em>cond</em>, </td>
159        </tr>
160        <tr>
161          <td class="paramkey"></td>
162          <td></td>
163          <td class="paramtype">vec &amp;&nbsp;</td>
164          <td class="paramname"> <em>ll</em>, </td>
165        </tr>
166        <tr>
167          <td class="paramkey"></td>
168          <td></td>
169          <td class="paramtype">int&nbsp;</td>
170          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
171        </tr>
172        <tr>
173          <td></td>
174          <td>)</td>
175          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
176        </tr>
177      </table>
178</div>
179<div class="memdoc">
180
181<p>
182Returns.
183<p>
184<dl compact><dt><b>Parameters:</b></dt><dd>
185  <table border="0" cellspacing="2" cellpadding="0">
186    <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>
187    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
188    <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>
189  </table>
190</dl>
191
192<p>References <a class="el" href="libBM_8h-source.html#l00239">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00222">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00218">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
193
194</div>
195</div><p>
196<hr>The documentation for this class was generated from the following file:<ul>
197<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
198</div>
199<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:51:19 2009 for mixpp by&nbsp;
200<a href="http://www.doxygen.org/index.html">
201<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
202</body>
203</html>
Note: See TracBrowser for help on using the browser.