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_1mgamma.html

    r591 r608  
    8686void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#aa0f21c2557b233a85838b497d040ab14">set_parameters</a> (double <a class="el" href="classbdm_1_1mgamma.html#ab20cf88cca1fe9b0b8f2a412608bfd09">k</a>, const vec &amp;beta0)</td></tr> 
    8787<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br/></td></tr> 
    88 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#a8996500f1885e39cde30221b20900bff">condition</a> (const vec &amp;val)</td></tr> 
     88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8996500f1885e39cde30221b20900bff"></a><!-- doxytag: member="bdm::mgamma::condition" ref="a8996500f1885e39cde30221b20900bff" args="(const vec &amp;val)" --> 
     89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#a8996500f1885e39cde30221b20900bff">condition</a> (const vec &amp;val)</td></tr> 
     90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>iepdf</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a> conditioned on <code>rvc</code> = cond This function provides convenient reimplementation in offsprings. <br/></td></tr> 
    8991<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#ada2af0f327e5452bee71d1bf97452ae4">from_setting</a> (const Setting &amp;set)</td></tr> 
    9092<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b4d1cb8d7e230e313b4f0c905874d5a"></a><!-- doxytag: member="bdm::mgamma::e" ref="a6b4d1cb8d7e230e313b4f0c905874d5a" args="()" --> 
     
    118120<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p> 
    119121<br/><br/></div></td></tr> 
    120 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a222d5280e309c5a053ba73841e98c151"></a><!-- doxytag: member="bdm::mgamma::_rv" ref="a222d5280e309c5a053ba73841e98c151" args="() const " --> 
    121 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr> 
    122 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mgamma::_rvc" ref="a26001264236846897bd11e4baad47245" args="()" --> 
    123 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr> 
     122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0095f80870f15209bca68a8a7bad8a"></a><!-- doxytag: member="bdm::mgamma::_rv" ref="aaa0095f80870f15209bca68a8a7bad8a" args="() const " --> 
     123const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr> 
     124<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a739d5202899bb56792a547c74e517a11"></a><!-- doxytag: member="bdm::mgamma::_rvc" ref="a739d5202899bb56792a547c74e517a11" args="() const " --> 
     125const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> () const </td></tr> 
    124126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mgamma::dimension" ref="aeea4a999ed9679181335927e9cb66d28" args="() const " --> 
    125127int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr> 
     
    145147<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab20cf88cca1fe9b0b8f2a412608bfd09"></a><!-- doxytag: member="bdm::mgamma::k" ref="ab20cf88cca1fe9b0b8f2a412608bfd09" args="" --> 
    146148double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#ab20cf88cca1fe9b0b8f2a412608bfd09">k</a></td></tr> 
    147 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant <img class="formulaInl" alt="$k$" src="form_76.png"/>. <br/></td></tr> 
     149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant <img class="formulaInl" alt="$k$" src="form_84.png"/>. <br/></td></tr> 
    148150<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d95f4dde9214ff6dba265e18af60312"></a><!-- doxytag: member="bdm::mgamma::_beta" ref="a3d95f4dde9214ff6dba265e18af60312" args="" --> 
    149151vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#a3d95f4dde9214ff6dba265e18af60312">_beta</a></td></tr> 
     
    161163<hr/><a name="_details"></a><h2>Detailed Description</h2> 
    162164<p>Gamma random walk. </p> 
    163 <p>Mean value, <img class="formulaInl" alt="$\mu$" src="form_75.png"/>, of this density is given by <code>rvc</code> . Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_76.png"/>-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_77.png"/> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_78.png"/>.</p> 
    164 <p>The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_79.png"/>. </p> 
     165<p>Mean value, <img class="formulaInl" alt="$\mu$" src="form_83.png"/>, of this density is given by <code>rvc</code> . Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_84.png"/>-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_85.png"/> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_86.png"/>.</p> 
     166<p>The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_87.png"/>. </p> 
    165167<hr/><h2>Member Function Documentation</h2> 
    166 <a class="anchor" id="a8996500f1885e39cde30221b20900bff"></a><!-- doxytag: member="bdm::mgamma::condition" ref="a8996500f1885e39cde30221b20900bff" args="(const vec &amp;val)" --> 
    167 <div class="memitem"> 
    168 <div class="memproto"> 
    169       <table class="memname"> 
    170         <tr> 
    171           <td class="memname">void bdm::mgamma::condition </td> 
    172           <td>(</td> 
    173           <td class="paramtype">const vec &amp;&nbsp;</td> 
    174           <td class="paramname"> <em>cond</em></td> 
    175           <td>&nbsp;)&nbsp;</td> 
    176           <td><code> [inline, virtual]</code></td> 
    177         </tr> 
    178       </table> 
    179 </div> 
    180 <div class="memdoc"> 
    181 <p>Update <code>iepdf</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a> conditioned on <code>rvc</code> = cond This function provides convenient reimplementation in offsprings </p> 
    182  
    183 <p>Reimplemented from <a class="el" href="classbdm_1_1mpdf__internal.html#a1ac61da081667fc54bcd050cc4f6a93e">bdm::mpdf_internal&lt; egamma &gt;</a>.</p> 
    184  
    185 <p>Reimplemented in <a class="el" href="classbdm_1_1mgamma__fix.html#a1d539591deb7a38bb3403c2b396c8ff7">bdm::mgamma_fix</a>.</p> 
    186  
    187 <p>References <a class="el" href="exp__family_8h_source.html#l00720">_beta</a>, and <a class="el" href="exp__family_8h_source.html#l00717">k</a>.</p> 
    188  
    189 </div> 
    190 </div> 
    191168<a class="anchor" id="ada2af0f327e5452bee71d1bf97452ae4"></a><!-- doxytag: member="bdm::mgamma::from_setting" ref="ada2af0f327e5452bee71d1bf97452ae4" args="(const Setting &amp;set)" --> 
    192169<div class="memitem"> 
     
    222199</ul> 
    223200</div> 
    224 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:51 2009 for mixpp by&nbsp; 
     201<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp; 
    225202<a href="http://www.doxygen.org/index.html"> 
    226203<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>