Changeset 270 for doc/html/classbdm_1_1egiw.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_1egiw.html (modified) (7 diffs)

doc/html/classbdm_1_1egiw.html

@@ -29 +29 @@
 </div>
 <div class="contents">
-<h1>bdm::egiw Class Reference</h1><!-- doxytag: class="bdm::egiw" --><!-- doxytag: inherits="bdm::eEF" -->Gauss-inverse-Wishart density stored in LD form.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
+<h1>bdm::egiw Class Reference</h1><!-- doxytag: class="bdm::egiw" --><!-- 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="21,161,101,188"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="19,84,104,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
-<div class="dynheader">
-Collaboration diagram for bdm::egiw:</div>
-<div class="dynsection">
-<p><center><img src="classbdm_1_1egiw__coll__graph.png" border="0" usemap="#bdm_1_1egiw__coll__map" alt="Collaboration graph"></center>
-<map name="bdm_1_1egiw__coll__map">
-<area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="19,263,99,289"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="13,183,99,209"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="72,87,147,113"><area shape="rect" href="classldmat.html" title="Matrix stored in LD form, (commonly known as UD)." alt="" coords="124,263,183,289"><area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="123,183,184,209"></map>
-<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
 <p>
-<a href="classbdm_1_1egiw-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<a href="classbdm_1_1egiw-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Gauss-inverse-Wishart density stored in LD form. 
+<p>
+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(). <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="a60e072c191acf65ab480deeb11c5b88"></a><!-- doxytag: member="bdm::egiw::egiw" ref="a60e072c191acf65ab480deeb11c5b88" args="(RV rv, mat V0, double nu0=-1.0)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#a60e072c191acf65ab480deeb11c5b88">egiw</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> <a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>, mat V0, double nu0=-1.0)</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor, if nu0&lt;0 a minimal nu0 will be computed. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc3db93cb60dd29187eb3c6cfd557f97"></a><!-- doxytag: member="bdm::egiw::egiw" ref="bc3db93cb60dd29187eb3c6cfd557f97" args="(RV rv, ldmat V0, double nu0=-1.0)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#bc3db93cb60dd29187eb3c6cfd557f97">egiw</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> <a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>, <a class="el" href="classldmat.html">ldmat</a> V0, double nu0=-1.0)</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, (commonly known as UD).">ldmat</a> form. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="920f21548b7a3723923dd108fe514c61"></a><!-- doxytag: member="bdm::egiw::sample" ref="920f21548b7a3723923dd108fe514c61" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#920f21548b7a3723923dd108fe514c61">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="df70c05f918c3a6f86d60f10c1fd6ba2"></a><!-- doxytag: member="bdm::egiw::mean" ref="df70c05f918c3a6f86d60f10c1fd6ba2" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#df70c05f918c3a6f86d60f10c1fd6ba2">mean</a> () const </td></tr>
@@ -84 +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="15792f3112e5cf67d572f491b09324c8"></a><!-- doxytag: member="bdm::egiw::_V" ref="15792f3112e5cf67d572f491b09324c8" args="()" -->
-<a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#15792f3112e5cf67d572f491b09324c8">_V</a> ()</td></tr>
-
-<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="ad9c539a80a552e837245ddcebcbbba4"></a><!-- doxytag: member="bdm::egiw::_V" ref="ad9c539a80a552e837245ddcebcbbba4" args="() const " -->
-const <a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#ad9c539a80a552e837245ddcebcbbba4">_V</a> () const </td></tr>
-
-<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="a025ee710274ca142dd0ae978735ad4a"></a><!-- doxytag: member="bdm::egiw::_nu" ref="a025ee710274ca142dd0ae978735ad4a" args="()" -->
-double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#a025ee710274ca142dd0ae978735ad4a">_nu</a> ()</td></tr>
-
-<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="cf3b2bcb158c15c24788bba90e4154e4"></a><!-- doxytag: member="bdm::egiw::_nu" ref="cf3b2bcb158c15c24788bba90e4154e4" args="() const " -->
-const double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_nu</b> () const </td></tr>
-
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e610e95401a11baf34f65e16ecd87be"></a><!-- doxytag: member="bdm::egiw::pow" ref="8e610e95401a11baf34f65e16ecd87be" args="(double p)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#8e610e95401a11baf34f65e16ecd87be">pow</a> (double p)</td></tr>
@@ -115 +85 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <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="50149cf136c9120b4fff71c117f0bb2e"></a><!-- doxytag: member="bdm::egiw::egiw" ref="50149cf136c9120b4fff71c117f0bb2e" args="()" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>egiw</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="79037e048e717a076f342eb1d276870e"></a><!-- doxytag: member="bdm::egiw::egiw" ref="79037e048e717a076f342eb1d276870e" args="(int dimx0, ldmat V0, double nu0=-1.0)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>egiw</b> (int dimx0, <a class="el" href="classldmat.html">ldmat</a> V0, double nu0=-1.0)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40b04f8ef133d089c4be2c7983e18b5c"></a><!-- doxytag: member="bdm::egiw::set_parameters" ref="40b04f8ef133d089c4be2c7983e18b5c" args="(int dimx0, ldmat V0, double nu0=-1.0)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (int dimx0, <a class="el" href="classldmat.html">ldmat</a> V0, double nu0=-1.0)</td></tr>
+
+<tr><td colspan="2"><div class="groupHeader">Access attributes</div></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15792f3112e5cf67d572f491b09324c8"></a><!-- doxytag: member="bdm::egiw::_V" ref="15792f3112e5cf67d572f491b09324c8" args="()" -->
+<a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_V</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad9c539a80a552e837245ddcebcbbba4"></a><!-- doxytag: member="bdm::egiw::_V" ref="ad9c539a80a552e837245ddcebcbbba4" args="() const " -->
+const <a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_V</b> () const </td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a025ee710274ca142dd0ae978735ad4a"></a><!-- doxytag: member="bdm::egiw::_nu" ref="a025ee710274ca142dd0ae978735ad4a" args="()" -->
+double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_nu</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf3b2bcb158c15c24788bba90e4154e4"></a><!-- doxytag: member="bdm::egiw::_nu" ref="cf3b2bcb158c15c24788bba90e4154e4" args="() const " -->
+const double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_nu</b> () const </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::egiw::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::egiw::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>
@@ -131 +125 @@
 
 <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::egiw::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::egiw::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::egiw::_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::egiw::_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::egiw::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="ae56852845c6af176fd9017dbebbbd52"></a><!-- doxytag: member="bdm::egiw::V" ref="ae56852845c6af176fd9017dbebbbd52" args="" -->
@@ -148 +153 @@
 
 <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="40b68a9c3b2120fba94cc4d2fcd291e1"></a><!-- doxytag: member="bdm::egiw::xdim" ref="40b68a9c3b2120fba94cc4d2fcd291e1" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#40b68a9c3b2120fba94cc4d2fcd291e1">xdim</a></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23e4d78bea7e98840f3da30e76a2b57a"></a><!-- doxytag: member="bdm::egiw::dimx" ref="23e4d78bea7e98840f3da30e76a2b57a" args="" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egiw.html#23e4d78bea7e98840f3da30e76a2b57a">dimx</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dimension of the output. <br></td></tr>
@@ -156 +161 @@
 
 <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="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::egiw::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::egiw::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>
-Gauss-inverse-Wishart density stored in LD form. 
-<p>
-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>
+<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:05 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>