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_1emix.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="emix_8h-source.html">emix.h</a>&gt;</code> 
     74<code>#include &lt;<a class="el" href="emix_8h_source.html">emix.h</a>&gt;</code> 
    7575<p> 
    7676 
    … …  
    133133 
    134134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr> 
    135 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::emix::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    136 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     135<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#fa9efc98a065b31c630fe18cc418f725">from_setting</a> (const Setting &amp;set)</td></tr> 
     136 
     137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::emix::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     138virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    137139 
    138140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::emix::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    140 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> 
    141  
    142 <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> 
    143 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::emix::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    144 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> 
     141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::emix::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     142virtual 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> 
    145143 
    146144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    147 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::emix::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    148 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::emix::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     146virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    149147 
    150148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    167165 
    168166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_47.png"> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_48.png">. <br></td></tr> 
     167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="512dbf057299e871fbc61ed55acb5888"></a><!-- doxytag: member="bdm::emix::evallog_m" ref="512dbf057299e871fbc61ed55acb5888" args="(const Array&lt; vec &gt; &amp;Avec) const " --> 
     168virtual 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> 
     169 
     170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr> 
    169171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::emix::qbounds" ref="0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " --> 
    170172virtual 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> 
    … …  
    215217<p> 
    216218 where <img class="formulaInl" alt="$f_i(x)$" src="form_38.png"> is any density on random variable <img class="formulaInl" alt="$x$" src="form_28.png">, called <em>component</em>, <hr><h2>Member Function Documentation</h2> 
     219<a class="anchor" name="fa9efc98a065b31c630fe18cc418f725"></a><!-- doxytag: member="bdm::emix::from_setting" ref="fa9efc98a065b31c630fe18cc418f725" args="(const Setting &amp;set)" --> 
     220<div class="memitem"> 
     221<div class="memproto"> 
     222      <table class="memname"> 
     223        <tr> 
     224          <td class="memname">void bdm::epdf::from_setting           </td> 
     225          <td>(</td> 
     226          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     227          <td class="paramname"> <em>set</em>          </td> 
     228          <td>&nbsp;)&nbsp;</td> 
     229          <td><code> [inline, virtual, inherited]</code></td> 
     230        </tr> 
     231      </table> 
     232</div> 
     233<div class="memdoc"> 
     234 
     235<p> 
     236Load 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> 
     237   <span class="comment">// elements of offsprings</span> 
     238 } 
     239</pre></div>  
     240<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
     241 
     242<p>Reimplemented in <a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">bdm::enorm&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1egiw.html#55b76ec75bd2df5ef9cab3be20a33bbb">bdm::egiw</a>, <a class="el" href="classbdm_1_1egamma.html#8a6fd1a1c0190f3e0d95a2a1f99aafc1">bdm::egamma</a>, <a class="el" href="classbdm_1_1euni.html#77f5fef1f006fe056066da23b9e5f042">bdm::euni</a>, <a class="el" href="classbdm_1_1merger__base.html#10dd390fc6f0d1733bb07cb51977160c">bdm::merger_base</a>, <a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">bdm::enorm&lt; ldmat &gt;</a>, <a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">bdm::enorm&lt; chmat &gt;</a>, and <a class="el" href="classbdm_1_1enorm.html#61bd470764020bea6e1ed35000f259e6">bdm::enorm&lt; fsqmat &gt;</a>.</p> 
     243 
     244<p>References <a class="el" href="bdmbase_8h_source.html#l00307">bdm::epdf::set_rv()</a>.</p> 
     245 
     246</div> 
     247</div><p> 
    217248<a class="anchor" name="3a107a6b808a081389ef17af951c234a"></a><!-- doxytag: member="bdm::emix::set_parameters" ref="3a107a6b808a081389ef17af951c234a" args="(const vec &amp;w, const Array&lt; epdf * &gt; &amp;Coms, bool copy=false)" --> 
    218249<div class="memitem"> 
    … …  
    248279<p> 
    249280Set weights <code>w</code> and components <code>Coms</code> By default Coms are copied inside. Parameter <code>copy</code> can be set to false if Coms live externally. Use method <a class="el" href="classbdm_1_1emix.html#965fb16669250a3d28bc62cf76276d8e" title="Auxiliary function for taking ownership of the Coms().">ownComs()</a> if Coms should be destroyed by the destructor.  
    250 <p>References <a class="el" href="emix_8h-source.html#l00096">Coms</a>, <a class="el" href="emix_8h-source.html#l00098">destroyComs</a>, <a class="el" href="libBM_8h-source.html#l00232">bdm::epdf::dim</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, and <a class="el" href="emix_8h-source.html#l00094">w</a>.</p> 
    251  
    252 <p>Referenced by <a class="el" href="mixef_8cpp-source.html#l00138">bdm::MixEF::epredictor()</a>, <a class="el" href="emix_8cpp-source.html#l00103">bdm::egiwmix::marginal()</a>, <a class="el" href="emix_8cpp-source.html#l00037">marginal()</a>, and <a class="el" href="emix_8h-source.html#l00393">bdm::mmix::set_parameters()</a>.</p> 
     281<p>References <a class="el" href="emix_8h_source.html#l00095">Coms</a>, <a class="el" href="emix_8h_source.html#l00097">destroyComs</a>, <a class="el" href="bdmbase_8h_source.html#l00237">bdm::epdf::dim</a>, <a class="el" href="bdmbase_8h_source.html#l00318">bdm::epdf::dimension()</a>, and <a class="el" href="emix_8h_source.html#l00093">w</a>.</p> 
     282 
     283<p>Referenced by <a class="el" href="mixtures_8cpp_source.html#l00138">bdm::MixEF::epredictor()</a>, <a class="el" href="emix_8cpp_source.html#l00103">bdm::egiwmix::marginal()</a>, <a class="el" href="emix_8cpp_source.html#l00037">marginal()</a>, and <a class="el" href="emix_8h_source.html#l00425">bdm::mmix::set_parameters()</a>.</p> 
    253284 
    254285</div> 
    255286</div><p> 
    256287<hr>The documentation for this class was generated from the following files:<ul> 
    257 <li><a class="el" href="emix_8h-source.html">emix.h</a><li>emix.cpp</ul> 
    258 </div> 
    259 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     288<li><a class="el" href="emix_8h_source.html">emix.h</a><li>emix.cpp</ul> 
     289</div> 
     290<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:52 2009 for mixpp by&nbsp; 
    260291<a href="http://www.doxygen.org/index.html"> 
    261 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     292<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    262293</body> 
    263294</html>