root/doc/html/classegiw.html @ 99

Revision 99, 12.0 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: egiw Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.5 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>egiw Class Reference</h1><!-- doxytag: class="egiw" --><!-- doxytag: inherits="eEF" -->Gauss-inverse-Wishart density stored in LD form. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for egiw:</div>
33<div class="dynsection">
34<p><center><img src="classegiw__inherit__graph.png" border="0" usemap="#egiw__inherit__map" alt="Inheritance graph"></center>
35<map name="egiw__inherit__map">
36<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="7,82,52,106"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="7,7,52,31"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for egiw:</div>
40<div class="dynsection">
41<p><center><img src="classegiw__coll__graph.png" border="0" usemap="#egiw__coll__map" alt="Collaboration graph"></center>
42<map name="egiw__coll__map">
43<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="7,172,52,196"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="5,95,51,119"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="9,7,47,31"><area shape="rect" href="classldmat.html" title="Matrix stored in LD form, (typically known as UD)." alt="" coords="76,172,129,196"><area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="75,95,131,119"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classegiw-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<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="c52a2173c6eb1490edce9c6c7c05d60b"></a><!-- doxytag: member="egiw::egiw" ref="c52a2173c6eb1490edce9c6c7c05d60b" args="(RV rv, mat V0, double nu0)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#c52a2173c6eb1490edce9c6c7c05d60b">egiw</a> (<a class="el" href="classRV.html">RV</a> <a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>, mat V0, double nu0)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#3d2c1f2ba0f9966781f1e0ae695e8a6f">sample</a> () const </td></tr>
55
56<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="#3d2c1f2ba0f9966781f1e0ae695e8a6f"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6deb0ff2859f41ef7cbdf6a842cabb29"></a><!-- doxytag: member="egiw::mean" ref="6deb0ff2859f41ef7cbdf6a842cabb29" args="() const " -->
58vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#6deb0ff2859f41ef7cbdf6a842cabb29">mean</a> () const </td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="425cbc53b377274e28c6add942bab62d"></a><!-- doxytag: member="egiw::evalpdflog" ref="425cbc53b377274e28c6add942bab62d" args="(const vec &amp;val) const " -->
62double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#425cbc53b377274e28c6add942bab62d">evalpdflog</a> (const vec &amp;val) const </td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70eb1a0b88459b227f919b425b0d3359"></a><!-- doxytag: member="egiw::lognc" ref="70eb1a0b88459b227f919b425b0d3359" args="() const " -->
66double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#70eb1a0b88459b227f919b425b0d3359">lognc</a> () const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_60.png"> <br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="533e792e1175bfa06d5d595dc5d080d5"></a><!-- doxytag: member="egiw::_V" ref="533e792e1175bfa06d5d595dc5d080d5" args="()" -->
70<a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#533e792e1175bfa06d5d595dc5d080d5">_V</a> ()</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a pointer to the internal statistics. Use with Care! <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08029c481ff95d24f093df0573879afe"></a><!-- doxytag: member="egiw::_nu" ref="08029c481ff95d24f093df0573879afe" args="()" -->
74double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#08029c481ff95d24f093df0573879afe">_nu</a> ()</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a pointer to the internal statistics. Use with Care! <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd88bc35550ec8fe9281d358216d0fcf"></a><!-- doxytag: member="egiw::tupdate" ref="fd88bc35550ec8fe9281d358216d0fcf" args="(double phi, mat &amp;vbar, double nubar)" -->
78virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#fd88bc35550ec8fe9281d358216d0fcf">tupdate</a> (double phi, mat &amp;vbar, double nubar)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5863718c3b2fb1496dece10c5b745d5c"></a><!-- doxytag: member="egiw::dupdate" ref="5863718c3b2fb1496dece10c5b745d5c" args="(mat &amp;v, double nu=1.0)" -->
82virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#5863718c3b2fb1496dece10c5b745d5c">dupdate</a> (mat &amp;v, double <a class="el" href="classegiw.html#4a2f130b91afe84f6d62fed289d5d453">nu</a>=1.0)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ea597362e11a0040fe7c990269d072c"></a><!-- doxytag: member="egiw::eval" ref="3ea597362e11a0040fe7c990269d072c" args="(const vec &amp;val) const " -->
86virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ea597362e11a0040fe7c990269d072c">eval</a> (const vec &amp;val) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b89143f12c9b49282e30841e4fb5f337"></a><!-- doxytag: member="egiw::_rv" ref="b89143f12c9b49282e30841e4fb5f337" args="() const " -->
90<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#b89143f12c9b49282e30841e4fb5f337">_rv</a> () const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
93<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f343d03ede89db820edf44a6297fa442"></a><!-- doxytag: member="egiw::V" ref="f343d03ede89db820edf44a6297fa442" args="" -->
95<a class="el" href="classldmat.html">ldmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#f343d03ede89db820edf44a6297fa442">V</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extended information matrix of sufficient statistics. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a2f130b91afe84f6d62fed289d5d453"></a><!-- doxytag: member="egiw::nu" ref="4a2f130b91afe84f6d62fed289d5d453" args="" -->
99double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegiw.html#4a2f130b91afe84f6d62fed289d5d453">nu</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of data records (degrees of freedom) of sufficient statistics. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="egiw::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
103<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
106</table>
107<hr><a name="_details"></a><h2>Detailed Description</h2>
108Gauss-inverse-Wishart density stored in LD form.
109<p>
110More?... <hr><h2>Member Function Documentation</h2>
111<a class="anchor" name="3d2c1f2ba0f9966781f1e0ae695e8a6f"></a><!-- doxytag: member="egiw::sample" ref="3d2c1f2ba0f9966781f1e0ae695e8a6f" args="() const " -->
112<div class="memitem">
113<div class="memproto">
114      <table class="memname">
115        <tr>
116          <td class="memname">vec egiw::sample           </td>
117          <td>(</td>
118          <td class="paramname">          </td>
119          <td>&nbsp;)&nbsp;</td>
120          <td width="100%"> const<code> [virtual]</code></td>
121        </tr>
122      </table>
123</div>
124<div class="memdoc">
125
126<p>
127Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
128<p>
129Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png"> 
130<p>Implements <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf</a>.</p>
131
132</div>
133</div><p>
134<hr>The documentation for this class was generated from the following files:<ul>
135<li>work/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a><li>work/mixpp/bdm/stat/libEF.cpp</ul>
136</div>
137<hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 16:15:25 2008 for mixpp by&nbsp;
138<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>
140</body>
141</html>
Note: See TracBrowser for help on using the browser.