Show
Ignore:
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:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1eDirich.html

    r269 r270  
    2929</div> 
    3030<div class="contents"> 
    31 <h1>bdm::eDirich Class Reference</h1><!-- doxytag: class="bdm::eDirich" --><!-- doxytag: inherits="bdm::eEF" -->Dirichlet posterior density.   
    32 <a href="#_details">More...</a> 
    33 <p> 
    34 <code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code> 
     31<h1>bdm::eDirich Class Reference</h1><!-- doxytag: class="bdm::eDirich" --><!-- doxytag: inherits="bdm::eEF" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code> 
    3532<p> 
    3633<div class="dynheader"> 
     
    4138<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> 
    4239<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    43 <div class="dynheader"> 
    44 Collaboration diagram for bdm::eDirich:</div> 
    45 <div class="dynsection"> 
    46 <p><center><img src="classbdm_1_1eDirich__coll__graph.png" border="0" usemap="#bdm_1_1eDirich__coll__map" alt="Collaboration graph"></center> 
    47 <map name="bdm_1_1eDirich__coll__map"> 
    48 <area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="16,263,96,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"></map> 
    49 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    5040 
    5141<p> 
    52 <a href="classbdm_1_1eDirich-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
     42<a href="classbdm_1_1eDirich-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 
     43Dirichlet posterior density.  
     44<p> 
     45Continuous Dirichlet density of <img class="formulaInl" alt="$n$" src="form_73.png">-dimensional variable <img class="formulaInl" alt="$x$" src="form_28.png"> <p class="formulaDsp"> 
     46<img class="formulaDsp" alt="\[ f(x|\beta) = \frac{\Gamma[\gamma]}{\prod_{i=1}^{n}\Gamma(\beta_i)} \prod_{i=1}^{n}x_i^{\beta_i-1} \]" src="form_76.png"> 
     47<p> 
     48 where <img class="formulaInl" alt="$\gamma=\sum_i \beta_i$" src="form_77.png">. <table border="0" cellpadding="0" cellspacing="0"> 
    5349<tr><td></td></tr> 
    5450<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ae893fe9167f67bca09bc159acbf957"></a><!-- doxytag: member="bdm::eDirich::eDirich" ref="2ae893fe9167f67bca09bc159acbf957" args="(const RV &amp;rv, const vec &amp;beta0)" --> 
    56 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eDirich.html#2ae893fe9167f67bca09bc159acbf957">eDirich</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>, const vec &amp;beta0)</td></tr> 
     51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5137485050ca8d67549b514896f602d"></a><!-- doxytag: member="bdm::eDirich::eDirich" ref="d5137485050ca8d67549b514896f602d" args="()" --> 
     52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eDirich.html#d5137485050ca8d67549b514896f602d">eDirich</a> ()</td></tr> 
    5753 
    5854<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr> 
     
    6460vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eDirich.html#3290613d31d58daa8a45a54b003871fc">sample</a> () const </td></tr> 
    6561 
    66 <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> 
     62<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> 
    6763<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb343355ec791298bb5a3404cd482fb6"></a><!-- doxytag: member="bdm::eDirich::mean" ref="cb343355ec791298bb5a3404cd482fb6" args="() const " --> 
    6864vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eDirich.html#cb343355ec791298bb5a3404cd482fb6">mean</a> () const </td></tr> 
     
    105101 
    106102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr> 
     103<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr> 
    107104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::eDirich::sample_m" ref="b4cf45fd83cc7573ede9fe1215256058" args="(int N) const " --> 
    108105virtual 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> 
    109106 
    110 <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> 
     107<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> 
    111108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34956d4dd3176eeb5937cf48a1546b62"></a><!-- doxytag: member="bdm::eDirich::evallog_m" ref="34956d4dd3176eeb5937cf48a1546b62" args="(const mat &amp;Val) const " --> 
    112109virtual 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> 
     
    121118 
    122119<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> 
     120<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr> 
     121<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> 
     122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::eDirich::set_rv" ref="f423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" --> 
     123void&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> 
     124 
     125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr> 
     126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::eDirich::isnamed" ref="c4b863ff84c7a4882fb3ad18556027f9" args="() const " --> 
     127bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#c4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr> 
     128 
     129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br></td></tr> 
    123130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::eDirich::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " --> 
    124131const <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> 
    125132 
    126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr> 
    127 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62e88cbce0ce77a8692f5e15d76e805f"></a><!-- doxytag: member="bdm::eDirich::_renewrv" ref="62e88cbce0ce77a8692f5e15d76e805f" args="(const RV &amp;in_rv)" --> 
    128 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> 
     133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br></td></tr> 
     134<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr> 
     135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46dfe100cd621716ee5c7ee25a20f24b"></a><!-- doxytag: member="bdm::eDirich::dimension" ref="46dfe100cd621716ee5c7ee25a20f24b" args="() const " --> 
     136bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#46dfe100cd621716ee5c7ee25a20f24b">dimension</a> () const </td></tr> 
    129137 
    130 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr> 
     138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br></td></tr> 
    131139<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    132140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f25886a49b4667af61245de81c83b5d2"></a><!-- doxytag: member="bdm::eDirich::beta" ref="f25886a49b4667af61245de81c83b5d2" args="" --> 
     
    138146 
    139147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">speedup variable <br></td></tr> 
     148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::eDirich::dim" ref="16adac20ec7fe07e1ea0b27d917788ce" args="" --> 
     149int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr> 
     150 
     151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br></td></tr> 
    140152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::eDirich::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" --> 
    141153<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> 
    142154 
    143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr> 
     155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br></td></tr> 
    144156</table> 
    145 <hr><a name="_details"></a><h2>Detailed Description</h2> 
    146 Dirichlet posterior density.  
    147 <p> 
    148 Continuous Dirichlet density of <img class="formulaInl" alt="$n$" src="form_73.png">-dimensional variable <img class="formulaInl" alt="$x$" src="form_28.png"> <p class="formulaDsp"> 
    149 <img class="formulaDsp" alt="\[ f(x|\beta) = \frac{\Gamma[\gamma]}{\prod_{i=1}^{n}\Gamma(\beta_i)} \prod_{i=1}^{n}x_i^{\beta_i-1} \]" src="form_76.png"> 
    150 <p> 
    151  where <img class="formulaInl" alt="$\gamma=\sum_i \beta_i$" src="form_77.png">. <hr>The documentation for this class was generated from the following file:<ul> 
     157<hr>The documentation for this class was generated from the following file:<ul> 
    152158<li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul> 
    153159</div> 
    154 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:21:05 2009 for mixpp by&nbsp; 
     160<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:06 2009 for mixpp by&nbsp; 
    155161<a href="http://www.doxygen.org/index.html"> 
    156162<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>