root/doc/html/classeEmp.html @ 172

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

New documentation

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 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>eEmp Class Reference</h1><!-- doxytag: class="eEmp" --><!-- doxytag: inherits="epdf" -->Weighted empirical density. 
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 eEmp:</div>
33<div class="dynsection">
34<p><center><img src="classeEmp__inherit__graph.png" border="0" usemap="#eEmp__inherit__map" alt="Inheritance graph"></center>
35<map name="eEmp__inherit__map">
36<area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="11,7,56,31"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for eEmp:</div>
40<div class="dynsection">
41<p><center><img src="classeEmp__coll__graph.png" border="0" usemap="#eEmp__coll__map" alt="Collaboration graph"></center>
42<map name="eEmp__coll__map">
43<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>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classeEmp-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="0c04b073ecd0dae3d498e680ae27e9e4"></a><!-- doxytag: member="eEmp::eEmp" ref="0c04b073ecd0dae3d498e680ae27e9e4" args="(const RV &amp;rv0, int n0)" -->
51&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>
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"><a class="anchor" name="6606a656c1b28114f7384c25aaf80e8d"></a><!-- doxytag: member="eEmp::set_parameters" ref="6606a656c1b28114f7384c25aaf80e8d" args="(const vec &amp;w0, epdf *pdf0)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#6606a656c1b28114f7384c25aaf80e8d">set_parameters</a> (const vec &amp;w0, <a class="el" href="classepdf.html">epdf</a> *pdf0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sample. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31b2bfb73b72486a5c89f2ab850c7a9b"></a><!-- doxytag: member="eEmp::_w" ref="31b2bfb73b72486a5c89f2ab850c7a9b" args="()" -->
59vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#31b2bfb73b72486a5c89f2ab850c7a9b">_w</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Potentially dangerous, use with care. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31b747eca73b16f30370827ba4cc3575"></a><!-- doxytag: member="eEmp::_samples" ref="31b747eca73b16f30370827ba4cc3575" args="()" -->
63Array&lt; vec &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#31b747eca73b16f30370827ba4cc3575">_samples</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
66<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)" -->
67ivec&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>
68
69<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>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83f9283f92b805508d896479dc1ccf12"></a><!-- doxytag: member="eEmp::sample" ref="83f9283f92b805508d896479dc1ccf12" args="() const " -->
71vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#83f9283f92b805508d896479dc1ccf12">sample</a> () const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inherited operation : NOT implemneted <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23e7358995400865ad2e278945922fb3"></a><!-- doxytag: member="eEmp::evalpdflog" ref="23e7358995400865ad2e278945922fb3" args="(const vec &amp;val) const " -->
75double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#23e7358995400865ad2e278945922fb3">evalpdflog</a> (const vec &amp;val) const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inherited operation : NOT implemneted <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba055c19038cc72628d98e25197e982d"></a><!-- doxytag: member="eEmp::mean" ref="ba055c19038cc72628d98e25197e982d" args="() const " -->
79vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#ba055c19038cc72628d98e25197e982d">mean</a> () const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54d7dd53a641b618771cd9bee135181f"></a><!-- doxytag: member="eEmp::sampleN" ref="54d7dd53a641b618771cd9bee135181f" args="(int N) const " -->
83virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#54d7dd53a641b618771cd9bee135181f">sampleN</a> (int N) const </td></tr>
84
85<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>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ea597362e11a0040fe7c990269d072c"></a><!-- doxytag: member="eEmp::eval" ref="3ea597362e11a0040fe7c990269d072c" args="(const vec &amp;val) const " -->
87virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ea597362e11a0040fe7c990269d072c">eval</a> (const vec &amp;val) const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6af383b6f1c6ea6fc5f6724dd03d8877"></a><!-- doxytag: member="eEmp::evalpdflog" ref="6af383b6f1c6ea6fc5f6724dd03d8877" args="(const mat &amp;Val) const " -->
91virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#6af383b6f1c6ea6fc5f6724dd03d8877">evalpdflog</a> (const mat &amp;Val) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="eEmp::_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="eEmp::_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="8c33034de0e35f03f8bb85d3d67438fd"></a><!-- doxytag: member="eEmp::n" ref="8c33034de0e35f03f8bb85d3d67438fd" args="" -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#8c33034de0e35f03f8bb85d3d67438fd">n</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of particles. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae78d144404ddba843c93b171b215de8"></a><!-- doxytag: member="eEmp::w" ref="ae78d144404ddba843c93b171b215de8" args="" -->
108vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#ae78d144404ddba843c93b171b215de8">w</a></td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sample weights <img class="formulaInl" alt="$w$" src="form_44.png">. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4d6f4bbd6a6824fc39f14676701279a"></a><!-- doxytag: member="eEmp::samples" ref="a4d6f4bbd6a6824fc39f14676701279a" args="" -->
112Array&lt; vec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEmp.html#a4d6f4bbd6a6824fc39f14676701279a">samples</a></td></tr>
113
114<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>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="eEmp::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
116<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>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
119</table>
120<hr><a name="_details"></a><h2>Detailed Description</h2>
121Weighted empirical density.
122<p>
123Used e.g. in particle filters. <hr>The documentation for this class was generated from the following files:<ul>
124<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>
125</div>
126<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:50 2008 for mixpp by&nbsp;
127<a href="http://www.doxygen.org/index.html">
128<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
129</body>
130</html>
Note: See TracBrowser for help on using the browser.