root/doc/html/classeuni.html @ 255

Revision 234, 13.3 kB (checked in by smidl, 15 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: euni 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.6 -->
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><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>euni Class Reference</h1><!-- doxytag: class="euni" --><!-- doxytag: inherits="epdf" -->Uniform distributed density on a rectangular support. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for euni:</div>
34<div class="dynsection">
35<p><center><img src="classeuni__inherit__graph.png" border="0" usemap="#euni__inherit__map" alt="Inheritance graph"></center>
36<map name="euni__inherit__map">
37<area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="5,7,51,31"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for euni:</div>
41<div class="dynsection">
42<p><center><img src="classeuni__coll__graph.png" border="0" usemap="#euni__coll__map" alt="Collaboration graph"></center>
43<map name="euni__coll__map">
44<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"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classeuni-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2537a6c239cff52e3ba814851a1116cd"></a><!-- doxytag: member="euni::euni" ref="2537a6c239cff52e3ba814851a1116cd" args="(const RV rv)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#2537a6c239cff52e3ba814851a1116cd">euni</a> (const <a class="el" href="classRV.html">RV</a> <a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defualt constructor. <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2723d4992900b5c5495bfa03628195ed"></a><!-- doxytag: member="euni::eval" ref="2723d4992900b5c5495bfa03628195ed" args="(const vec &amp;val) const " -->
56double&nbsp;</td><td class="memItemRight" valign="bottom"><b>eval</b> (const vec &amp;val) const </td></tr>
57
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="357b36417ef4c9211d12e7a4a602fd6a"></a><!-- doxytag: member="euni::evallog" ref="357b36417ef4c9211d12e7a4a602fd6a" args="(const vec &amp;val) const " -->
59double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#357b36417ef4c9211d12e7a4a602fd6a">evallog</a> (const vec &amp;val) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a0e09392be17beaee120ba98fc038cd"></a><!-- doxytag: member="euni::sample" ref="4a0e09392be17beaee120ba98fc038cd" args="() const " -->
63vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#4a0e09392be17beaee120ba98fc038cd">sample</a> () const </td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fd7c6a05100616ad16ece405cad7bf2"></a><!-- doxytag: member="euni::set_parameters" ref="4fd7c6a05100616ad16ece405cad7bf2" args="(const vec &amp;low0, const vec &amp;high0)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#4fd7c6a05100616ad16ece405cad7bf2">set_parameters</a> (const vec &amp;low0, const vec &amp;high0)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set values of <code>low</code> and <code>high</code> <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8050087e421a9cfd1b4b1f8bd33b1cc1"></a><!-- doxytag: member="euni::mean" ref="8050087e421a9cfd1b4b1f8bd33b1cc1" args="() const " -->
71vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#8050087e421a9cfd1b4b1f8bd33b1cc1">mean</a> () const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15d7d8b2c8f13a0b1535ebc35551f01c"></a><!-- doxytag: member="euni::variance" ref="15d7d8b2c8f13a0b1535ebc35551f01c" args="() const " -->
75vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#15d7d8b2c8f13a0b1535ebc35551f01c">variance</a> () const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76608914c3b19e150292d5c56e93e508"></a><!-- doxytag: member="euni::sample_m" ref="76608914c3b19e150292d5c56e93e508" args="(int N) const " -->
79virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#76608914c3b19e150292d5c56e93e508">sample_m</a> (int N) const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2495a04bbacb9b55fe5a3a59b78affca"></a><!-- doxytag: member="euni::evallog_m" ref="2495a04bbacb9b55fe5a3a59b78affca" args="(const mat &amp;Val) const " -->
83virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#2495a04bbacb9b55fe5a3a59b78affca">evallog_m</a> (const mat &amp;Val) const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e87dc8260a5c37bc1b03eb66174741a0"></a><!-- doxytag: member="euni::condition" ref="e87dc8260a5c37bc1b03eb66174741a0" args="(const RV &amp;rv) const " -->
87virtual <a class="el" href="classmpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#e87dc8260a5c37bc1b03eb66174741a0">condition</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>) const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return conditional density on the given <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>, the remaining rvs will be in conditioning. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38de9f59b65ee06028554f3f74b66025"></a><!-- doxytag: member="euni::marginal" ref="38de9f59b65ee06028554f3f74b66025" args="(const RV &amp;rv) const " -->
91virtual <a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#38de9f59b65ee06028554f3f74b66025">marginal</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>, the remainig rvs are intergrated out. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="euni::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
95const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#ca0d32aabb4cbba347e0c37fe8607562">_rv</a> () const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="euni::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
99void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#7fb94ce90d1ac7077d29f7d6a6c3e0a5">_renewrv</a> (const <a class="el" href="classRV.html">RV</a> &amp;in_rv)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
102<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef42cd8d7645422048d46c46ec5cdac1"></a><!-- doxytag: member="euni::low" ref="ef42cd8d7645422048d46c46ec5cdac1" args="" -->
104vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#ef42cd8d7645422048d46c46ec5cdac1">low</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">lower bound on support <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71b6d6b41aeb61a7f76f682b72119231"></a><!-- doxytag: member="euni::high" ref="71b6d6b41aeb61a7f76f682b72119231" args="" -->
108vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#71b6d6b41aeb61a7f76f682b72119231">high</a></td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upper bound on support <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52a6ff4a54010f88a6a19fca605c64a4"></a><!-- doxytag: member="euni::distance" ref="52a6ff4a54010f88a6a19fca605c64a4" args="" -->
112vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#52a6ff4a54010f88a6a19fca605c64a4">distance</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63105490e946e43372d6187ad1bafdda"></a><!-- doxytag: member="euni::nk" ref="63105490e946e43372d6187ad1bafdda" args="" -->
116double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#63105490e946e43372d6187ad1bafdda">nk</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">normalizing coefficients <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f445a0ce24f39d14c1a4eed53fc8e2c3"></a><!-- doxytag: member="euni::lnk" ref="f445a0ce24f39d14c1a4eed53fc8e2c3" args="" -->
120double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeuni.html#f445a0ce24f39d14c1a4eed53fc8e2c3">lnk</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of log( <code>nk</code> ) <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="euni::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
124<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>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
127</table>
128<hr><a name="_details"></a><h2>Detailed Description</h2>
129Uniform distributed density on a rectangular support. <hr>The documentation for this class was generated from the following file:<ul>
130<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
131</div>
132<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:51:09 2009 for mixpp by&nbsp;
133<a href="http://www.doxygen.org/index.html">
134<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
135</body>
136</html>
Note: See TracBrowser for help on using the browser.