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_1mlognorm.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 
    … …  
    9191 
    9292<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr> 
    93 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#3a130457942be64ee9544e8dff00d09b">from_setting</a> (const Setting &amp;root)</td></tr> 
    94  
    95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mlognorm::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    96 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     93<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#49e45ea13a869da607ef9be7a229128a">from_setting</a> (const Setting &amp;set)</td></tr> 
     94 
     95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mlognorm::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     96virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    9797 
    9898<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    99 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mlognorm::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    100 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> 
     99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mlognorm::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     100virtual 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> 
    101101 
    102102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    103 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::mlognorm::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    104 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mlognorm::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    105105 
    106106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    120120 
    121121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr> 
     122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a0d03756f59924fd038980ee60bd904"></a><!-- doxytag: member="bdm::mlognorm::evallogcond_m" ref="2a0d03756f59924fd038980ee60bd904" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" --> 
     123virtual 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> 
     124 
     125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr> 
    122126<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr> 
    123127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mlognorm::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" --> 
    … …  
    180184==== Check == vv = Standard 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> 
    181185The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_71.png">. <hr><h2>Member Function Documentation</h2> 
    182 <a class="anchor" name="3a130457942be64ee9544e8dff00d09b"></a><!-- doxytag: member="bdm::mlognorm::from_setting" ref="3a130457942be64ee9544e8dff00d09b" args="(const Setting &amp;root)" --> 
     186<a class="anchor" name="49e45ea13a869da607ef9be7a229128a"></a><!-- doxytag: member="bdm::mlognorm::from_setting" ref="49e45ea13a869da607ef9be7a229128a" args="(const Setting &amp;set)" --> 
    183187<div class="memitem"> 
    184188<div class="memproto"> 
    … …  
    188192          <td>(</td> 
    189193          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    190           <td class="paramname"> <em>root</em>          </td> 
     194          <td class="paramname"> <em>set</em>          </td> 
    191195          <td>&nbsp;)&nbsp;</td> 
    192196          <td><code> [virtual]</code></td> 
    … …  
    197201 
    198202<p> 
    199 <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1mlognorm.html" title="Log-Normal random walk.">mlognorm</a><p> 
     203<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> for <a class="el" href="classbdm_1_1mlognorm.html" title="Log-Normal random walk.">mlognorm</a><p> 
    200204The <a class="el" href="classbdm_1_1mlognorm.html" title="Log-Normal random walk.">mlognorm</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">                        system = { 
    201205                                type = <span class="stringliteral">"mlognorm"</span>; 
    … …  
    210214                        }; 
    211215</pre></div>  
    212 <p>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p> 
    213  
    214 <p>References <a class="el" href="libEF_8h-source.html#l00839">condition()</a>, <a class="el" href="user__info_8h-source.html#l00248">bdm::UI::get()</a>, and <a class="el" href="libEF_8h-source.html#l00831">set_parameters()</a>.</p> 
     216<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p> 
     217 
     218<p>References <a class="el" href="exp__family_8h_source.html#l00910">condition()</a>, <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>, and <a class="el" href="exp__family_8h_source.html#l00902">set_parameters()</a>.</p> 
    215219 
    216220</div> 
    … …  
    243247<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p> 
    244248 
    245 <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> 
    246  
    247 <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> 
     249<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> 
     250 
     251<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> 
    248252 
    249253</div> 
    … …  
    284288</dl> 
    285289 
    286 <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> 
     290<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> 
    287291 
    288292</div> 
    289293</div><p> 
    290294<hr>The documentation for this class was generated from the following files:<ul> 
    291 <li><a class="el" href="libEF_8h-source.html">libEF.h</a><li>libEF.cpp</ul> 
    292 </div> 
    293 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     295<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a><li>exp_family.cpp</ul> 
     296</div> 
     297<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:57 2009 for mixpp by&nbsp; 
    294298<a href="http://www.doxygen.org/index.html"> 
    295 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     299<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    296300</body> 
    297301</html>