root/doc/html/classbdm_1_1euni.html @ 270

Revision 270, 15.2 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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: bdm::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><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1euni.html">euni</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::euni Class Reference</h1><!-- doxytag: class="bdm::euni" --><!-- doxytag: inherits="bdm::epdf" --><code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::euni:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1euni__inherit__graph.png" border="0" usemap="#bdm_1_1euni__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1euni__inherit__map">
38<area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="19,84,104,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
42<a href="classbdm_1_1euni-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Uniform distributed density on a rectangular support. <table border="0" cellpadding="0" cellspacing="0">
44<tr><td></td></tr>
45<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8887b088e3ab0b01e96b88237d707b97"></a><!-- doxytag: member="bdm::euni::euni" ref="8887b088e3ab0b01e96b88237d707b97" args="()" -->
47&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#8887b088e3ab0b01e96b88237d707b97">euni</a> ()</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defualt constructor. <br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c282673b9d33928001e945443f636a1d"></a><!-- doxytag: member="bdm::euni::eval" ref="c282673b9d33928001e945443f636a1d" args="(const vec &amp;val) const " -->
51double&nbsp;</td><td class="memItemRight" valign="bottom"><b>eval</b> (const vec &amp;val) const </td></tr>
52
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="caa07b8307bd793d5339d6583e0aba81"></a><!-- doxytag: member="bdm::euni::evallog" ref="caa07b8307bd793d5339d6583e0aba81" args="(const vec &amp;val) const " -->
54double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#caa07b8307bd793d5339d6583e0aba81">evallog</a> (const vec &amp;val) const </td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc5df80359ead2918384b2004ce67194"></a><!-- doxytag: member="bdm::euni::sample" ref="fc5df80359ead2918384b2004ce67194" args="() const " -->
58vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#fc5df80359ead2918384b2004ce67194">sample</a> () const </td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_106.png"> from density <img class="formulaInl" alt="$ f_x()$" src="form_107.png">. <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e130b323c62b42f1699537f99af6f09"></a><!-- doxytag: member="bdm::euni::set_parameters" ref="8e130b323c62b42f1699537f99af6f09" args="(const vec &amp;low0, const vec &amp;high0)" -->
62void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#8e130b323c62b42f1699537f99af6f09">set_parameters</a> (const vec &amp;low0, const vec &amp;high0)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set values of <code>low</code> and <code>high</code> <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46caa8c13aba2e6228f964208918b226"></a><!-- doxytag: member="bdm::euni::mean" ref="46caa8c13aba2e6228f964208918b226" args="() const " -->
66vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#46caa8c13aba2e6228f964208918b226">mean</a> () const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="951f932155111f6053c980f672b4c22c"></a><!-- doxytag: member="bdm::euni::variance" ref="951f932155111f6053c980f672b4c22c" args="() const " -->
70vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#951f932155111f6053c980f672b4c22c">variance</a> () const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
73<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::euni::sample_m" ref="b4cf45fd83cc7573ede9fe1215256058" args="(int N) const " -->
75virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#b4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_108.png"> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_109.png">. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34956d4dd3176eeb5937cf48a1546b62"></a><!-- doxytag: member="bdm::euni::evallog_m" ref="34956d4dd3176eeb5937cf48a1546b62" args="(const mat &amp;Val) const " -->
79virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#34956d4dd3176eeb5937cf48a1546b62">evallog_m</a> (const mat &amp;Val) const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e584eac5579c1b6384947ecf66166c77"></a><!-- doxytag: member="bdm::euni::condition" ref="e584eac5579c1b6384947ecf66166c77" args="(const RV &amp;rv) const " -->
83virtual <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#e584eac5579c1b6384947ecf66166c77">condition</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>) const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return conditional density on the given <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>, the remaining rvs will be in conditioning. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fb2ece54f720b62ad325e61214fa0a1"></a><!-- doxytag: member="bdm::euni::marginal" ref="3fb2ece54f720b62ad325e61214fa0a1" args="(const RV &amp;rv) const " -->
87virtual <a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#3fb2ece54f720b62ad325e61214fa0a1">marginal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>) const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>, the remainig rvs are intergrated out. <br></td></tr>
90<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr>
91<tr><td colspan="2"><div class="groupText">Description of the random quantity via attribute <code>rv</code> is optional. For operations such as sampling <code>rv</code> does not need to be set. However, for <code>marginalization</code> and <code>conditioning</code> <code>rv</code> has to be set. NB: <br><br></div></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f423e28448dbb69ef4905295ec8de8ff"></a><!-- doxytag: member="bdm::euni::set_rv" ref="f423e28448dbb69ef4905295ec8de8ff" args="(const RV &amp;rv0)" -->
93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#f423e28448dbb69ef4905295ec8de8ff">set_rv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::euni::isnamed" ref="c4b863ff84c7a4882fb3ad18556027f9" args="() const " -->
97bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#c4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::euni::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
101const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4ab378d5e004c3ff3e2d4e64f7bba21">_rv</a> () const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br></td></tr>
104<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46dfe100cd621716ee5c7ee25a20f24b"></a><!-- doxytag: member="bdm::euni::dimension" ref="46dfe100cd621716ee5c7ee25a20f24b" args="() const " -->
106bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#46dfe100cd621716ee5c7ee25a20f24b">dimension</a> () const </td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br></td></tr>
109<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff7ce6a2ef5ef0015bbd1398bed12f32"></a><!-- doxytag: member="bdm::euni::low" ref="ff7ce6a2ef5ef0015bbd1398bed12f32" args="" -->
111vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#ff7ce6a2ef5ef0015bbd1398bed12f32">low</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">lower bound on support <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfad2dea4a62db6872bda8abd75f0de1"></a><!-- doxytag: member="bdm::euni::high" ref="cfad2dea4a62db6872bda8abd75f0de1" args="" -->
115vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#cfad2dea4a62db6872bda8abd75f0de1">high</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upper bound on support <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3c27e331f90c754d80228108de8ed4c"></a><!-- doxytag: member="bdm::euni::distance" ref="d3c27e331f90c754d80228108de8ed4c" args="" -->
119vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#d3c27e331f90c754d80228108de8ed4c">distance</a></td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31bb13e8449a8eff35246d46dae35c20"></a><!-- doxytag: member="bdm::euni::nk" ref="31bb13e8449a8eff35246d46dae35c20" args="" -->
123double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#31bb13e8449a8eff35246d46dae35c20">nk</a></td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">normalizing coefficients <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e63be48dd58659663ca60cd18700476"></a><!-- doxytag: member="bdm::euni::lnk" ref="3e63be48dd58659663ca60cd18700476" args="" -->
127double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#3e63be48dd58659663ca60cd18700476">lnk</a></td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of log( <code>nk</code> ) <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::euni::dim" ref="16adac20ec7fe07e1ea0b27d917788ce" args="" -->
131int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::euni::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
135<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a></td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br></td></tr>
138</table>
139<hr>The documentation for this class was generated from the following file:<ul>
140<li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
141</div>
142<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:06 2009 for mixpp by&nbsp;
143<a href="http://www.doxygen.org/index.html">
144<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
145</body>
146</html>
Note: See TracBrowser for help on using the browser.