Changeset 287 for doc/html/classbdm_1_1eigamma.html

Timestamp:

03/05/09 14:03:56 (15 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1eigamma.html (modified) (8 diffs)

doc/html/classbdm_1_1eigamma.html

@@ -69 +69 @@
 </div>
 <div class="contents">
-<h1>bdm::eigamma Class Reference</h1><!-- doxytag: class="bdm::eigamma" --><!-- doxytag: inherits="bdm::eEF" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
+<h1>bdm::eigamma Class Reference</h1><!-- doxytag: class="bdm::eigamma" --><!-- doxytag: inherits="bdm::egamma" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
 <p>
 <div class="dynheader">
@@ -77 +77 @@
 <p><center><img src="classbdm_1_1eigamma.png" usemap="#bdm::eigamma_map" border="0" alt=""></center>
 <map name="bdm::eigamma_map">
+<area href="classbdm_1_1egamma.html" alt="bdm::egamma" shape="rect" coords="0,168,90,192">
 <area href="classbdm_1_1eEF.html" alt="bdm::eEF" shape="rect" coords="0,112,90,136">
 <area href="classbdm_1_1epdf.html" alt="bdm::epdf" shape="rect" coords="0,56,90,80">
@@ -91 +92 @@
 <p>
 <p>
+Vector <img class="formulaInl" alt="$\beta$" src="form_76.png"> has different meaning (in fact it is 1/beta as used in definition of iG)<p>
 Inverse Gamma can be converted to Gamma using <p class="formulaDsp">
 <img class="formulaDsp" alt="\[ x\sim iG(a,b) => 1/x\sim G(a,1/b) \]" src="form_60.png">
@@ -97 +99 @@
 <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="a8e11e5a580ff42a1b205974c60768c6"></a><!-- doxytag: member="bdm::eigamma::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>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO: is it used anywhere? <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79a7c8ea8c02e45d410bd1d7ffd72b41"></a><!-- doxytag: member="bdm::eigamma::evallog" ref="79a7c8ea8c02e45d410bd1d7ffd72b41" args="(const mat &amp;Val) const " -->
+virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#79a7c8ea8c02e45d410bd1d7ffd72b41">evallog</a> (const mat &amp;Val) const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a66cbd100e8520c769ccb3c451f86f8"></a><!-- doxytag: member="bdm::eigamma::lognc" ref="9a66cbd100e8520c769ccb3c451f86f8" args="() const " -->
+double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#9a66cbd100e8520c769ccb3c451f86f8">lognc</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_74.png"> <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0865cb3d6339fdc7410806cf70a329ed"></a><!-- doxytag: member="bdm::eigamma::_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::eigamma::_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="deef7d6273ba4d5a5cf0bbd91ec7277a"></a><!-- doxytag: member="bdm::eigamma::dupdate" ref="deef7d6273ba4d5a5cf0bbd91ec7277a" args="(mat &amp;v)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#deef7d6273ba4d5a5cf0bbd91ec7277a">dupdate</a> (mat &amp;v)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4135778ecd9ab774762936c82a097c6"></a><!-- doxytag: member="bdm::eigamma::evallog_nn" ref="a4135778ecd9ab774762936c82a097c6" args="(const vec &amp;val) const " -->
+virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#a4135778ecd9ab774762936c82a097c6">evallog_nn</a> (const vec &amp;val) const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf38af29e8e3d650c640509a52396053"></a><!-- doxytag: member="bdm::eigamma::pow" ref="cf38af29e8e3d650c640509a52396053" args="(double p)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#cf38af29e8e3d650c640509a52396053">pow</a> (double p)</td></tr>
+
+<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"></div></td></tr>
+<tr><td colspan="2"><div class="groupText">All constructors are inherited <br><br></div></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3aff7bf25ddac27731c60826fcfd878f"></a><!-- doxytag: member="bdm::eigamma::sample" ref="3aff7bf25ddac27731c60826fcfd878f" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#3aff7bf25ddac27731c60826fcfd878f">sample</a> () const </td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_42.png"> from density <img class="formulaInl" alt="$ f_x()$" src="form_43.png">. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e26c80c8e6708bfcf2e684958af6f91"></a><!-- doxytag: member="bdm::eigamma::evallog" ref="9e26c80c8e6708bfcf2e684958af6f91" args="(const vec &amp;val) const " -->
-double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#9e26c80c8e6708bfcf2e684958af6f91">evallog</a> (const vec &amp;val) const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO: is it used anywhere? <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a52ac6d523e2fe05642d1f50fe66aec2"></a><!-- doxytag: member="bdm::eigamma::lognc" ref="a52ac6d523e2fe05642d1f50fe66aec2" args="() const " -->
-double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#a52ac6d523e2fe05642d1f50fe66aec2">lognc</a> () const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_74.png"> <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46cecb295edbabd28120cb0f6f572bcb"></a><!-- doxytag: member="bdm::eigamma::mean" ref="46cecb295edbabd28120cb0f6f572bcb" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#46cecb295edbabd28120cb0f6f572bcb">mean</a> () const </td></tr>
@@ -117 +144 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b3693d30bcc8c6bd873f9c49825cdeb"></a><!-- doxytag: member="bdm::eigamma::_alpha" ref="0b3693d30bcc8c6bd873f9c49825cdeb" args="()" -->
-vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_alpha</b> ()</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5aa95bce22824f16b46f8cd3ace9dae"></a><!-- doxytag: member="bdm::eigamma::_beta" ref="d5aa95bce22824f16b46f8cd3ace9dae" 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="deef7d6273ba4d5a5cf0bbd91ec7277a"></a><!-- doxytag: member="bdm::eigamma::dupdate" ref="deef7d6273ba4d5a5cf0bbd91ec7277a" args="(mat &amp;v)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#deef7d6273ba4d5a5cf0bbd91ec7277a">dupdate</a> (mat &amp;v)</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4135778ecd9ab774762936c82a097c6"></a><!-- doxytag: member="bdm::eigamma::evallog_nn" ref="a4135778ecd9ab774762936c82a097c6" args="(const vec &amp;val) const " -->
-virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#a4135778ecd9ab774762936c82a097c6">evallog_nn</a> (const vec &amp;val) const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79a7c8ea8c02e45d410bd1d7ffd72b41"></a><!-- doxytag: member="bdm::eigamma::evallog" ref="79a7c8ea8c02e45d410bd1d7ffd72b41" args="(const mat &amp;Val) const " -->
-virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#79a7c8ea8c02e45d410bd1d7ffd72b41">evallog</a> (const mat &amp;Val) const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf38af29e8e3d650c640509a52396053"></a><!-- doxytag: member="bdm::eigamma::pow" ref="cf38af29e8e3d650c640509a52396053" args="(double p)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#cf38af29e8e3d650c640509a52396053">pow</a> (double p)</td></tr>
-
-<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">Constructors</div></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b496396f3511ce87d7ae3830ba94262c"></a><!-- doxytag: member="bdm::eigamma::eigamma" ref="b496396f3511ce87d7ae3830ba94262c" args="()" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><b>eigamma</b> ()</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2870f6a8ffda9eb2fbaf9f85ea04c05f"></a><!-- doxytag: member="bdm::eigamma::eigamma" ref="2870f6a8ffda9eb2fbaf9f85ea04c05f" args="(const vec &amp;a, const vec &amp;b)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><b>eigamma</b> (const vec &amp;a, const vec &amp;b)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09e616c95f31acddf7dfef96d1c5d645"></a><!-- doxytag: member="bdm::eigamma::set_parameters" ref="09e616c95f31acddf7dfef96d1c5d645" args="(const vec &amp;a, const vec &amp;b)" -->
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="749f82293ff23a8319c1bf52489d2ed2"></a><!-- doxytag: member="bdm::eigamma::set_parameters" ref="749f82293ff23a8319c1bf52489d2ed2" args="(const vec &amp;a, const vec &amp;b)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (const vec &amp;a, const vec &amp;b)</td></tr>
 
@@ -179 +178 @@
 
 <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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::eigamma::qbounds" ref="0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#0a7705e80601957f7226d333a0a6d539">qbounds</a> (vec &amp;lb, vec &amp;ub, double percentage=0.95) const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lower and upper bounds of <code>percentage</code> % quantile, returns mean-2*sigma as default. <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>
@@ -199 +202 @@
 <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="3e5c03201f073033a7db894fa15ddb96"></a><!-- doxytag: member="bdm::eigamma::eg" ref="3e5c03201f073033a7db894fa15ddb96" args="" -->
-<a class="el" href="classbdm_1_1egamma.html">egamma</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#3e5c03201f073033a7db894fa15ddb96">eg</a></td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal <a class="el" href="classbdm_1_1egamma.html" title="Gamma posterior density.">egamma</a> <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="494fafd76d9448395efe160c9ba11ab6"></a><!-- doxytag: member="bdm::eigamma::alpha" ref="494fafd76d9448395efe160c9ba11ab6" args="" -->
-vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#494fafd76d9448395efe160c9ba11ab6">alpha</a></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0901ec983e66b8337aaa506e13b122fa"></a><!-- doxytag: member="bdm::eigamma::alpha" ref="0901ec983e66b8337aaa506e13b122fa" args="" -->
+vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#0901ec983e66b8337aaa506e13b122fa">alpha</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\alpha$" src="form_75.png">. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e32ff12ba6b2fdc22068c35dace23fa6"></a><!-- doxytag: member="bdm::eigamma::beta" ref="e32ff12ba6b2fdc22068c35dace23fa6" args="" -->
-vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eigamma.html#e32ff12ba6b2fdc22068c35dace23fa6">beta</a></td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\beta$" src="form_76.png"> (in fact it is 1/beta as used in definition of iG). <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="457bfb1ccb2057df85073e519a15ccc1"></a><!-- doxytag: member="bdm::eigamma::beta" ref="457bfb1ccb2057df85073e519a15ccc1" args="" -->
+vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#457bfb1ccb2057df85073e519a15ccc1">beta</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\beta$" src="form_76.png">. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::eigamma::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>
@@ -223 +222 @@
 <li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:39:20 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:23 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>