Changeset 270 for doc/html/classbdm_1_1epdf.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_1epdf.html (modified) (3 diffs)

doc/html/classbdm_1_1epdf.html

@@ -29 +29 @@
 </div>
 <div class="contents">
-<h1>bdm::epdf Class Reference</h1><!-- doxytag: class="bdm::epdf" --><!-- doxytag: inherits="bdm::bdmroot" -->Probability density function with numerical statistics, e.g. posterior density.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
+<h1>bdm::epdf Class Reference</h1><!-- doxytag: class="bdm::epdf" --><!-- doxytag: inherits="bdm::bdmroot" --><code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.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="375,183,455,209"><area shape="rect" href="classbdm_1_1eEmp.html" title="Weighted empirical density." alt="" coords="367,233,463,260"><area shape="rect" href="classbdm_1_1emix.html" title="Mixture of epdfs." alt="" coords="371,284,459,311"><area shape="rect" href="classbdm_1_1eprod.html" title="Product of independent epdfs. For dependent pdfs, use mprod." alt="" coords="367,335,463,361"><area shape="rect" href="classbdm_1_1euni.html" title="Uniform distributed density on a rectangular support." alt="" coords="372,385,457,412"><area shape="rect" href="classbdm_1_1merger.html" title="Function for general combination of pdfs." alt="" coords="363,436,467,463"><area shape="rect" title="internal class for MPDF providing composition of eEmp with external components" alt="" coords="311,487,519,513"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="7,335,119,361"><area shape="rect" href="classbdm_1_1eDirich.html" title="Dirichlet posterior density." alt="" coords="600,5,701,32"><area shape="rect" href="classbdm_1_1egamma.html" title="Gamma posterior density." alt="" coords="593,56,708,83"><area shape="rect" href="classbdm_1_1egiw.html" title="Gauss&#45;inverse&#45;Wishart density stored in LD form." alt="" coords="608,107,693,133"><area shape="rect" href="classbdm_1_1eigamma.html" title="Inverse&#45;Gamma posterior density." alt="" coords="591,157,711,184"><area shape="rect" href="classbdm_1_1enorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix." alt="" coords="571,276,731,303"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; ldmat \&gt;" alt="" coords="857,233,1025,260"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; chmat \&gt;" alt="" coords="856,307,1027,333"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; fsqmat \&gt;" alt="" coords="853,401,1029,428"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
-<div class="dynheader">
-Collaboration diagram for bdm::epdf:</div>
-<div class="dynsection">
-<p><center><img src="classbdm_1_1epdf__coll__graph.png" border="0" usemap="#bdm_1_1epdf__coll__map" alt="Collaboration graph"></center>
-<map name="bdm_1_1epdf__coll__map">
-<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"></map>
-<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
 <p>
-<a href="classbdm_1_1epdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<a href="classbdm_1_1epdf-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Probability density function with numerical statistics, e.g. posterior density. <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 colspan="2"><div class="groupHeader">Constructors</div></td></tr>
+<tr><td colspan="2"><div class="groupText">Construction of each <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> should support two types of constructors: <ul>
+<li>empty constructor, </li>
+<li>copy constructor, </li>
+<li>constructor followed by calling <code>set_parameters</code> for convenience.</li>
+</ul>
+All internal data structures are constructed as empty. Their values (including sizes) will be set by method <code>set_parameters()</code>. This way references can be initialized in constructors. <br><br></div></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="992f3de956fb3439c62225156aafb6f6"></a><!-- doxytag: member="bdm::epdf::epdf" ref="992f3de956fb3439c62225156aafb6f6" args="()" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#992f3de956fb3439c62225156aafb6f6">epdf</a> ()</td></tr>
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>epdf</b> ()</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"><a class="anchor" name="fdfed7aa18f2870951888b1dde977415"></a><!-- doxytag: member="bdm::epdf::epdf" ref="fdfed7aa18f2870951888b1dde977415" args="(const RV &amp;rv0)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#fdfed7aa18f2870951888b1dde977415">epdf</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e50af83245e56edf5cd76dbb4347d030"></a><!-- doxytag: member="bdm::epdf::epdf" ref="e50af83245e56edf5cd76dbb4347d030" args="(const epdf &amp;e)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>epdf</b> (const <a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;e)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <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="09721eb148bc49d6ec2f1956039f3a10"></a><!-- doxytag: member="bdm::epdf::sample" ref="09721eb148bc49d6ec2f1956039f3a10" args="() const =0" -->
 virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">sample</a> () const =0</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="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::epdf::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="a8e39e2ff5e5cf5471bc159530d3b2d3"></a><!-- doxytag: member="bdm::epdf::evallog" ref="a8e39e2ff5e5cf5471bc159530d3b2d3" args="(const vec &amp;val) const =0" -->
 virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a8e39e2ff5e5cf5471bc159530d3b2d3">evallog</a> (const vec &amp;val) const =0</td></tr>
@@ -93 +90 @@
 
 <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="a4fa8637e7307cb051c400c2ce0ca0c8"></a><!-- doxytag: member="bdm::epdf::~epdf" ref="a4fa8637e7307cb051c400c2ce0ca0c8" args="()" -->
-virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4fa8637e7307cb051c400c2ce0ca0c8">~epdf</a> ()</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::epdf::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">Destructor for future use;. <br></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::epdf::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::epdf::_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::epdf::_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::epdf::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="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::epdf::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::epdf::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>
-Probability density function with numerical statistics, e.g. posterior density. <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="libBM_8h-source.html">libBM.h</a><li>libBM.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:20:54 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:04 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>