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_1eigamma.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 
    … …  
    9898vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_beta</b> ()</td></tr> 
    9999 
     100<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#8a6fd1a1c0190f3e0d95a2a1f99aafc1">from_setting</a> (const Setting &amp;set)</td></tr> 
     101 
     102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3a8d8ae8ba79d0fb35036711fa7d127"></a><!-- doxytag: member="bdm::eigamma::validate" ref="c3a8d8ae8ba79d0fb35036711fa7d127" args="()" --> 
     103void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1egamma.html#c3a8d8ae8ba79d0fb35036711fa7d127">validate</a> ()</td></tr> 
     104 
     105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    100106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="deef7d6273ba4d5a5cf0bbd91ec7277a"></a><!-- doxytag: member="bdm::eigamma::dupdate" ref="deef7d6273ba4d5a5cf0bbd91ec7277a" args="(mat &amp;v)" --> 
    101107virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1eEF.html#deef7d6273ba4d5a5cf0bbd91ec7277a">dupdate</a> (mat &amp;v)</td></tr> 
    … …  
    110116 
    111117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr> 
    112 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::eigamma::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    113 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::eigamma::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     119virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    114120 
    115121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    116 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::eigamma::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    117 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> 
    118  
    119 <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> 
    120 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::eigamma::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    121 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> 
     122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::eigamma::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     123virtual 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> 
    122124 
    123125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    124 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::eigamma::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    125 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
    126  
    127 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    128126<tr><td colspan="2"><div class="groupHeader"></div></td></tr> 
    129127<tr><td colspan="2"><div class="groupText">All constructors are inherited <br><br></div></td></tr> 
    … …  
    166164 
    167165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr> 
     166<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="512dbf057299e871fbc61ed55acb5888"></a><!-- doxytag: member="bdm::eigamma::evallog_m" ref="512dbf057299e871fbc61ed55acb5888" args="(const Array&lt; vec &gt; &amp;Avec) const " --> 
     167virtual 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> 
     168 
     169<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr> 
    168170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e584eac5579c1b6384947ecf66166c77"></a><!-- doxytag: member="bdm::eigamma::condition" ref="e584eac5579c1b6384947ecf66166c77" args="(const RV &amp;rv) const " --> 
    169171virtual <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#e584eac5579c1b6384947ecf66166c77">condition</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>) const </td></tr> 
    … …  
    226228<img class="formulaDsp" alt="\[ x\sim iG(a,b) => 1/x\sim G(a,1/b) \]" src="form_65.png"> 
    227229<p> 
    228  This relation is used in sampling. <hr>The documentation for this class was generated from the following file:<ul> 
    229 <li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul> 
    230 </div> 
    231 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     230 This relation is used in sampling. <hr><h2>Member Function Documentation</h2> 
     231<a class="anchor" name="8a6fd1a1c0190f3e0d95a2a1f99aafc1"></a><!-- doxytag: member="bdm::eigamma::from_setting" ref="8a6fd1a1c0190f3e0d95a2a1f99aafc1" args="(const Setting &amp;set)" --> 
     232<div class="memitem"> 
     233<div class="memproto"> 
     234      <table class="memname"> 
     235        <tr> 
     236          <td class="memname">void bdm::egamma::from_setting           </td> 
     237          <td>(</td> 
     238          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     239          <td class="paramname"> <em>set</em>          </td> 
     240          <td>&nbsp;)&nbsp;</td> 
     241          <td><code> [inline, virtual, inherited]</code></td> 
     242        </tr> 
     243      </table> 
     244</div> 
     245<div class="memdoc"> 
     246 
     247<p> 
     248Load from structure with elements: <div class="fragment"><pre class="fragment"> { <a class="code" href="classbdm_1_1egamma.html#0901ec983e66b8337aaa506e13b122fa" title="Vector .">alpha</a> = [...];         <span class="comment">// vector of alpha</span> 
     249   <a class="code" href="classbdm_1_1egamma.html#457bfb1ccb2057df85073e519a15ccc1" title="Vector .">beta</a> = [...];          <span class="comment">// vector of beta</span> 
     250   <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>,...}  <span class="comment">// description</span> 
     251 } 
     252</pre></div>  
     253<p>Reimplemented from <a class="el" href="classbdm_1_1epdf.html#fa9efc98a065b31c630fe18cc418f725">bdm::epdf</a>.</p> 
     254 
     255<p>References <a class="el" href="exp__family_8h_source.html#l00370">bdm::egamma::alpha</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#l00406">bdm::egamma::validate()</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:54 2009 for mixpp by&nbsp; 
    232263<a href="http://www.doxygen.org/index.html"> 
    233 <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> 
    234265</body> 
    235266</html>