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_1elognorm.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<!-- 
    … …  
    6969</div> 
    7070<div class="contents"> 
    71 <h1>bdm::elognorm Class Reference</h1><!-- doxytag: class="bdm::elognorm" --><!-- doxytag: inherits="enorm&lt; ldmat &gt;" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code> 
     71<h1>bdm::elognorm Class Reference</h1><!-- doxytag: class="bdm::elognorm" --><!-- doxytag: inherits="enorm&lt; ldmat &gt;" --><code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code> 
    7272<p> 
    7373 
    … …  
    100100 
    101101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr> 
    102 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::elognorm::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    103 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::elognorm::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     103virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    104104 
    105105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    106 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::elognorm::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    107 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> 
     106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::elognorm::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     107virtual 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> 
    108108 
    109109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    110 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::elognorm::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    111 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
    112  
    113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    114110<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    115111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8322f2c11560871dd922c660f4771bb"></a><!-- doxytag: member="bdm::elognorm::set_parameters" ref="b8322f2c11560871dd922c660f4771bb" args="(const vec &amp;mu, const ldmat &amp;R)" --> 
    116112void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (const vec &amp;<a class="el" href="classbdm_1_1enorm.html#c702a194720853570d08b65482f842c7">mu</a>, const <a class="el" href="classldmat.html">ldmat</a> &amp;<a class="el" href="classbdm_1_1enorm.html#2d92dde696b2a7a5b10ddef5d22ba2c2">R</a>)</td></tr> 
    117113 
    118 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61bd470764020bea6e1ed35000f259e6"></a><!-- doxytag: member="bdm::elognorm::from_setting" ref="61bd470764020bea6e1ed35000f259e6" args="(const Setting &amp;root)" --> 
    119 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">from_setting</a> (const Setting &amp;root)</td></tr> 
    120  
    121 <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> 
     114<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">from_setting</a> (const Setting &amp;<a class="el" href="classbdm_1_1root.html">root</a>)</td></tr> 
     115 
     116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38eb17ecb75d94a50b6782fcf735cfea"></a><!-- doxytag: member="bdm::elognorm::validate" ref="38eb17ecb75d94a50b6782fcf735cfea" args="()" --> 
     117void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1enorm.html#38eb17ecb75d94a50b6782fcf735cfea">validate</a> ()</td></tr> 
     118 
     119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    122120<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    123121<tr><td colspan="2"><div class="groupText">Construction of each <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> should support two types of constructors: <ul> 
    … …  
    183181 
    184182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr> 
     183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="512dbf057299e871fbc61ed55acb5888"></a><!-- doxytag: member="bdm::elognorm::evallog_m" ref="512dbf057299e871fbc61ed55acb5888" args="(const Array&lt; vec &gt; &amp;Avec) const " --> 
     184virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#512dbf057299e871fbc61ed55acb5888">evallog_m</a> (const Array&lt; vec &gt; &amp;Avec) const </td></tr> 
     185 
     186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr> 
    185187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::elognorm::qbounds" ref="0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " --> 
    186188virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#0a7705e80601957f7226d333a0a6d539">qbounds</a> (vec &amp;lb, vec &amp;ub, double percentage=0.95) const </td></tr> 
    … …  
    229231<img class="formulaDsp" alt="\[ x \sim \frac{1}{x\sigma\sqrt{2\pi}}\exp{-\frac{1}{2\sigma^2}(\log(x)-\mu)} \]" src="form_132.png"> 
    230232<p> 
    231  <hr>The documentation for this class was generated from the following file:<ul> 
    232 <li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul> 
    233 </div> 
    234 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     233 <hr><h2>Member Function Documentation</h2> 
     234<a class="anchor" name="61bd470764020bea6e1ed35000f259e6"></a><!-- doxytag: member="bdm::elognorm::from_setting" ref="61bd470764020bea6e1ed35000f259e6" args="(const Setting &amp;root)" --> 
     235<div class="memitem"> 
     236<div class="memproto"> 
     237      <table class="memname"> 
     238        <tr> 
     239          <td class="memname">void <a class="el" href="classbdm_1_1enorm.html">bdm::enorm</a>&lt; <a class="el" href="classldmat.html">ldmat</a>  &gt;::from_setting           </td> 
     240          <td>(</td> 
     241          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     242          <td class="paramname"> <em>set</em>          </td> 
     243          <td>&nbsp;)&nbsp;</td> 
     244          <td><code> [virtual, inherited]</code></td> 
     245        </tr> 
     246      </table> 
     247</div> 
     248<div class="memdoc"> 
     249 
     250<p> 
     251Load from structure with elements: <div class="fragment"><pre class="fragment"> { <a class="code" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8" title="Description of the random variable.">rv</a> = {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
     252   <span class="comment">// elements of offsprings</span> 
     253 } 
     254</pre></div>  
     255<p>Reimplemented from <a class="el" href="classbdm_1_1epdf.html#fa9efc98a065b31c630fe18cc418f725">bdm::epdf</a>.</p> 
     256 
     257</div> 
     258</div><p> 
     259<hr>The documentation for this class was generated from the following file:<ul> 
     260<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></ul> 
     261</div> 
     262<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:57 2009 for mixpp by&nbsp; 
    235263<a href="http://www.doxygen.org/index.html"> 
    236 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     264<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    237265</body> 
    238266</html>