root/doc/html/classbdm_1_1euni.html @ 302

Revision 302, 17.8 kB (checked in by smidl, 16 years ago)

Install manual ticket #17

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="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1euni.html">euni</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::euni Class Reference</h1><!-- doxytag: class="bdm::euni" --><!-- doxytag: inherits="bdm::epdf" -->Uniform distributed density on a rectangular support. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1euni-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<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 " -->
82double&nbsp;</td><td class="memItemRight" valign="bottom"><b>eval</b> (const vec &amp;val) const </td></tr>
83
84<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 " -->
85double&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>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc5df80359ead2918384b2004ce67194"></a><!-- doxytag: member="bdm::euni::sample" ref="fc5df80359ead2918384b2004ce67194" args="() const " -->
89vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#fc5df80359ead2918384b2004ce67194">sample</a> () const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$ x $" src="form_42.png"> from density <img class="formulaInl" alt="$ f_x()$" src="form_43.png">. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46caa8c13aba2e6228f964208918b226"></a><!-- doxytag: member="bdm::euni::mean" ref="46caa8c13aba2e6228f964208918b226" args="() const " -->
93vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#46caa8c13aba2e6228f964208918b226">mean</a> () const </td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set values of <code>low</code> and <code>high</code> <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="951f932155111f6053c980f672b4c22c"></a><!-- doxytag: member="bdm::euni::variance" ref="951f932155111f6053c980f672b4c22c" args="() const " -->
97vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#951f932155111f6053c980f672b4c22c">variance</a> () const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
100<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8887b088e3ab0b01e96b88237d707b97"></a><!-- doxytag: member="bdm::euni::euni" ref="8887b088e3ab0b01e96b88237d707b97" args="()" -->
102&nbsp;</td><td class="memItemRight" valign="bottom"><b>euni</b> ()</td></tr>
103
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f40f4e92c36d090fca8300c4e4ae2c4d"></a><!-- doxytag: member="bdm::euni::euni" ref="f40f4e92c36d090fca8300c4e4ae2c4d" args="(const vec &amp;low0, const vec &amp;high0)" -->
105&nbsp;</td><td class="memItemRight" valign="bottom"><b>euni</b> (const vec &amp;low0, const vec &amp;high0)</td></tr>
106
107<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)" -->
108void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (const vec &amp;low0, const vec &amp;high0)</td></tr>
109
110<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
111<tr><td colspan="2"><div class="groupText">Construction of each <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> should support two types of constructors: <ul>
112<li>empty constructor, </li>
113<li>copy constructor,</li>
114</ul>
115The following constructors should be supported for convenience: <ul>
116<li>constructor followed by calling <code>set_parameters()</code> </li>
117<li>constructor accepting random variables calling <code><a class="el" href="classbdm_1_1epdf.html#f423e28448dbb69ef4905295ec8de8ff" title="Name its rv.">set_rv()</a></code> </li>
118</ul>
119All internal data structures are constructed as empty. Their values (including sizes) will be set by method <code>set_parameters()</code>. This way references can be initialized in constructors. <br><br></div></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840de94aa33cf4f2ebd2427f45a165d8"></a><!-- doxytag: member="bdm::euni::set_parameters" ref="840de94aa33cf4f2ebd2427f45a165d8" args="(int dim0)" -->
121void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (int dim0)</td></tr>
122
123<tr><td colspan="2"><div class="groupHeader">Matematical Operations</div></td></tr>
124<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 " -->
125virtual 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>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples, <img class="formulaInl" alt="$ [x_1 , x_2 , \ldots \ $" src="form_44.png"> from density <img class="formulaInl" alt="$ f_x(rv)$" src="form_45.png">. <br></td></tr>
128<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 " -->
129virtual 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>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
132<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 " -->
133virtual <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>
134
135<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>
136<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 " -->
137virtual <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>
138
139<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>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7705e80601957f7226d333a0a6d539"></a><!-- doxytag: member="bdm::euni::qbounds" ref="0a7705e80601957f7226d333a0a6d539" args="(vec &amp;lb, vec &amp;ub, double percentage=0.95) const " -->
141virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#0a7705e80601957f7226d333a0a6d539">qbounds</a> (vec &amp;lb, vec &amp;ub, double percentage=0.95) const </td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lower and upper bounds of <code>percentage</code> % quantile, returns mean-2*sigma as default. <br></td></tr>
144<tr><td colspan="2"><div class="groupHeader">Connection to other classes</div></td></tr>
145<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>
146<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)" -->
147void&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>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name its rv. <br></td></tr>
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4b863ff84c7a4882fb3ad18556027f9"></a><!-- doxytag: member="bdm::euni::isnamed" ref="c4b863ff84c7a4882fb3ad18556027f9" args="() const " -->
151bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#c4b863ff84c7a4882fb3ad18556027f9">isnamed</a> () const </td></tr>
152
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if rv is assigned. <br></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::euni::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
155const <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>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return name (fails when isnamed is false). <br></td></tr>
158<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7083a65f7b7a0d0d13b2c516bd2ec29c"></a><!-- doxytag: member="bdm::euni::dimension" ref="7083a65f7b7a0d0d13b2c516bd2ec29c" args="() const " -->
160int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#7083a65f7b7a0d0d13b2c516bd2ec29c">dimension</a> () const </td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the random variable. <br></td></tr>
163<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff7ce6a2ef5ef0015bbd1398bed12f32"></a><!-- doxytag: member="bdm::euni::low" ref="ff7ce6a2ef5ef0015bbd1398bed12f32" args="" -->
165vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#ff7ce6a2ef5ef0015bbd1398bed12f32">low</a></td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">lower bound on support <br></td></tr>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfad2dea4a62db6872bda8abd75f0de1"></a><!-- doxytag: member="bdm::euni::high" ref="cfad2dea4a62db6872bda8abd75f0de1" args="" -->
169vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#cfad2dea4a62db6872bda8abd75f0de1">high</a></td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upper bound on support <br></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3c27e331f90c754d80228108de8ed4c"></a><!-- doxytag: member="bdm::euni::distance" ref="d3c27e331f90c754d80228108de8ed4c" args="" -->
173vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#d3c27e331f90c754d80228108de8ed4c">distance</a></td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31bb13e8449a8eff35246d46dae35c20"></a><!-- doxytag: member="bdm::euni::nk" ref="31bb13e8449a8eff35246d46dae35c20" args="" -->
177double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#31bb13e8449a8eff35246d46dae35c20">nk</a></td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">normalizing coefficients <br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e63be48dd58659663ca60cd18700476"></a><!-- doxytag: member="bdm::euni::lnk" ref="3e63be48dd58659663ca60cd18700476" args="" -->
181double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1euni.html#3e63be48dd58659663ca60cd18700476">lnk</a></td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of log( <code>nk</code> ) <br></td></tr>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16adac20ec7fe07e1ea0b27d917788ce"></a><!-- doxytag: member="bdm::euni::dim" ref="16adac20ec7fe07e1ea0b27d917788ce" args="" -->
185int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#16adac20ec7fe07e1ea0b27d917788ce">dim</a></td></tr>
186
187<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the random variable <br></td></tr>
188<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::euni::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
189<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>
190
191<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the random variable. <br></td></tr>
192</table>
193<hr><a name="_details"></a><h2>Detailed Description</h2>
194Uniform distributed density on a rectangular support. <hr>The documentation for this class was generated from the following file:<ul>
195<li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
196</div>
197<hr size="1"><address style="text-align: right;"><small>Generated on Thu Mar 19 16:25:44 2009 for mixpp by&nbsp;
198<a href="http://www.doxygen.org/index.html">
199<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
200</body>
201</html>
Note: See TracBrowser for help on using the browser.