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_1mprod.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 
    … …  
    8686&nbsp;</td><td class="memItemRight" valign="bottom"><b>mprod</b> (Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; mFacs)</td></tr> 
    8787 
    88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77767bd7a943aade7ffb554d91884277"></a><!-- doxytag: member="bdm::mprod::set_elements" ref="77767bd7a943aade7ffb554d91884277" args="(Array&lt; mpdf * &gt; mFacs)" --> 
    89 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_elements</b> (Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; mFacs)</td></tr> 
     88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8535540b53429e373f072ce1995bf79"></a><!-- doxytag: member="bdm::mprod::set_elements" ref="f8535540b53429e373f072ce1995bf79" args="(Array&lt; mpdf * &gt; mFacs, bool own=false)" --> 
     89void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_elements</b> (Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; mFacs, bool own=false)</td></tr> 
    9090 
    9191<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="800f21d94c919137608a2fd5c88719e2"></a><!-- doxytag: member="bdm::mprod::evallogcond" ref="800f21d94c919137608a2fd5c88719e2" args="(const vec &amp;val, const vec &amp;cond)" --> 
    … …  
    9393 
    9494<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. In some cases, this operation can be implemented efficiently. <br></td></tr> 
     95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e27b359d2572abfa4cc7d8f947848dab"></a><!-- doxytag: member="bdm::mprod::evallogcond_m" ref="e27b359d2572abfa4cc7d8f947848dab" args="(const mat &amp;Dt, const vec &amp;cond)" --> 
     96vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mprod.html#e27b359d2572abfa4cc7d8f947848dab">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr> 
     97 
     98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr> 
     99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8cdde6056fe20551be1fa460841f5e2"></a><!-- doxytag: member="bdm::mprod::evallogcond_m" ref="e8cdde6056fe20551be1fa460841f5e2" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" --> 
     100vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mprod.html#e8cdde6056fe20551be1fa460841f5e2">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr> 
     101 
     102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr> 
    95103<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">samplecond</a> (const vec &amp;cond)</td></tr> 
    96104 
    … …  
    99107mat&nbsp;</td><td class="memItemRight" valign="bottom"><b>samplecond</b> (const vec &amp;cond, int N)</td></tr> 
    100108 
    101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ca1b8d18f845b2fe29f4f77969e0596"></a><!-- doxytag: member="bdm::mprod::set_elements" ref="2ca1b8d18f845b2fe29f4f77969e0596" args="(const Array&lt; mpdf * &gt; A0)" --> 
    102 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_elements</b> (const Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; A0)</td></tr> 
     109<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mprod.html#bfa7478f8df1de6d8cd4c349db512831">from_setting</a> (const Setting &amp;set)</td></tr> 
    103110 
    104111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1compositepdf.html#c73d39acc4378eee6a63155c3517d3c9">getrv</a> (bool checkoverlap=false)</td></tr> 
    … …  
    109116 
    110117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">common rvc of all mpdfs is written to rvc <br></td></tr> 
    111 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mprod::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    112 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::mprod::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> 
    113120 
    114121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    115 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::mprod::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    116 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> 
    117  
    118 <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> 
    119 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mprod::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    120 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::mprod::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> 
    121124 
    122125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::mprod::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    124 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mprod::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     127virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    125128 
    126129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    133136 
    134137<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> 
    135 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mprod::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" --> 
    136 virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#0b0ed1ed663071bb7cf4a1349eb94fcb">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr> 
    137  
    138 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr> 
    139138<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr> 
    140139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mprod::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" --> 
    … …  
    183182 
    184183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr> 
     184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd642a575896ca95d46caf2dc607961b"></a><!-- doxytag: member="bdm::mprod::owning_mpdfs" ref="bd642a575896ca95d46caf2dc607961b" args="" --> 
     185bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>owning_mpdfs</b></td></tr> 
     186 
    185187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mprod::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" --> 
    186188int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr> 
    … …  
    200202<p> 
    201203Probability density in the form of Chain-rule decomposition: \[ f(x_1,x_2,x_3) = f(x_1|x_2,x_3)f(x_2,x_3)f(x_3) \] Note that <hr><h2>Member Function Documentation</h2> 
     204<a class="anchor" name="bfa7478f8df1de6d8cd4c349db512831"></a><!-- doxytag: member="bdm::mprod::from_setting" ref="bfa7478f8df1de6d8cd4c349db512831" args="(const Setting &amp;set)" --> 
     205<div class="memitem"> 
     206<div class="memproto"> 
     207      <table class="memname"> 
     208        <tr> 
     209          <td class="memname">void bdm::mprod::from_setting           </td> 
     210          <td>(</td> 
     211          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     212          <td class="paramname"> <em>set</em>          </td> 
     213          <td>&nbsp;)&nbsp;</td> 
     214          <td><code> [inline, virtual]</code></td> 
     215        </tr> 
     216      </table> 
     217</div> 
     218<div class="memdoc"> 
     219 
     220<p> 
     221Load from structure with elements: <div class="fragment"><pre class="fragment"> { <span class="keyword">class</span>=<span class="stringliteral">'mprod'</span>; 
     222   <a class="code" href="classbdm_1_1compositepdf.html#23faf2debc4dde10836393b8c665914a" title="Elements of composition.">mpdfs</a> = (..., ...);     <span class="comment">// list of mpdfs in the order of chain rule</span> 
     223 } 
     224</pre></div>  
     225<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p> 
     226 
     227<p>References <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>.</p> 
     228 
     229</div> 
     230</div><p> 
    202231<a class="anchor" name="c73d39acc4378eee6a63155c3517d3c9"></a><!-- doxytag: member="bdm::mprod::getrv" ref="c73d39acc4378eee6a63155c3517d3c9" args="(bool checkoverlap=false)" --> 
    203232<div class="memitem"> 
    … …  
    225254</dl> 
    226255 
    227 <p>References <a class="el" href="libBM_8cpp-source.html#l00078">bdm::RV::add()</a>, and <a class="el" href="libBM_8h-source.html#l00561">bdm::compositepdf::mpdfs</a>.</p> 
    228  
    229 <p>Referenced by <a class="el" href="merger_8h-source.html#l00079">bdm::merger_base::set_sources()</a>.</p> 
     256<p>References <a class="el" href="bdmbase_8cpp_source.html#l00078">bdm::RV::add()</a>, and <a class="el" href="bdmbase_8h_source.html#l00639">bdm::compositepdf::mpdfs</a>.</p> 
     257 
     258<p>Referenced by <a class="el" href="merger_8h_source.html#l00081">bdm::merger_base::set_sources()</a>.</p> 
    230259 
    231260</div> 
    … …  
    260289<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#f0c1db6fcbb3aae2dd6123884457a367">bdm::mpdf</a>.</p> 
    261290 
    262 <p>References <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="emix_8h-source.html#l00230">dls</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, <a class="el" href="emix_8h-source.html#l00228">epdfs</a>, and <a class="el" href="libBM_8h-source.html#l00561">bdm::compositepdf::mpdfs</a>.</p> 
     291<p>References <a class="el" href="bdmbase_8h_source.html#l00318">bdm::epdf::dimension()</a>, <a class="el" href="emix_8h_source.html#l00229">dls</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, <a class="el" href="emix_8h_source.html#l00227">epdfs</a>, and <a class="el" href="bdmbase_8h_source.html#l00639">bdm::compositepdf::mpdfs</a>.</p> 
    263292 
    264293</div> 
    … …  
    299328</dl> 
    300329 
    301 <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> 
     330<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> 
    302331 
    303332</div> 
    304333</div><p> 
    305334<hr>The documentation for this class was generated from the following file:<ul> 
    306 <li><a class="el" href="emix_8h-source.html">emix.h</a></ul> 
    307 </div> 
    308 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     335<li><a class="el" href="emix_8h_source.html">emix.h</a></ul> 
     336</div> 
     337<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:52 2009 for mixpp by&nbsp; 
    309338<a href="http://www.doxygen.org/index.html"> 
    310 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     339<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    311340</body> 
    312341</html>