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

doc/html/classbdm_1_1emix.html

@@ -29 +29 @@
 </div>
 <div class="contents">
-<h1>bdm::emix Class Reference</h1><!-- doxytag: class="bdm::emix" --><!-- doxytag: inherits="bdm::epdf" -->Mixture of epdfs.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
+<h1>bdm::emix Class Reference</h1><!-- doxytag: class="bdm::emix" --><!-- doxytag: inherits="bdm::epdf" --><code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
 <p>
 <div class="dynheader">
@@ -41 +38 @@
 <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::emix:</div>
-<div class="dynsection">
-<p><center><img src="classbdm_1_1emix__coll__graph.png" border="0" usemap="#bdm_1_1emix__coll__map" alt="Collaboration graph"></center>
-<map name="bdm_1_1emix__coll__map">
-<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"></map>
-<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
 <p>
-<a href="classbdm_1_1emix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<a href="classbdm_1_1emix-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Mixture of epdfs. 
+<p>
+Density function: <p class="formulaDsp">
+<img class="formulaDsp" alt="\[ f(x) = \sum_{i=1}^{n} w_{i} f_i(x), \quad \sum_{i=1}^n w_i = 1. \]" src="form_63.png">
+<p>
+ where <img class="formulaInl" alt="$f_i(x)$" src="form_64.png"> is any density on random variable <img class="formulaInl" alt="$x$" src="form_28.png">, called <em>component</em>, <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="38649cee71ed9d8c32cfe8bb4b78a98b"></a><!-- doxytag: member="bdm::emix::emix" ref="38649cee71ed9d8c32cfe8bb4b78a98b" args="(const RV &amp;rv)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1emix.html#38649cee71ed9d8c32cfe8bb4b78a98b">emix</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4838f3a376ee0bd3c658bfb8f4ea4a3d"></a><!-- doxytag: member="bdm::emix::emix" ref="4838f3a376ee0bd3c658bfb8f4ea4a3d" args="()" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1emix.html#4838f3a376ee0bd3c658bfb8f4ea4a3d">emix</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
@@ -62 +58 @@
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1emix.html#e8839dbbb0d1276a8dbe957a67cfe0dc">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="a3a5390bc56e81ef3b0debc0f185fa8a"></a><!-- doxytag: member="bdm::emix::mean" ref="a3a5390bc56e81ef3b0debc0f185fa8a" args="() const " -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1emix.html#a3a5390bc56e81ef3b0debc0f185fa8a">mean</a> () const </td></tr>
@@ -103 +99 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <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::emix::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 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::emix::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::emix::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::emix::_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::emix::_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::emix::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="bb7270345c76da627cd77ddf020bcf46"></a><!-- doxytag: member="bdm::emix::w" ref="bb7270345c76da627cd77ddf020bcf46" args="" -->
@@ -128 +136 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flag if owning Coms. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::emix::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::emix::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>
-Mixture of epdfs. 
-<p>
-Density function: <p class="formulaDsp">
-<img class="formulaDsp" alt="\[ f(x) = \sum_{i=1}^{n} w_{i} f_i(x), \quad \sum_{i=1}^n w_i = 1. \]" src="form_63.png">
-<p>
- where <img class="formulaInl" alt="$f_i(x)$" src="form_64.png"> is any density on random variable <img class="formulaInl" alt="$x$" src="form_28.png">, called <em>component</em>, <hr><h2>Member Function Documentation</h2>
+<hr><h2>Member Function Documentation</h2>
 <a class="anchor" name="d8c1aefba8302759836b5f26999ce840"></a><!-- doxytag: member="bdm::emix::set_parameters" ref="d8c1aefba8302759836b5f26999ce840" args="(const vec &amp;w, const Array&lt; epdf * &gt; &amp;Coms, bool copy=true)" -->
 <div class="memitem">
@@ -173 +179 @@
 <p>
 Set weights <code>w</code> and components <code>Coms</code> By default Coms are copied inside. Parameter <code>copy</code> can be set to false if Coms live externally. Use method <a class="el" href="classbdm_1_1emix.html#965fb16669250a3d28bc62cf76276d8e" title="Auxiliary function for taking ownership of the Coms().">ownComs()</a> if Coms should be destroyed by the destructor. 
-<p>References <a class="el" href="libBM_8h-source.html#l00216">bdm::epdf::_rv()</a>, <a class="el" href="emix_8h-source.html#l00091">Coms</a>, <a class="el" href="emix_8h-source.html#l00093">destroyComs</a>, <a class="el" href="libBM_8cpp-source.html#l00118">bdm::RV::equal()</a>, <a class="el" href="libBM_8h-source.html#l00177">bdm::epdf::rv</a>, and <a class="el" href="emix_8h-source.html#l00089">w</a>.</p>
+<p>References <a class="el" href="libBM_8h-source.html#l00265">bdm::epdf::_rv()</a>, <a class="el" href="emix_8h-source.html#l00093">Coms</a>, <a class="el" href="emix_8h-source.html#l00095">destroyComs</a>, <a class="el" href="libBM_8h-source.html#l00212">bdm::epdf::dim</a>, <a class="el" href="libBM_8cpp-source.html#l00093">bdm::RV::equal()</a>, <a class="el" href="libBM_8h-source.html#l00214">bdm::epdf::rv</a>, and <a class="el" href="emix_8h-source.html#l00091">w</a>.</p>
 
-<p>Referenced by <a class="el" href="emix_8cpp-source.html#l00036">marginal()</a>, <a class="el" href="mixef_8cpp-source.html#l00134">bdm::MixEF::predictor()</a>, and <a class="el" href="emix_8h-source.html#l00297">bdm::mmix::set_parameters()</a>.</p>
+<p>Referenced by <a class="el" href="mixef_8cpp-source.html#l00134">bdm::MixEF::epredictor()</a>, <a class="el" href="emix_8cpp-source.html#l00037">marginal()</a>, and <a class="el" href="emix_8h-source.html#l00299">bdm::mmix::set_parameters()</a>.</p>
 
 </div>
@@ -182 +188 @@
 <li><a class="el" href="emix_8h-source.html">emix.h</a><li>emix.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:20:52 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:03 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>