Changeset 270 for doc/html/classbdm_1_1egamma.html

Timestamp:

02/16/09 10:02:08 (16 years ago)

Author:

smidl

Message:

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

Files:

• doc/html/classbdm_1_1egamma.html (modified) (7 diffs)

doc/html/classbdm_1_1egamma.html

@@ -29 +29 @@
 </div>
 <div class="contents">
-<h1>bdm::egamma Class Reference</h1><!-- doxytag: class="bdm::egamma" --><!-- doxytag: inherits="bdm::eEF" -->Gamma posterior density.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
+<h1>bdm::egamma Class Reference</h1><!-- doxytag: class="bdm::egamma" --><!-- doxytag: inherits="bdm::eEF" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
 <p>
 <div class="dynheader">
@@ -41 +38 @@
 <area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="23,161,103,188"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="20,84,105,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="7,7,119,33"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
-<div class="dynheader">
-Collaboration diagram for bdm::egamma:</div>
-<div class="dynsection">
-<p><center><img src="classbdm_1_1egamma__coll__graph.png" border="0" usemap="#bdm_1_1egamma__coll__map" alt="Collaboration graph"></center>
-<map name="bdm_1_1egamma__coll__map">
-<area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="23,263,103,289"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="20,183,105,209"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="12,7,124,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="79,87,153,113"></map>
-<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
 <p>
-<a href="classbdm_1_1egamma-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<a href="classbdm_1_1egamma-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Gamma posterior density. 
+<p>
+Multivariate Gamma density as product of independent univariate densities. <p class="formulaDsp">
+<img class="formulaDsp" alt="\[ f(x|\alpha,\beta) = \prod f(x_i|\alpha_i,\beta_i) \]" src="form_8.png">
+<p>
+ <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4dafabaa0881300b18f791bc614ef487"></a><!-- doxytag: member="bdm::egamma::egamma" ref="4dafabaa0881300b18f791bc614ef487" args="(const RV &amp;rv)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#4dafabaa0881300b18f791bc614ef487">egamma</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="131197f3dfad99355a01d30903279653"></a><!-- doxytag: member="bdm::egamma::egamma" ref="131197f3dfad99355a01d30903279653" args="()" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#131197f3dfad99355a01d30903279653">egamma</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
@@ -64 +60 @@
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#6ed82f0fd05f6002487256d8e75a0bbd">sample</a> () const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_106.png"> from density <img class="formulaInl" alt="$ f_x()$" src="form_107.png">. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e11e5a580ff42a1b205974c60768c6"></a><!-- doxytag: member="bdm::egamma::evallog" ref="a8e11e5a580ff42a1b205974c60768c6" args="(const vec &amp;val) const " -->
 double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#a8e11e5a580ff42a1b205974c60768c6">evallog</a> (const vec &amp;val) const </td></tr>
@@ -73 +69 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_60.png"> <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="498c1fe5e8382ab2f97d629849741855"></a><!-- doxytag: member="bdm::egamma::_param" ref="498c1fe5e8382ab2f97d629849741855" args="(vec *&amp;a, vec *&amp;b)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#498c1fe5e8382ab2f97d629849741855">_param</a> (vec *&amp;a, vec *&amp;b)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0865cb3d6339fdc7410806cf70a329ed"></a><!-- doxytag: member="bdm::egamma::_alpha" ref="0865cb3d6339fdc7410806cf70a329ed" args="()" -->
+vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#0865cb3d6339fdc7410806cf70a329ed">_alpha</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns poiter to alpha and beta. Potentially dengerous: use with care! <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c42cadd9cbd344caaa69b0b433cd16ca"></a><!-- doxytag: member="bdm::egamma::_beta" ref="c42cadd9cbd344caaa69b0b433cd16ca" args="()" -->
+vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_beta</b> ()</td></tr>
+
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49d256c42cce14c6faa56ec242b57e85"></a><!-- doxytag: member="bdm::egamma::mean" ref="49d256c42cce14c6faa56ec242b57e85" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#49d256c42cce14c6faa56ec242b57e85">mean</a> () const </td></tr>
@@ -101 +100 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr>
+<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::egamma::sample_m" ref="b4cf45fd83cc7573ede9fe1215256058" args="(int N) const " -->
 virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#b4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_108.png"> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_109.png">. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34956d4dd3176eeb5937cf48a1546b62"></a><!-- doxytag: member="bdm::egamma::evallog_m" ref="34956d4dd3176eeb5937cf48a1546b62" args="(const mat &amp;Val) const " -->
 virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#34956d4dd3176eeb5937cf48a1546b62">evallog_m</a> (const mat &amp;Val) const </td></tr>
@@ -117 +117 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>, the remainig rvs are intergrated out. <br></td></tr>
+<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr>
+<tr><td colspan="2"><div class="groupText">Description of the random quantity via attribute <code>rv</code> is optional. For operations such as sampling <code>rv</code> does not need to be set. However, for <code>marginalization</code> and <code>conditioning</code> <code>rv</code> has to be set. NB: <br><br></div></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::egamma::set_rv" ref="f423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#f423e28448dbb69ef4905295ec8de8ff">set_rv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::egamma::isnamed" ref="c4b863ff84c7a4882fb3ad18556027f9" args="() const " -->
+bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#c4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::egamma::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4ab378d5e004c3ff3e2d4e64f7bba21">_rv</a> () const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62e88cbce0ce77a8692f5e15d76e805f"></a><!-- doxytag: member="bdm::egamma::_renewrv" ref="62e88cbce0ce77a8692f5e15d76e805f" args="(const RV &amp;in_rv)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62e88cbce0ce77a8692f5e15d76e805f">_renewrv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;in_rv)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br></td></tr>
+<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46dfe100cd621716ee5c7ee25a20f24b"></a><!-- doxytag: member="bdm::egamma::dimension" ref="46dfe100cd621716ee5c7ee25a20f24b" args="() const " -->
+bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#46dfe100cd621716ee5c7ee25a20f24b">dimension</a> () const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br></td></tr>
 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0901ec983e66b8337aaa506e13b122fa"></a><!-- doxytag: member="bdm::egamma::alpha" ref="0901ec983e66b8337aaa506e13b122fa" args="" -->
@@ -134 +145 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\beta$" src="form_16.png">. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::egamma::dim" ref="16adac20ec7fe07e1ea0b27d917788ce" args="" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::egamma::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a></td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br></td></tr>
 </table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-Gamma posterior density. 
-<p>
-Multivariate Gamma density as product of independent univariate densities. <p class="formulaDsp">
-<img class="formulaDsp" alt="\[ f(x|\alpha,\beta) = \prod f(x_i|\alpha_i,\beta_i) \]" src="form_8.png">
-<p>
- <hr>The documentation for this class was generated from the following files:<ul>
+<hr>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="libEF_8h-source.html">libEF.h</a><li>libEF.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:21:07 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:06 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>