Show
Ignore:
Timestamp:
06/24/09 13:38:47 (15 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_1mratio.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<!-- 
    … …  
    7575<a href="#_details">More...</a> 
    7676<p> 
    77 <code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code> 
     77<code>#include &lt;<a class="el" href="emix_8h_source.html">emix.h</a>&gt;</code> 
    7878<p> 
    7979 
    … …  
    9696 
    9797<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor. <br></td></tr> 
    98 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mratio::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    99 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     98<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">from_setting</a> (const Setting &amp;set)</td></tr> 
     99 
     100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mratio::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     101virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    100102 
    101103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    102 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::mratio::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    103 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> 
    104  
    105 <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> 
    106 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mratio::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> 
     104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mratio::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     105virtual 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> 
    108106 
    109107<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::mratio::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> 
     108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mratio::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    112110 
    113111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    127125 
    128126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr> 
     127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a0d03756f59924fd038980ee60bd904"></a><!-- doxytag: member="bdm::mratio::evallogcond_m" ref="2a0d03756f59924fd038980ee60bd904" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" --> 
     128virtual 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> 
     129 
     130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr> 
    129131<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr> 
    130132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mratio::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" --> 
    … …  
    227229<p> 
    228230Default constructor. By default, the given <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> is not copied! It is assumed that this function will be used only temporarily.  
    229 <p>References <a class="el" href="libBM_8h-source.html#l00120">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00295">bdm::epdf::_rv()</a>, <a class="el" href="emix_8h-source.html#l00042">den</a>, <a class="el" href="emix_8h-source.html#l00044">destroynom</a>, <a class="el" href="libBM_8h-source.html#l00314">bdm::mpdf::dimc</a>, <a class="el" href="emix_8h-source.html#l00046">dl</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, <a class="el" href="libBM_8h-source.html#l00124">bdm::RV::length()</a>, <a class="el" href="libBM_8h-source.html#l00272">bdm::epdf::marginal()</a>, <a class="el" href="emix_8h-source.html#l00040">nom</a>, <a class="el" href="libBM_8h-source.html#l00316">bdm::mpdf::rvc</a>, <a class="el" href="libBM_8h-source.html#l00453">bdm::datalink_m2e::set_connection()</a>, <a class="el" href="libBM_8h-source.html#l00251">bdm::epdf::set_parameters()</a>, <a class="el" href="libBM_8h-source.html#l00291">bdm::epdf::set_rv()</a>, and <a class="el" href="libBM_8cpp-source.html#l00193">bdm::RV::subt()</a>.</p> 
     231<p>References <a class="el" href="bdmbase_8h_source.html#l00311">bdm::epdf::_rv()</a>, <a class="el" href="emix_8h_source.html#l00041">den</a>, <a class="el" href="emix_8h_source.html#l00043">destroynom</a>, <a class="el" href="bdmbase_8h_source.html#l00344">bdm::mpdf::dimc</a>, <a class="el" href="emix_8h_source.html#l00045">dl</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, <a class="el" href="bdmbase_8h_source.html#l00284">bdm::epdf::marginal()</a>, <a class="el" href="emix_8h_source.html#l00039">nom</a>, <a class="el" href="bdmbase_8h_source.html#l00346">bdm::mpdf::rvc</a>, <a class="el" href="bdmbase_8h_source.html#l00512">bdm::datalink_m2e::set_connection()</a>, <a class="el" href="bdmbase_8h_source.html#l00307">bdm::epdf::set_rv()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00193">bdm::RV::subt()</a>.</p> 
    230232 
    231233</div> 
    232234</div><p> 
    233235<hr><h2>Member Function Documentation</h2> 
     236<a class="anchor" name="30a0bceb948e287d497c578e371b1667"></a><!-- doxytag: member="bdm::mratio::from_setting" ref="30a0bceb948e287d497c578e371b1667" args="(const Setting &amp;set)" --> 
     237<div class="memitem"> 
     238<div class="memproto"> 
     239      <table class="memname"> 
     240        <tr> 
     241          <td class="memname">void bdm::mpdf::from_setting           </td> 
     242          <td>(</td> 
     243          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     244          <td class="paramname"> <em>set</em>          </td> 
     245          <td>&nbsp;)&nbsp;</td> 
     246          <td><code> [inline, virtual, inherited]</code></td> 
     247        </tr> 
     248      </table> 
     249</div> 
     250<div class="memdoc"> 
     251 
     252<p> 
     253Load from structure with elements: <div class="fragment"><pre class="fragment"> { rv = {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span> 
     254   <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>, names=(...),}; <span class="comment">// RV describing meaning of random variable in condition</span> 
     255   <span class="comment">// elements of offsprings</span> 
     256 } 
     257</pre></div>  
     258<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
     259 
     260<p>Reimplemented in <a class="el" href="classbdm_1_1mepdf.html#27ef18a3e3b1b5de02739d1324bf25fb">bdm::mepdf</a>, <a class="el" href="classbdm_1_1mprod.html#bfa7478f8df1de6d8cd4c349db512831">bdm::mprod</a>, <a class="el" href="classbdm_1_1mgnorm.html#d717dacc6a9eb967f8410994dc6dc6f9">bdm::mgnorm&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1mgamma.html#da2af0f327e5452bee71d1bf97452ae4">bdm::mgamma</a>, <a class="el" href="classbdm_1_1migamma__ref.html#9e7e0f7d2aa9ecca8ec1af8cbcb5ef1d">bdm::migamma_ref</a>, and <a class="el" href="classbdm_1_1mlognorm.html#49e45ea13a869da607ef9be7a229128a">bdm::mlognorm</a>.</p> 
     261 
     262</div> 
     263</div><p> 
    234264<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mratio::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" --> 
    235265<div class="memitem"> 
    … …  
    259289<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p> 
    260290 
    261 <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> 
    262  
    263 <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> 
     291<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> 
     292 
     293<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> 
    264294 
    265295</div> 
    … …  
    300330</dl> 
    301331 
    302 <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> 
     332<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> 
    303333 
    304334</div> 
    305335</div><p> 
    306336<hr>The documentation for this class was generated from the following file:<ul> 
    307 <li><a class="el" href="emix_8h-source.html">emix.h</a></ul> 
    308 </div> 
    309 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     337<li><a class="el" href="emix_8h_source.html">emix.h</a></ul> 
     338</div> 
     339<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:52 2009 for mixpp by&nbsp; 
    310340<a href="http://www.doxygen.org/index.html"> 
    311 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     341<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    312342</body> 
    313343</html>