root/doc/html/classeEmp.html @ 224

Revision 224, 15.1 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: eEmp 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>eEmp Class Reference</h1><!-- doxytag: class="eEmp" --><!-- doxytag: inherits="epdf" -->Weighted empirical density. 
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 eEmp:</div>
34<div class="dynsection">
35<p><center><img src="classeEmp__inherit__graph.png" border="0" usemap="#eEmp__inherit__map" alt="Inheritance graph"></center>
36<map name="eEmp__inherit__map">
37<area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="11,7,56,31"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for eEmp:</div>
41<div class="dynsection">
42<p><center><img src="classeEmp__coll__graph.png" border="0" usemap="#eEmp__coll__map" alt="Collaboration graph"></center>
43<map name="eEmp__coll__map">
44<area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="11,95,56,119"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="15,7,52,31"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classeEmp-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="0c04b073ecd0dae3d498e680ae27e9e4"></a><!-- doxytag: member="eEmp::eEmp" ref="0c04b073ecd0dae3d498e680ae27e9e4" args="(const RV &amp;rv0, int n0)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#0c04b073ecd0dae3d498e680ae27e9e4">eEmp</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv0, int n0)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eab03bd3381aaea11ce34d5a26556353"></a><!-- doxytag: member="eEmp::set_parameters" ref="eab03bd3381aaea11ce34d5a26556353" args="(const vec &amp;w0, const epdf *pdf0)" -->
56void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#eab03bd3381aaea11ce34d5a26556353">set_parameters</a> (const vec &amp;w0, const <a class="el" href="classepdf.html">epdf</a> *pdf0)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set samples and weights. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e31bc9e6196173c3480b06a761a3e716"></a><!-- doxytag: member="eEmp::set_samples" ref="e31bc9e6196173c3480b06a761a3e716" args="(const epdf *pdf0)" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#e31bc9e6196173c3480b06a761a3e716">set_samples</a> (const <a class="el" href="classepdf.html">epdf</a> *pdf0)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sample. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4215f6a5a04d07b43f7ebaa942e15f1"></a><!-- doxytag: member="eEmp::set_n" ref="a4215f6a5a04d07b43f7ebaa942e15f1" args="(int n0, bool copy=true)" -->
64void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#a4215f6a5a04d07b43f7ebaa942e15f1">set_n</a> (int n0, bool copy=true)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sample. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31b2bfb73b72486a5c89f2ab850c7a9b"></a><!-- doxytag: member="eEmp::_w" ref="31b2bfb73b72486a5c89f2ab850c7a9b" args="()" -->
68vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#31b2bfb73b72486a5c89f2ab850c7a9b">_w</a> ()</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Potentially dangerous, use with care. <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6f4ae1a67ecd2bff8b9f176ee261afc"></a><!-- doxytag: member="eEmp::_w" ref="d6f4ae1a67ecd2bff8b9f176ee261afc" args="() const " -->
72const vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#d6f4ae1a67ecd2bff8b9f176ee261afc">_w</a> () const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Potentially dangerous, use with care. <br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31b747eca73b16f30370827ba4cc3575"></a><!-- doxytag: member="eEmp::_samples" ref="31b747eca73b16f30370827ba4cc3575" args="()" -->
76Array&lt; vec &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#31b747eca73b16f30370827ba4cc3575">_samples</a> ()</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd48c1c36e2e9e78dbcea7df66dcbf25"></a><!-- doxytag: member="eEmp::_samples" ref="bd48c1c36e2e9e78dbcea7df66dcbf25" args="() const " -->
80const Array&lt; vec &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#bd48c1c36e2e9e78dbcea7df66dcbf25">_samples</a> () const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77268292fc4465cb73ddbfb1f2932a59"></a><!-- doxytag: member="eEmp::resample" ref="77268292fc4465cb73ddbfb1f2932a59" args="(RESAMPLING_METHOD method=SYSTEMATIC)" -->
84ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#77268292fc4465cb73ddbfb1f2932a59">resample</a> (<a class="el" href="libEF_8h.html#99497a3ff630f761cf6bff7babd23212">RESAMPLING_METHOD</a> method=SYSTEMATIC)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function performs resampling, i.e. removal of low-weight samples and duplication of high-weight samples such that the new samples represent the same density. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83f9283f92b805508d896479dc1ccf12"></a><!-- doxytag: member="eEmp::sample" ref="83f9283f92b805508d896479dc1ccf12" args="() const " -->
88vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#83f9283f92b805508d896479dc1ccf12">sample</a> () const </td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inherited operation : NOT implemneted <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="884f16c9fc1f888408686a660a95dacd"></a><!-- doxytag: member="eEmp::evallog" ref="884f16c9fc1f888408686a660a95dacd" args="(const vec &amp;val) const " -->
92double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#884f16c9fc1f888408686a660a95dacd">evallog</a> (const vec &amp;val) const </td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inherited operation : NOT implemneted <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba055c19038cc72628d98e25197e982d"></a><!-- doxytag: member="eEmp::mean" ref="ba055c19038cc72628d98e25197e982d" args="() const " -->
96vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#ba055c19038cc72628d98e25197e982d">mean</a> () const </td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76608914c3b19e150292d5c56e93e508"></a><!-- doxytag: member="eEmp::sample_m" ref="76608914c3b19e150292d5c56e93e508" args="(int N) const " -->
100virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#76608914c3b19e150292d5c56e93e508">sample_m</a> (int N) const </td></tr>
101
102<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>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2495a04bbacb9b55fe5a3a59b78affca"></a><!-- doxytag: member="eEmp::evallog_m" ref="2495a04bbacb9b55fe5a3a59b78affca" args="(const mat &amp;Val) const " -->
104virtual 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>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e87dc8260a5c37bc1b03eb66174741a0"></a><!-- doxytag: member="eEmp::condition" ref="e87dc8260a5c37bc1b03eb66174741a0" args="(const RV &amp;rv) const " -->
108virtual <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>
109
110<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>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38de9f59b65ee06028554f3f74b66025"></a><!-- doxytag: member="eEmp::marginal" ref="38de9f59b65ee06028554f3f74b66025" args="(const RV &amp;rv) const " -->
112virtual <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>
113
114<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>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="eEmp::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
116const <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>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="eEmp::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
120void&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>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
123<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c33034de0e35f03f8bb85d3d67438fd"></a><!-- doxytag: member="eEmp::n" ref="8c33034de0e35f03f8bb85d3d67438fd" args="" -->
125int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#8c33034de0e35f03f8bb85d3d67438fd">n</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of particles. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae78d144404ddba843c93b171b215de8"></a><!-- doxytag: member="eEmp::w" ref="ae78d144404ddba843c93b171b215de8" args="" -->
129vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#ae78d144404ddba843c93b171b215de8">w</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sample weights <img class="formulaInl" alt="$w$" src="form_44.png">. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4d6f4bbd6a6824fc39f14676701279a"></a><!-- doxytag: member="eEmp::samples" ref="a4d6f4bbd6a6824fc39f14676701279a" args="" -->
133Array&lt; vec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#a4d6f4bbd6a6824fc39f14676701279a">samples</a></td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Samples <img class="formulaInl" alt="$x^{(i)}, i=1..n$" src="form_9.png">. <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="eEmp::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
137<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>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
140</table>
141<hr><a name="_details"></a><h2>Detailed Description</h2>
142Weighted empirical density.
143<p>
144Used e.g. in particle filters. <hr>The documentation for this class was generated from the following files:<ul>
145<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a><li>work/git/mixpp/bdm/stat/libEF.cpp</ul>
146</div>
147<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:29:15 2009 for mixpp by&nbsp;
148<a href="http://www.doxygen.org/index.html">
149<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
150</body>
151</html>
Note: See TracBrowser for help on using the browser.