Show
Ignore:
Timestamp:
06/24/09 13:38:47 (16 years ago)
Author:
mido
Message:

UI documentation almost finished; UIException redesigned and used instead of UI::ui_error function

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1mgamma__fix.html

    r385 r396  
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    88<script type="text/javascript"> 
    99<!-- 
    … …  
    7272<a href="#_details">More...</a> 
    7373<p> 
    74 <code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code> 
     74<code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code> 
    7575<p> 
    7676 
    … …  
    9595 
    9696<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr> 
    97 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mgamma_fix::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    98 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgamma.html#da2af0f327e5452bee71d1bf97452ae4">from_setting</a> (const Setting &amp;set)</td></tr> 
     98 
     99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mgamma_fix::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     100virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    99101 
    100102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::mgamma_fix::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    102 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr> 
    103  
    104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> 
    105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mgamma_fix::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    106 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr> 
     103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mgamma_fix::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    107105 
    108106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::mgamma_fix::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    110 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mgamma_fix::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     108virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    111109 
    112110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    126124 
    127125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr> 
     126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a0d03756f59924fd038980ee60bd904"></a><!-- doxytag: member="bdm::mgamma_fix::evallogcond_m" ref="2a0d03756f59924fd038980ee60bd904" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" --> 
     127virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#2a0d03756f59924fd038980ee60bd904">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr> 
     128 
     129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr> 
    128130<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr> 
    129131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mgamma_fix::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" --> 
    … …  
    198200Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_68.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_69.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_70.png">.<p> 
    199201The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_71.png">. <hr><h2>Member Function Documentation</h2> 
     202<a class="anchor" name="da2af0f327e5452bee71d1bf97452ae4"></a><!-- doxytag: member="bdm::mgamma_fix::from_setting" ref="da2af0f327e5452bee71d1bf97452ae4" args="(const Setting &amp;set)" --> 
     203<div class="memitem"> 
     204<div class="memproto"> 
     205      <table class="memname"> 
     206        <tr> 
     207          <td class="memname">void bdm::mgamma::from_setting           </td> 
     208          <td>(</td> 
     209          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     210          <td class="paramname"> <em>set</em>          </td> 
     211          <td>&nbsp;)&nbsp;</td> 
     212          <td><code> [inline, virtual, inherited]</code></td> 
     213        </tr> 
     214      </table> 
     215</div> 
     216<div class="memdoc"> 
     217 
     218<p> 
     219Load from structure with elements: <div class="fragment"><pre class="fragment"> { alpha = [...];         <span class="comment">// vector of alpha</span> 
     220   <a class="code" href="classbdm_1_1mgamma.html#b20cf88cca1fe9b0b8f2a412608bfd09" title="Constant .">k</a> = 1.1;               <span class="comment">// multiplicative constant k</span> 
     221   rv = {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>,...}  <span class="comment">// description of RV</span> 
     222   <a class="code" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a> = {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>,...} <span class="comment">// description of RV in condition</span> 
     223 } 
     224</pre></div>  
     225<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p> 
     226 
     227<p>References <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>, <a class="el" href="exp__family_8h_source.html#l00693">bdm::mgamma::k</a>, and <a class="el" href="exp__family_8cpp_source.html#l00214">bdm::mgamma::set_parameters()</a>.</p> 
     228 
     229</div> 
     230</div><p> 
    200231<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mgamma_fix::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" --> 
    201232<div class="memitem"> 
    … …  
    225256<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p> 
    226257 
    227 <p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p> 
    228  
    229 <p>Referenced by <a class="el" href="libPF_8h-source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="libPF_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="libDS_8cpp-source.html#l00044">bdm::ArxDS::step()</a>.</p> 
     258<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h_source.html#l00263">bdm::epdf::sample()</a>.</p> 
     259 
     260<p>Referenced by <a class="el" href="particles_8h_source.html#l00207">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="datasources_8cpp_source.html#l00043">bdm::ArxDS::step()</a>.</p> 
    230261 
    231262</div> 
    … …  
    266297</dl> 
    267298 
    268 <p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p> 
     299<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l00318">bdm::epdf::dimension()</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h_source.html#l00263">bdm::epdf::sample()</a>.</p> 
    269300 
    270301</div> 
    271302</div><p> 
    272303<hr>The documentation for this class was generated from the following file:<ul> 
    273 <li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul> 
    274 </div> 
    275 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     304<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></ul> 
     305</div> 
     306<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:57 2009 for mixpp by&nbsp; 
    276307<a href="http://www.doxygen.org/index.html"> 
    277 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     308<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    278309</body> 
    279310</html>