Show
Ignore:
Timestamp:
08/18/08 14:27:50 (16 years ago)
Author:
smidl
Message:

Documentation update

Files:
1 copied

Legend:

Unmodified
Added
Removed

  • doc/html/classmmix.html

    r106 r139  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
    3 <title>mixpp: mEF Class Reference</title> 
     3<title>mixpp: mmix Class Reference</title> 
    44<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    55<link href="tabs.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.5 --> 
     7<!-- Generated by Doxygen 1.5.6 --> 
    88<div class="navigation" id="top"> 
    99  <div class="tabs"> 
    … …  
    2424</div> 
    2525<div class="contents"> 
    26 <h1>mEF Class Reference</h1><!-- doxytag: class="mEF" --><!-- doxytag: inherits="mpdf" -->Exponential family model.   
     26<h1>mmix Class Reference</h1><!-- doxytag: class="mmix" --><!-- doxytag: inherits="mpdf" -->Mixture of mpdfs with constant weights.   
    2727<a href="#_details">More...</a> 
    2828<p> 
    29 <code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code> 
     29<code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code> 
    3030<p> 
    3131<div class="dynheader"> 
    32 Inheritance diagram for mEF:</div> 
     32Inheritance diagram for mmix:</div> 
    3333<div class="dynsection"> 
    34 <p><center><img src="classmEF__inherit__graph.png" border="0" usemap="#mEF__inherit__map" alt="Inheritance graph"></center> 
    35 <map name="mEF__inherit__map"> 
    36 <area shape="rect" href="classmgamma.html" title="Gamma random walk." alt="" coords="16,156,91,180"><area shape="rect" href="classmlnorm.html" title="Normal distributed linear function with linear function of mean value;." alt="" coords="115,156,232,180"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="88,6,139,30"><area shape="rect" href="classmgamma__fix.html" title="Gamma random walk around a fixed point." alt="" coords="5,230,101,254"></map> 
     34<p><center><img src="classmmix__inherit__graph.png" border="0" usemap="#mmix__inherit__map" alt="Inheritance graph"></center> 
     35<map name="mmix__inherit__map"> 
     36<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="7,7,60,33"></map> 
    3737<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    3838<div class="dynheader"> 
    39 Collaboration diagram for mEF:</div> 
     39Collaboration diagram for mmix:</div> 
    4040<div class="dynsection"> 
    41 <p><center><img src="classmEF__coll__graph.png" border="0" usemap="#mEF__coll__map" alt="Collaboration graph"></center> 
    42 <map name="mEF__coll__map"> 
    43 <area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,185,56,209"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="17,6,55,30"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="51,96,96,120"></map> 
     41<p><center><img src="classmmix__coll__graph.png" border="0" usemap="#mmix__coll__map" alt="Collaboration graph"></center> 
     42<map name="mmix__coll__map"> 
     43<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,204,59,231"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="36,7,73,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="71,105,119,132"><area shape="rect" href="classemix.html" title="Mixture of epdfs." alt="" coords="83,204,133,231"></map> 
    4444<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    4545 
    4646<p> 
    47 <a href="classmEF-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
     47<a href="classmmix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    4848<tr><td></td></tr> 
    4949<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    50 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bf51fe8654d7b83c8c8afeb19409d4f"></a><!-- doxytag: member="mEF::mEF" ref="8bf51fe8654d7b83c8c8afeb19409d4f" args="(const RV &amp;rv0, const RV &amp;rvc0)" --> 
    51 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmEF.html#8bf51fe8654d7b83c8c8afeb19409d4f">mEF</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv0, const <a class="el" href="classRV.html">RV</a> &amp;rvc0)</td></tr> 
     50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6769a962f1f4d0ecc5b903b5f7d26ad3"></a><!-- doxytag: member="mmix::mmix" ref="6769a962f1f4d0ecc5b903b5f7d26ad3" args="(RV &amp;rv, RV &amp;rvc)" --> 
     51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#6769a962f1f4d0ecc5b903b5f7d26ad3">mmix</a> (<a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a>, <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a>)</td></tr> 
    5252 
    5353<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr> 
     54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7681490a5c5b2d0a43f4e5842e10a9d"></a><!-- doxytag: member="mmix::set_parameters" ref="e7681490a5c5b2d0a43f4e5842e10a9d" args="(const vec &amp;w, const Array&lt; mpdf * &gt; &amp;Coms)" --> 
     55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#e7681490a5c5b2d0a43f4e5842e10a9d">set_parameters</a> (const vec &amp;w, const Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; &amp;<a class="el" href="classmmix.html#460632c7a0afd41b7840902181a7d85f">Coms</a>)</td></tr> 
     56 
     57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set weights <code>w</code> and components <code>R</code>. <br></td></tr> 
     58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a66629ec5c2b6f4740606cf737f0193"></a><!-- doxytag: member="mmix::condition" ref="1a66629ec5c2b6f4740606cf737f0193" args="(const vec &amp;cond)" --> 
     59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#1a66629ec5c2b6f4740606cf737f0193">condition</a> (const vec &amp;cond)</td></tr> 
     60 
     61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr> 
    5462<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#b0193a350c97933ddf15b15a130da352">samplecond</a> (vec &amp;cond, double &amp;ll)</td></tr> 
    5563 
    5664<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.  <a href="#b0193a350c97933ddf15b15a130da352"></a><br></td></tr> 
    57 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f95a0cc6ab40611f46804682446ed83"></a><!-- doxytag: member="mEF::condition" ref="0f95a0cc6ab40611f46804682446ed83" args="(const vec &amp;cond)" --> 
    58 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">condition</a> (const vec &amp;cond)</td></tr> 
    59  
    60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr> 
    61 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80b738ece5bd4f8c4edaee4b38906f91"></a><!-- doxytag: member="mEF::evalcond" ref="80b738ece5bd4f8c4edaee4b38906f91" args="(const vec &amp;dt, const vec &amp;cond)" --> 
     65<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#6bf806badfdac606c847e458e8fce18c">samplecond</a> (vec &amp;cond, vec &amp;ll, int N)</td></tr> 
     66 
     67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.  <a href="#6bf806badfdac606c847e458e8fce18c"></a><br></td></tr> 
     68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80b738ece5bd4f8c4edaee4b38906f91"></a><!-- doxytag: member="mmix::evalcond" ref="80b738ece5bd4f8c4edaee4b38906f91" args="(const vec &amp;dt, const vec &amp;cond)" --> 
    6269virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#80b738ece5bd4f8c4edaee4b38906f91">evalcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr> 
    6370 
    6471<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classepdf.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> 
    65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec9c850305984582548e8deb64f0ffe8"></a><!-- doxytag: member="mEF::_rvc" ref="ec9c850305984582548e8deb64f0ffe8" args="()" --> 
     72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec9c850305984582548e8deb64f0ffe8"></a><!-- doxytag: member="mmix::_rvc" ref="ec9c850305984582548e8deb64f0ffe8" args="()" --> 
    6673<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#ec9c850305984582548e8deb64f0ffe8">_rvc</a> ()</td></tr> 
    6774 
    6875<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    69 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mEF::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" --> 
     76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mmix::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" --> 
    7077<a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#e17780ee5b2cfe05922a6c56af1462f8">_epdf</a> ()</td></tr> 
    7178 
    7279<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    7380<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mEF::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" --> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460632c7a0afd41b7840902181a7d85f"></a><!-- doxytag: member="mmix::Coms" ref="460632c7a0afd41b7840902181a7d85f" args="" --> 
     82Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#460632c7a0afd41b7840902181a7d85f">Coms</a></td></tr> 
     83 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component (epdfs). <br></td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="507a5e6df53e6e9a6a330f1271cf0914"></a><!-- doxytag: member="mmix::Epdf" ref="507a5e6df53e6e9a6a330f1271cf0914" args="" --> 
     86<a class="el" href="classemix.html">emix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmmix.html#507a5e6df53e6e9a6a330f1271cf0914">Epdf</a></td></tr> 
     87 
     88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. <br></td></tr> 
     89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mmix::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" --> 
    7590<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a></td></tr> 
    7691 
    7792<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr> 
    78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mEF::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" --> 
     93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mmix::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" --> 
    7994<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a></td></tr> 
    8095 
    8196<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr> 
    82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mEF::ep" ref="7aa894208a32f3487827df6d5054424c" args="" --> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mmix::ep" ref="7aa894208a32f3487827df6d5054424c" args="" --> 
    8398<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#7aa894208a32f3487827df6d5054424c">ep</a></td></tr> 
    8499 
    … …  
    86101</table> 
    87102<hr><a name="_details"></a><h2>Detailed Description</h2> 
    88 Exponential family model.  
    89 <p> 
    90 More?... <hr><h2>Member Function Documentation</h2> 
    91 <a class="anchor" name="b0193a350c97933ddf15b15a130da352"></a><!-- doxytag: member="mEF::samplecond" ref="b0193a350c97933ddf15b15a130da352" args="(vec &amp;cond, double &amp;ll)" --> 
     103Mixture of mpdfs with constant weights.  
     104<p> 
     105<hr><h2>Member Function Documentation</h2> 
     106<a class="anchor" name="b0193a350c97933ddf15b15a130da352"></a><!-- doxytag: member="mmix::samplecond" ref="b0193a350c97933ddf15b15a130da352" args="(vec &amp;cond, double &amp;ll)" --> 
    92107<div class="memitem"> 
    93108<div class="memproto"> 
    … …  
    108123          <td></td> 
    109124          <td>)</td> 
    110           <td></td><td></td><td width="100%"><code> [inline, virtual, inherited]</code></td> 
     125          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td> 
    111126        </tr> 
    112127      </table> 
    … …  
    126141<p>Reimplemented in <a class="el" href="classmlnorm.html#decf3e3b5c8e0812e5b4dbe94fa2ae18">mlnorm&lt; sq_T &gt;</a>, and <a class="el" href="classmgamma.html#9f40dc43885085fad8e3d6652b79e139">mgamma</a>.</p> 
    127142 
    128 <p>References <a class="el" href="libBM_8h-source.html#l00171">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00163">mpdf::ep</a>, <a class="el" href="classepdf.html#6aef3eca74899692503769c18add1a4c">epdf::evalpdflog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p> 
     143<p>References <a class="el" href="libBM_8h-source.html#l00180">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00163">mpdf::ep</a>, <a class="el" href="classepdf.html#6aef3eca74899692503769c18add1a4c">epdf::evalpdflog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p> 
    129144 
    130145<p>Referenced by <a class="el" href="libPF_8h-source.html#l00137">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p> 
     146 
     147</div> 
     148</div><p> 
     149<a class="anchor" name="6bf806badfdac606c847e458e8fce18c"></a><!-- doxytag: member="mmix::samplecond" ref="6bf806badfdac606c847e458e8fce18c" args="(vec &amp;cond, vec &amp;ll, int N)" --> 
     150<div class="memitem"> 
     151<div class="memproto"> 
     152      <table class="memname"> 
     153        <tr> 
     154          <td class="memname">virtual mat mpdf::samplecond           </td> 
     155          <td>(</td> 
     156          <td class="paramtype">vec &amp;&nbsp;</td> 
     157          <td class="paramname"> <em>cond</em>, </td> 
     158        </tr> 
     159        <tr> 
     160          <td class="paramkey"></td> 
     161          <td></td> 
     162          <td class="paramtype">vec &amp;&nbsp;</td> 
     163          <td class="paramname"> <em>ll</em>, </td> 
     164        </tr> 
     165        <tr> 
     166          <td class="paramkey"></td> 
     167          <td></td> 
     168          <td class="paramtype">int&nbsp;</td> 
     169          <td class="paramname"> <em>N</em></td><td>&nbsp;</td> 
     170        </tr> 
     171        <tr> 
     172          <td></td> 
     173          <td>)</td> 
     174          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td> 
     175        </tr> 
     176      </table> 
     177</div> 
     178<div class="memdoc"> 
     179 
     180<p> 
     181Returns N samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.  
     182<p> 
     183<dl compact><dt><b>Parameters:</b></dt><dd> 
     184  <table border="0" cellspacing="2" cellpadding="0"> 
     185    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr> 
     186    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr> 
     187  </table> 
     188</dl> 
     189 
     190<p>Reimplemented in <a class="el" href="classmlnorm.html#215fb88cc8b95d64cdefd6849abdd1e8">mlnorm&lt; sq_T &gt;</a>, and <a class="el" href="classmgamma.html#e9d52749793f40aad85b70c6db4435ae">mgamma</a>.</p> 
     191 
     192<p>References <a class="el" href="libBM_8h-source.html#l00180">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00057">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00163">mpdf::ep</a>, <a class="el" href="classepdf.html#6aef3eca74899692503769c18add1a4c">epdf::evalpdflog()</a>, <a class="el" href="libBM_8h-source.html#l00159">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p> 
    131193 
    132194</div> 
    133195</div><p> 
    134196<hr>The documentation for this class was generated from the following file:<ul> 
    135 <li>work/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a></ul> 
    136 </div> 
    137 <hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 23:06:43 2008 for mixpp by&nbsp; 
     197<li>work/mixpp/bdm/stat/<a class="el" href="emix_8h-source.html">emix.h</a></ul> 
     198</div> 
     199<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 16 11:58:55 2008 for mixpp by&nbsp; 
    138200<a href="http://www.doxygen.org/index.html"> 
    139 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 
     201<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 
    140202</body> 
    141203</html>