Show
Ignore:
Timestamp:
10/15/09 00:10:19 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/classbdm_1_1mexEpdf.html

    r656 r661  
    7272<div class="contents"> 
    7373<h1>bdm::mexEpdf Class Reference</h1><!-- doxytag: class="bdm::mexEpdf" --><!-- doxytag: inherits="bdm::epdf" --> 
     74<p><a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> with functions implemented in matlab   
     75<a href="#_details">More...</a></p> 
     76<hr/><a name="_details"></a><h2>Detailed Description</h2> 
     77<p><a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> with functions implemented in matlab </p> 
     78 
     79<p><code>#include &lt;<a class="el" href="mex__BM_8h_source.html">mex_BM.h</a>&gt;</code></p> 
     80 
    7481<p><a href="classbdm_1_1mexEpdf-members.html">List of all members.</a></p> 
    7582<table border="0" cellpadding="0" cellspacing="0"> 
    7683<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    7784<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexEpdf.html#af371482ea8d21c8ac01f011b3d942298">from_setting</a> (const Setting &amp;S)</td></tr> 
    78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load from structure with elements:.  <a href="#af371482ea8d21c8ac01f011b3d942298"></a><br/></td></tr> 
    7985<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a028dd3432d55e1fcc49f786a27f5afe8"></a><!-- doxytag: member="bdm::mexEpdf::mean" ref="a028dd3432d55e1fcc49f786a27f5afe8" args="() const " --> 
    8086vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexEpdf.html#a028dd3432d55e1fcc49f786a27f5afe8">mean</a> () const </td></tr> 
     
    113119virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#ab4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr> 
    114120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_14.png"/> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_15.png"/>. <br/></td></tr> 
    115 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeab266d63c236c277538867d5c3f249"></a><!-- doxytag: member="bdm::mexEpdf::evallog" ref="adeab266d63c236c277538867d5c3f249" args="(const vec &amp;val) const " --> 
    116 virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#adeab266d63c236c277538867d5c3f249">evallog</a> (const vec &amp;val) const </td></tr> 
    117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code> In case the argument is out of suport return -Infinity. <br/></td></tr> 
     121<tr><td class="memItemLeft" align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#adeab266d63c236c277538867d5c3f249">evallog</a> (const vec &amp;val) const </td></tr> 
    118122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad08b68a5abd461f1b6519597e344caf8"></a><!-- doxytag: member="bdm::mexEpdf::evallog_m" ref="ad08b68a5abd461f1b6519597e344caf8" args="(const mat &amp;Val) const " --> 
    119123virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#ad08b68a5abd461f1b6519597e344caf8">evallog_m</a> (const mat &amp;Val) const </td></tr> 
     
    135139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lower and upper bounds of <code>percentage</code> % quantile, returns mean-2*sigma as default. <br/></td></tr> 
    136140<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr> 
    137 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp14fc6e1cb822e9dfc5edc16c20fabe11"></a>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: </p> 
     141<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp14fc6e1cb822e9dfc5edc16c20fabe11"></a> 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: </p> 
    138142<br/><br/></div></td></tr> 
    139143<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::mexEpdf::set_rv" ref="af423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" --> 
     
    154158<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> 
    155159<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a287414259db205e5bc82c0023c09e633"></a><!-- doxytag: member="bdm::mexEpdf::name" ref="a287414259db205e5bc82c0023c09e633" args="" --> 
    156 string&nbsp;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr> 
     160string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexEpdf.html#a287414259db205e5bc82c0023c09e633">name</a></td></tr> 
     161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">prefix of matlab functions <br/></td></tr> 
    157162<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5190ab6b434834d4efdecaa7c264df67"></a><!-- doxytag: member="bdm::mexEpdf::data" ref="a5190ab6b434834d4efdecaa7c264df67" args="" --> 
    158 mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr> 
     163mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexEpdf.html#a5190ab6b434834d4efdecaa7c264df67">data</a></td></tr> 
     164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to storage structure <br/></td></tr> 
    159165<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::mexEpdf::dim" ref="a16adac20ec7fe07e1ea0b27d917788ce" args="" --> 
    160166int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr> 
     
    165171</table> 
    166172<hr/><h2>Member Function Documentation</h2> 
     173<a class="anchor" id="adeab266d63c236c277538867d5c3f249"></a><!-- doxytag: member="bdm::mexEpdf::evallog" ref="adeab266d63c236c277538867d5c3f249" args="(const vec &amp;val) const " --> 
     174<div class="memitem"> 
     175<div class="memproto"> 
     176      <table class="memname"> 
     177        <tr> 
     178          <td class="memname">virtual double bdm::epdf::evallog </td> 
     179          <td>(</td> 
     180          <td class="paramtype">const vec &amp;&nbsp;</td> 
     181          <td class="paramname"> <em>val</em></td> 
     182          <td>&nbsp;)&nbsp;</td> 
     183          <td> const<code> [inline, virtual, inherited]</code></td> 
     184        </tr> 
     185      </table> 
     186</div> 
     187<div class="memdoc"> 
     188<p>Compute log-probability of argument <code>val</code> In case the argument is out of suport return -Infinity </p> 
     189 
     190<p>Reimplemented in <a class="el" href="classbdm_1_1MPF_1_1mpfepdf.html#a64823e29b83f15bfcb144126e03f4f3f">bdm::MPF::mpfepdf</a>, <a class="el" href="classbdm_1_1emix.html#a0f3db99f730bde6b7953931594537e8e">bdm::emix</a>, <a class="el" href="classbdm_1_1eprod.html#aa5a91e67d2f74ff2b0b8eecde2fa42e2">bdm::eprod</a>, <a class="el" href="classbdm_1_1eEF.html#aa36d06ecdd6f4c79dc122510eaccc692">bdm::eEF</a>, <a class="el" href="classbdm_1_1egamma.html#aa8e11e5a580ff42a1b205974c60768c6">bdm::egamma</a>, <a class="el" href="classbdm_1_1euni.html#acaa07b8307bd793d5339d6583e0aba81">bdm::euni</a>, <a class="el" href="classbdm_1_1eiWishartCh.html#aa6ddbd815b8b666dd542e97f009f89bb">bdm::eiWishartCh</a>, <a class="el" href="classbdm_1_1eEmp.html#a01654c014d3aa068f8d4ecba4be86d09">bdm::eEmp</a>, and <a class="el" href="classbdm_1_1merger__mix.html#a9737ad6d1ecf4e0cdd6cea6a40875a34">bdm::merger_mix</a>.</p> 
     191 
     192<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p> 
     193 
     194<p>Referenced by <a class="el" href="bdmbase_8cpp_source.html#l00164">bdm::epdf::evallog_m()</a>, and <a class="el" href="emix_8h_source.html#l00076">bdm::mratio::evallogcond()</a>.</p> 
     195 
     196</div> 
     197</div> 
    167198<a class="anchor" id="af371482ea8d21c8ac01f011b3d942298"></a><!-- doxytag: member="bdm::mexEpdf::from_setting" ref="af371482ea8d21c8ac01f011b3d942298" args="(const Setting &amp;S)" --> 
    168199<div class="memitem"> 
     
    180211</div> 
    181212<div class="memdoc"> 
    182  
    183 <p>Load from structure with elements:. </p> 
    184 <div class="fragment"><pre class="fragment">         { <a class="code" href="classbdm_1_1epdf.html#a62c5b8ff71d9ebe6cd58d3c342eb1dc8" title="Description of the random variable.">rv</a> = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
    185            <span class="comment">// elements of offsprings</span> 
    186          } 
     213<p>Load from structure with elements: </p> 
     214<div class="fragment"><pre class="fragment"> { <a class="code" href="classbdm_1_1epdf.html#a62c5b8ff71d9ebe6cd58d3c342eb1dc8" title="Description of the random variable.">rv</a> = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
     215   <span class="comment">// elements of offsprings</span> 
     216 } 
    187217</pre></div>  
    188218<p>Reimplemented from <a class="el" href="classbdm_1_1epdf.html#afa9efc98a065b31c630fe18cc418f725">bdm::epdf</a>.</p> 
    189219 
    190 <p>References <a class="el" href="config2mxstruct_8h_source.html#l00017">UImxConfig::mxconfig</a>.</p> 
    191  
    192 <p>Referenced by <a class="el" href="mex__BM_8h_source.html#l00055">bdm::mexBM::from_setting()</a>.</p> 
     220<p>References <a class="el" href="mex__BM_8h_source.html#l00023">data</a>, <a class="el" href="config2mxstruct_8h_source.html#l00017">UImxConfig::mxconfig</a>, and <a class="el" href="mex__BM_8h_source.html#l00021">name</a>.</p> 
     221 
     222<p>Referenced by <a class="el" href="mex__BM_8h_source.html#l00063">bdm::mexBM::from_setting()</a>.</p> 
    193223 
    194224</div> 
     
    198228</ul> 
    199229</div> 
    200 <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Oct 12 19:37:21 2009 for mixpp by&nbsp; 
     230<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:50 2009 for mixpp by&nbsp; 
    201231<a href="http://www.doxygen.org/index.html"> 
    202232<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>