Show
Ignore:
Timestamp:
09/12/09 11:41:43 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

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

    r591 r608  
    7272<div class="contents"> 
    7373<h1>bdm::mpdf Class Reference</h1><!-- doxytag: class="bdm::mpdf" --><!-- doxytag: inherits="bdm::root" --> 
    74 <p>Conditional probability density, e.g. modeling <img class="formulaInl" alt="$ f( x | y) $" src="form_132.png"/>, where <img class="formulaInl" alt="$ x $" src="form_7.png"/> is random variable, <code>rv</code>, and <img class="formulaInl" alt="$ y $" src="form_133.png"/> is conditioning variable, <code>rvc</code>.   
     74<p>Conditional probability density, e.g. modeling <img class="formulaInl" alt="$ f( x | y) $" src="form_2.png"/>, where <img class="formulaInl" alt="$ x $" src="form_3.png"/> is random variable, <code>rv</code>, and <img class="formulaInl" alt="$ y $" src="form_4.png"/> is conditioning variable, <code>rvc</code>.   
    7575<a href="#_details">More...</a></p> 
    7676 
     
    8181<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    8282<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#a30a0bceb948e287d497c578e371b1667">from_setting</a> (const Setting &amp;set)</td></tr> 
     83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load from structure with elements:.  <a href="#a30a0bceb948e287d497c578e371b1667"></a><br/></td></tr> 
    8384<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mpdf::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
    8485virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     
    101102<br/><br/></div></td></tr> 
    102103<tr><td class="memItemLeft" align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#af0c1db6fcbb3aae2dd6123884457a367">samplecond</a> (const vec &amp;cond)</td></tr> 
    103 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_11.png"/>.  <a href="#af0c1db6fcbb3aae2dd6123884457a367"></a><br/></td></tr> 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_16.png"/>.  <a href="#af0c1db6fcbb3aae2dd6123884457a367"></a><br/></td></tr> 
    104105<tr><td class="memItemLeft" align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#a6e497d501331057309d2fddf63259d1a">samplecond_m</a> (const vec &amp;cond, int N)</td></tr> 
    105106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#a6e497d501331057309d2fddf63259d1a"></a><br/></td></tr> 
     
    116117<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p> 
    117118<br/><br/></div></td></tr> 
    118 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a222d5280e309c5a053ba73841e98c151"></a><!-- doxytag: member="bdm::mpdf::_rv" ref="a222d5280e309c5a053ba73841e98c151" args="() const " --> 
    119 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr> 
    120 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mpdf::_rvc" ref="a26001264236846897bd11e4baad47245" args="()" --> 
    121 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr> 
     119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0095f80870f15209bca68a8a7bad8a"></a><!-- doxytag: member="bdm::mpdf::_rv" ref="aaa0095f80870f15209bca68a8a7bad8a" args="() const " --> 
     120const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr> 
     121<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a739d5202899bb56792a547c74e517a11"></a><!-- doxytag: member="bdm::mpdf::_rvc" ref="a739d5202899bb56792a547c74e517a11" args="() const " --> 
     122const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> () const </td></tr> 
    122123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mpdf::dimension" ref="aeea4a999ed9679181335927e9cb66d28" args="() const " --> 
    123124int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr> 
     
    149150</table> 
    150151<hr/><a name="_details"></a><h2>Detailed Description</h2> 
    151 <p>Conditional probability density, e.g. modeling <img class="formulaInl" alt="$ f( x | y) $" src="form_132.png"/>, where <img class="formulaInl" alt="$ x $" src="form_7.png"/> is random variable, <code>rv</code>, and <img class="formulaInl" alt="$ y $" src="form_133.png"/> is conditioning variable, <code>rvc</code>. </p> 
     152<p>Conditional probability density, e.g. modeling <img class="formulaInl" alt="$ f( x | y) $" src="form_2.png"/>, where <img class="formulaInl" alt="$ x $" src="form_3.png"/> is random variable, <code>rv</code>, and <img class="formulaInl" alt="$ y $" src="form_4.png"/> is conditioning variable, <code>rvc</code>. </p> 
    152153<hr/><h2>Member Function Documentation</h2> 
    153154<a class="anchor" id="a30a0bceb948e287d497c578e371b1667"></a><!-- doxytag: member="bdm::mpdf::from_setting" ref="a30a0bceb948e287d497c578e371b1667" args="(const Setting &amp;set)" --> 
     
    166167</div> 
    167168<div class="memdoc"> 
    168 <p>Load from structure with elements: </p> 
    169 <div class="fragment"><pre class="fragment"> { <span class="keyword">class </span>= &quot;mpdf_offspring&quot;, 
    170    rv = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
    171    <a class="code" href="classbdm_1_1mpdf.html#a5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a>= {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable in condition</span> 
    172    <span class="comment">// elements of offsprings</span> 
    173  } 
     169 
     170<p>Load from structure with elements:. </p> 
     171<div class="fragment"><pre class="fragment">         { <span class="keyword">class </span>= &quot;mpdf_offspring&quot;, 
     172           rv = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
     173           <a class="code" href="classbdm_1_1mpdf.html#a5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a>= {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable in condition</span> 
     174           <span class="comment">// elements of offsprings</span> 
     175         } 
    174176</pre></div>  
    175177<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
     
    195197<div class="memdoc"> 
    196198 
    197 <p>Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_11.png"/>. </p> 
     199<p>Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_16.png"/>. </p> 
    198200<dl><dt><b>Parameters:</b></dt><dd> 
    199201  <table border="0" cellspacing="2" cellpadding="0"> 
     
    207209<p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p> 
    208210 
    209 <p>Referenced by <a class="el" href="particles_8h_source.html#l00239">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="particles_8cpp_source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00170">samplecond_m()</a>.</p> 
     211<p>Referenced by <a class="el" href="particles_8h_source.html#l00239">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="particles_8cpp_source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00179">samplecond_m()</a>.</p> 
    210212 
    211213</div> 
     
    239241<dl><dt><b>Parameters:</b></dt><dd> 
    240242  <table border="0" cellspacing="2" cellpadding="0"> 
    241     <tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_11.png"/>. </td></tr> 
     243    <tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_16.png"/>. </td></tr> 
    242244    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr> 
    243245  </table> 
     
    247249<p>Reimplemented in <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; EPDF &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; sq_T &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; elognorm &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; TEpdf&lt; sq_T &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; egamma &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; ldmat &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; eiWishartCh &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; eigamma &gt;</a>, and <a class="el" href="classbdm_1_1mpdf__internal.html#a9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; chmat &gt; &gt;</a>.</p> 
    248250 
    249 <p>References <a class="el" href="bdmbase_8h_source.html#l00433">samplecond()</a>.</p> 
     251<p>References <a class="el" href="bdmbase_8h_source.html#l00478">samplecond()</a>.</p> 
    250252 
    251253</div> 
     
    256258</ul> 
    257259</div> 
    258 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp; 
     260<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp; 
    259261<a href="http://www.doxygen.org/index.html"> 
    260262<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>