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

doc/html/classbdm_1_1merger.html

@@ -29 +29 @@
 </div>
 <div class="contents">
-<h1>bdm::merger Class Reference</h1><!-- doxytag: class="bdm::merger" --><!-- doxytag: inherits="bdm::compositepdf,bdm::epdf" -->Function for general combination of pdfs.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="merger_8h-source.html">merger.h</a>&gt;</code>
+<h1>bdm::merger Class Reference</h1><!-- doxytag: class="bdm::merger" --><!-- doxytag: inherits="bdm::compositepdf,bdm::epdf" --><code>#include &lt;<a class="el" href="merger_8h-source.html">merger.h</a>&gt;</code>
 <p>
 <div class="dynheader">
@@ -41 +38 @@
 <area shape="rect" href="classbdm_1_1compositepdf.html" title="Abstract composition of pdfs, will be used for specific classes this abstract class..." alt="" coords="5,84,149,111"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="173,84,259,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="160,7,272,33"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
-<div class="dynheader">
-Collaboration diagram for bdm::merger:</div>
-<div class="dynsection">
-<p><center><img src="classbdm_1_1merger__coll__graph.png" border="0" usemap="#bdm_1_1merger__coll__map" alt="Collaboration graph"></center>
-<map name="bdm_1_1merger__coll__map">
-<area shape="rect" href="classbdm_1_1compositepdf.html" title="Abstract composition of pdfs, will be used for specific classes this abstract class..." alt="" coords="5,588,149,615"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="291,199,376,225"><area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="373,279,453,305"><area shape="rect" href="classbdm_1_1eprod.html" title="Product of independent epdfs. For dependent pdfs, use mprod." alt="" coords="285,332,381,359"><area shape="rect" href="classbdm_1_1eEmp.html" title="Weighted empirical density." alt="" coords="207,439,303,465"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="352,7,464,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="371,87,445,113"><area shape="rect" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities." alt="" coords="444,199,521,225"><area shape="rect" href="classbdm_1_1MixEF.html" title="Mixture of Exponential Family Densities." alt="" coords="320,588,413,615"><area shape="rect" href="classbdm_1_1BMEF.html" title="Estimator for Exponential family." alt="" coords="496,385,589,412"><area shape="rect" href="classbdm_1_1multiBM.html" title="Estimator for Multinomial density." alt="" coords="371,492,480,519"><area shape="rect" href="classbdm_1_1eDirich.html" title="Dirichlet posterior density." alt="" coords="371,385,472,412"></map>
-<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
-
-<p>
-<a href="classbdm_1_1merger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+
+<p>
+<a href="classbdm_1_1merger-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Function for general combination of pdfs. 
+<p>
+Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial. <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
@@ -113 +106 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">common rvc of all mpdfs is written to rvc <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::merger::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::merger::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>
@@ -129 +123 @@
 
 <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::merger::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::merger::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::merger::_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::merger::_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">modifier function - useful when copying epdfs <br></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::merger::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">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="67ae71cbf0686d7c7bf116fa5db86d81"></a><!-- doxytag: member="bdm::merger::Mix" ref="67ae71cbf0686d7c7bf116fa5db86d81" args="" -->
@@ -178 +183 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::merger::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::merger::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>
-Function for general combination of pdfs. 
-<p>
-Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial. <hr><h2>Member Function Documentation</h2>
+<hr><h2>Member Function Documentation</h2>
 <a class="anchor" name="0ef73e76eeee44c8e3896e3a271ad974"></a><!-- doxytag: member="bdm::merger::sample" ref="0ef73e76eeee44c8e3896e3a271ad974" args="() const " -->
 <div class="memitem">
@@ -235 +241 @@
 </dl>
 
-<p>References <a class="el" href="libBM_8cpp-source.html#l00060">bdm::RV::add()</a>, <a class="el" href="libBM_8h-source.html#l00438">bdm::compositepdf::mpdfs</a>, and <a class="el" href="libBM_8h-source.html#l00436">bdm::compositepdf::n</a>.</p>
+<p>References <a class="el" href="libBM_8cpp-source.html#l00059">bdm::RV::add()</a>, <a class="el" href="libBM_8h-source.html#l00508">bdm::compositepdf::mpdfs</a>, and <a class="el" href="libBM_8h-source.html#l00506">bdm::compositepdf::n</a>.</p>
 
 </div>
@@ -242 +248 @@
 <li><a class="el" href="merger_8h-source.html">merger.h</a><li>merger.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:20:49 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:02 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>