Changeset 171 for doc/html/classegiw.html

Timestamp:

09/24/08 13:08:07 (16 years ago)

Author:

smidl

Message:

New documentation

Files:

• doc/html/classegiw.html (modified) (5 diffs)

doc/html/classegiw.html

@@ -51 +51 @@
 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#c52a2173c6eb1490edce9c6c7c05d60b">egiw</a> (<a class="el" href="classRV.html">RV</a> <a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>, mat V0, double nu0)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#3d2c1f2ba0f9966781f1e0ae695e8a6f">sample</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor, assuming. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a17fdbac6c72b9c3abb97623db466c8"></a><!-- doxytag: member="egiw::egiw" ref="1a17fdbac6c72b9c3abb97623db466c8" args="(RV rv, ldmat V0, double nu0)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#1a17fdbac6c72b9c3abb97623db466c8">egiw</a> (<a class="el" href="classRV.html">RV</a> <a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>, <a class="el" href="classldmat.html">ldmat</a> V0, double nu0)</td></tr>
 
-<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="#3d2c1f2ba0f9966781f1e0ae695e8a6f"></a><br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor for V in <a class="el" href="classldmat.html" title="Matrix stored in LD form, (typically known as UD).">ldmat</a> form. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d2c1f2ba0f9966781f1e0ae695e8a6f"></a><!-- doxytag: member="egiw::sample" ref="3d2c1f2ba0f9966781f1e0ae695e8a6f" args="() const " -->
+vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#3d2c1f2ba0f9966781f1e0ae695e8a6f">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="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6deb0ff2859f41ef7cbdf6a842cabb29"></a><!-- doxytag: member="egiw::mean" ref="6deb0ff2859f41ef7cbdf6a842cabb29" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#6deb0ff2859f41ef7cbdf6a842cabb29">mean</a> () const </td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="425cbc53b377274e28c6add942bab62d"></a><!-- doxytag: member="egiw::evalpdflog" ref="425cbc53b377274e28c6add942bab62d" args="(const vec &amp;val) const " -->
-double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#425cbc53b377274e28c6add942bab62d">evalpdflog</a> (const vec &amp;val) const </td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9594f396acc5ad186d1c5b03b0745502"></a><!-- doxytag: member="egiw::mean_mat" ref="9594f396acc5ad186d1c5b03b0745502" args="(mat &amp;M, mat &amp;R) const " -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>mean_mat</b> (mat &amp;M, mat &amp;R) const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ab1e525d692be8272a6f383d60b94cd"></a><!-- doxytag: member="egiw::evalpdflog_nn" ref="2ab1e525d692be8272a6f383d60b94cd" args="(const vec &amp;val) const " -->
+double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#2ab1e525d692be8272a6f383d60b94cd">evalpdflog_nn</a> (const vec &amp;val) const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">In this instance, val= [theta, r]. For multivariate instances, it is stored columnwise val = [theta_1 theta_2 ... r_1 r_2 ]. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70eb1a0b88459b227f919b425b0d3359"></a><!-- doxytag: member="egiw::lognc" ref="70eb1a0b88459b227f919b425b0d3359" args="() const " -->
 double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#70eb1a0b88459b227f919b425b0d3359">lognc</a> () const </td></tr>
@@ -75 +83 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a pointer to the internal statistics. Use with Care! <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd88bc35550ec8fe9281d358216d0fcf"></a><!-- doxytag: member="egiw::tupdate" ref="fd88bc35550ec8fe9281d358216d0fcf" args="(double phi, mat &amp;vbar, double nubar)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#fd88bc35550ec8fe9281d358216d0fcf">tupdate</a> (double phi, mat &amp;vbar, double nubar)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="036306322a90a9977834baac07460816"></a><!-- doxytag: member="egiw::pow" ref="036306322a90a9977834baac07460816" args="(double p)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#036306322a90a9977834baac07460816">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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a89bef8996410609004fa019b5b48964"></a><!-- doxytag: member="egiw::dupdate" ref="a89bef8996410609004fa019b5b48964" args="(mat &amp;v)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#a89bef8996410609004fa019b5b48964">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="5863718c3b2fb1496dece10c5b745d5c"></a><!-- doxytag: member="egiw::dupdate" ref="5863718c3b2fb1496dece10c5b745d5c" args="(mat &amp;v, double nu=1.0)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#5863718c3b2fb1496dece10c5b745d5c">dupdate</a> (mat &amp;v, double <a class="el" href="classegiw.html#4a2f130b91afe84f6d62fed289d5d453">nu</a>=1.0)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6466e8d4aa9dd64698ed288cbb1afc03"></a><!-- doxytag: member="egiw::evalpdflog" ref="6466e8d4aa9dd64698ed288cbb1afc03" args="(const vec &amp;val) const " -->
+virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#6466e8d4aa9dd64698ed288cbb1afc03">evalpdflog</a> (const vec &amp;val) const </td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></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="c71faf4b2d153efda14bf1f87dca1507"></a><!-- doxytag: member="egiw::evalpdflog" ref="c71faf4b2d153efda14bf1f87dca1507" args="(const mat &amp;Val) const " -->
+virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#c71faf4b2d153efda14bf1f87dca1507">evalpdflog</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="54d7dd53a641b618771cd9bee135181f"></a><!-- doxytag: member="egiw::sampleN" ref="54d7dd53a641b618771cd9bee135181f" args="(int N) const " -->
 virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#54d7dd53a641b618771cd9bee135181f">sampleN</a> (int N) const </td></tr>
@@ -91 +107 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4778ea61ef400813e47750e024e9fc2f"></a><!-- doxytag: member="egiw::_rv" ref="4778ea61ef400813e47750e024e9fc2f" args="()" -->
-<a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#4778ea61ef400813e47750e024e9fc2f">_rv</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="egiw::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
+const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#ca0d32aabb4cbba347e0c37fe8607562">_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="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="egiw::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#7fb94ce90d1ac7077d29f7d6a6c3e0a5">_renewrv</a> (const <a class="el" href="classRV.html">RV</a> &amp;in_rv)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <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="f343d03ede89db820edf44a6297fa442"></a><!-- doxytag: member="egiw::V" ref="f343d03ede89db820edf44a6297fa442" args="" -->
@@ -104 +124 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of data records (degrees of freedom) of sufficient statistics. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d5c719f15a5527a6c62c2a53160148e"></a><!-- doxytag: member="egiw::xdim" ref="3d5c719f15a5527a6c62c2a53160148e" args="" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#3d5c719f15a5527a6c62c2a53160148e">xdim</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dimension of the output. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c70d13d86e0d9f0acede3e1dc0368812"></a><!-- doxytag: member="egiw::nPsi" ref="c70d13d86e0d9f0acede3e1dc0368812" args="" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#c70d13d86e0d9f0acede3e1dc0368812">nPsi</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dimension of the regressor. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="egiw::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
 <a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a></td></tr>
@@ -112 +140 @@
 Gauss-inverse-Wishart density stored in LD form. 
 <p>
-More?... <hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="3d2c1f2ba0f9966781f1e0ae695e8a6f"></a><!-- doxytag: member="egiw::sample" ref="3d2c1f2ba0f9966781f1e0ae695e8a6f" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">vec egiw::sample           </td>
-          <td>(</td>
-          <td class="paramname">          </td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>
-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>. 
-<p>
-Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png"> 
-<p>Implements <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf</a>.</p>
-
-</div>
-</div><p>
-<hr>The documentation for this class was generated from the following files:<ul>
+For <img class="formulaInl" alt="$p$" src="form_42.png">-variate densities, given rv.count() should be <img class="formulaInl" alt="$p\times$" src="form_72.png"> V.rows(). <hr>The documentation for this class was generated from the following files:<ul>
 <li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a><li>work/git/mixpp/bdm/stat/libEF.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 4 19:28:08 2008 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:50 2008 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>