root/doc/html/classbdm_1_1mgamma.html @ 270

Revision 270, 17.5 kB (checked in by smidl, 16 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::mgamma 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_1mgamma.html">mgamma</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::mgamma Class Reference</h1><!-- doxytag: class="bdm::mgamma" --><!-- doxytag: inherits="bdm::mEF" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::mgamma:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1mgamma__inherit__graph.png" border="0" usemap="#bdm_1_1mgamma__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1mgamma__inherit__map">
38<area shape="rect" href="classbdm_1_1mgamma__fix.html" title="Gamma random walk around a fixed point." alt="" coords="5,316,147,343"><area shape="rect" href="classbdm_1_1mEF.html" title="Exponential family model." alt="" coords="33,161,119,188"><area shape="rect" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="31,84,121,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="20,7,132,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_1mgamma-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Gamma random walk.
44<p>
45Mean value, <img class="formulaInl" alt="$\mu$" src="form_14.png">, of this density is given by <code>rvc</code> . Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_41.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_11.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_12.png">.<p>
46The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_13.png">. <table border="0" cellpadding="0" cellspacing="0">
47<tr><td></td></tr>
48<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a9dc8661e5b214a8185d6e6b9956eb1"></a><!-- doxytag: member="bdm::mgamma::mgamma" ref="1a9dc8661e5b214a8185d6e6b9956eb1" args="()" -->
50&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#1a9dc8661e5b214a8185d6e6b9956eb1">mgamma</a> ()</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b486f7e52a3d8a39adbcbd325461c0d"></a><!-- doxytag: member="bdm::mgamma::set_parameters" ref="0b486f7e52a3d8a39adbcbd325461c0d" args="(double k)" -->
54void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#0b486f7e52a3d8a39adbcbd325461c0d">set_parameters</a> (double <a class="el" href="classbdm_1_1mgamma.html#b20cf88cca1fe9b0b8f2a412608bfd09">k</a>)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8996500f1885e39cde30221b20900bff"></a><!-- doxytag: member="bdm::mgamma::condition" ref="8996500f1885e39cde30221b20900bff" args="(const vec &amp;val)" -->
58void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#8996500f1885e39cde30221b20900bff">condition</a> (const vec &amp;val)</td></tr>
59
60<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>
61<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
62<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>
63
64<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>
65<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>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mgamma::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
69virtual 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>
70
71<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>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mgamma::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
73virtual 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>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
76<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mgamma::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
78<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
79
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mgamma::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
81<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
82
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mgamma::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
84int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
85
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mgamma::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
87int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
88
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mgamma::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
90<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mgamma::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
93<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
94
95<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mgamma::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
97void&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>
98
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mgamma::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
100void&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>
101
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mgamma::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
103bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
104
105<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bdc9f1e9e03c09e91103fee269864438"></a><!-- doxytag: member="bdm::mgamma::epdf" ref="bdc9f1e9e03c09e91103fee269864438" args="" -->
107<a class="el" href="classbdm_1_1egamma.html">egamma</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#bdc9f1e9e03c09e91103fee269864438">epdf</a></td></tr>
108
109<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> that arise by conditioning on <code>rvc</code>. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b20cf88cca1fe9b0b8f2a412608bfd09"></a><!-- doxytag: member="bdm::mgamma::k" ref="b20cf88cca1fe9b0b8f2a412608bfd09" args="" -->
111double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#b20cf88cca1fe9b0b8f2a412608bfd09">k</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant <img class="formulaInl" alt="$k$" src="form_41.png">. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95f4dde9214ff6dba265e18af60312"></a><!-- doxytag: member="bdm::mgamma::_beta" ref="3d95f4dde9214ff6dba265e18af60312" args="" -->
115vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#3d95f4dde9214ff6dba265e18af60312">_beta</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of epdf.beta <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mgamma::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
119int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mgamma::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
123<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>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mgamma::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
127<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>
128
129<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>
130</table>
131<hr><h2>Member Function Documentation</h2>
132<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mgamma::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
133<div class="memitem">
134<div class="memproto">
135      <table class="memname">
136        <tr>
137          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
138          <td>(</td>
139          <td class="paramtype">const vec &amp;&nbsp;</td>
140          <td class="paramname"> <em>cond</em>          </td>
141          <td>&nbsp;)&nbsp;</td>
142          <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  </table>
155</dl>
156
157<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>
158
159<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>
160
161</div>
162</div><p>
163<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mgamma::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
164<div class="memitem">
165<div class="memproto">
166      <table class="memname">
167        <tr>
168          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
169          <td>(</td>
170          <td class="paramtype">const vec &amp;&nbsp;</td>
171          <td class="paramname"> <em>cond</em>, </td>
172        </tr>
173        <tr>
174          <td class="paramkey"></td>
175          <td></td>
176          <td class="paramtype">int&nbsp;</td>
177          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
178        </tr>
179        <tr>
180          <td></td>
181          <td>)</td>
182          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
183        </tr>
184      </table>
185</div>
186<div class="memdoc">
187
188<p>
189Returns.
190<p>
191<dl compact><dt><b>Parameters:</b></dt><dd>
192  <table border="0" cellspacing="2" cellpadding="0">
193    <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>
194    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
195    <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>
196  </table>
197</dl>
198
199<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>
200
201</div>
202</div><p>
203<hr>The documentation for this class was generated from the following files:<ul>
204<li><a class="el" href="libEF_8h-source.html">libEF.h</a><li>libEF.cpp</ul>
205</div>
206<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:06 2009 for mixpp by&nbsp;
207<a href="http://www.doxygen.org/index.html">
208<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
209</body>
210</html>
Note: See TracBrowser for help on using the browser.