root/doc/latex/classeEmp.tex @ 172

Revision 172, 6.1 kB (checked in by smidl, 16 years ago)

Latex doc

  • Property svn:eol-style set to native
RevLine 
[172]1\hypertarget{classeEmp}{
[30]2\section{eEmp Class Reference}
3\label{classeEmp}\index{eEmp@{eEmp}}
[172]4}
[30]5Weighted empirical density. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for eEmp:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
[91]14\includegraphics[width=43pt]{classeEmp__inherit__graph}
[30]15\end{center}
16\end{figure}
17Collaboration diagram for eEmp:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
[91]21\includegraphics[width=43pt]{classeEmp__coll__graph}
[30]22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
[172]27\hypertarget{classeEmp_0c04b073ecd0dae3d498e680ae27e9e4}{
28\hyperlink{classeEmp_0c04b073ecd0dae3d498e680ae27e9e4}{eEmp} (const \hyperlink{classRV}{RV} \&rv0, int n0)}
29\label{classeEmp_0c04b073ecd0dae3d498e680ae27e9e4}
[30]30
[33]31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
[172]32\hypertarget{classeEmp_6606a656c1b28114f7384c25aaf80e8d}{
33void \hyperlink{classeEmp_6606a656c1b28114f7384c25aaf80e8d}{set\_\-parameters} (const vec \&w0, \hyperlink{classepdf}{epdf} $\ast$pdf0)}
34\label{classeEmp_6606a656c1b28114f7384c25aaf80e8d}
[30]35
[33]36\begin{CompactList}\small\item\em Set sample. \item\end{CompactList}\item 
[172]37\hypertarget{classeEmp_31b2bfb73b72486a5c89f2ab850c7a9b}{
38vec \& \hyperlink{classeEmp_31b2bfb73b72486a5c89f2ab850c7a9b}{\_\-w} ()}
39\label{classeEmp_31b2bfb73b72486a5c89f2ab850c7a9b}
[30]40
41\begin{CompactList}\small\item\em Potentially dangerous, use with care. \item\end{CompactList}\item 
[172]42\hypertarget{classeEmp_31b747eca73b16f30370827ba4cc3575}{
43Array$<$ vec $>$ \& \hyperlink{classeEmp_31b747eca73b16f30370827ba4cc3575}{\_\-samples} ()}
44\label{classeEmp_31b747eca73b16f30370827ba4cc3575}
[30]45
[33]46\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
[172]47\hypertarget{classeEmp_77268292fc4465cb73ddbfb1f2932a59}{
48ivec \hyperlink{classeEmp_77268292fc4465cb73ddbfb1f2932a59}{resample} (\hyperlink{libEF_8h_99497a3ff630f761cf6bff7babd23212}{RESAMPLING\_\-METHOD} method=SYSTEMATIC)}
49\label{classeEmp_77268292fc4465cb73ddbfb1f2932a59}
[30]50
51\begin{CompactList}\small\item\em 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. \item\end{CompactList}\item 
[172]52\hypertarget{classeEmp_83f9283f92b805508d896479dc1ccf12}{
53vec \hyperlink{classeEmp_83f9283f92b805508d896479dc1ccf12}{sample} () const }
54\label{classeEmp_83f9283f92b805508d896479dc1ccf12}
[30]55
[33]56\begin{CompactList}\small\item\em inherited operation : NOT implemneted \item\end{CompactList}\item 
[172]57\hypertarget{classeEmp_23e7358995400865ad2e278945922fb3}{
58double \hyperlink{classeEmp_23e7358995400865ad2e278945922fb3}{evalpdflog} (const vec \&val) const }
59\label{classeEmp_23e7358995400865ad2e278945922fb3}
[33]60
61\begin{CompactList}\small\item\em inherited operation : NOT implemneted \item\end{CompactList}\item 
[172]62\hypertarget{classeEmp_ba055c19038cc72628d98e25197e982d}{
63vec \hyperlink{classeEmp_ba055c19038cc72628d98e25197e982d}{mean} () const }
64\label{classeEmp_ba055c19038cc72628d98e25197e982d}
[33]65
[30]66\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
[172]67\hypertarget{classepdf_54d7dd53a641b618771cd9bee135181f}{
68virtual mat \hyperlink{classepdf_54d7dd53a641b618771cd9bee135181f}{sampleN} (int N) const }
69\label{classepdf_54d7dd53a641b618771cd9bee135181f}
[106]70
71\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
[172]72\hypertarget{classepdf_3ea597362e11a0040fe7c990269d072c}{
73virtual double \hyperlink{classepdf_3ea597362e11a0040fe7c990269d072c}{eval} (const vec \&val) const }
74\label{classepdf_3ea597362e11a0040fe7c990269d072c}
[30]75
76\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
[172]77\hypertarget{classepdf_6af383b6f1c6ea6fc5f6724dd03d8877}{
78virtual vec \hyperlink{classepdf_6af383b6f1c6ea6fc5f6724dd03d8877}{evalpdflog} (const mat \&Val) const }
79\label{classepdf_6af383b6f1c6ea6fc5f6724dd03d8877}
[30]80
[172]81\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
82\hypertarget{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{
83const \hyperlink{classRV}{RV} \& \hyperlink{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{\_\-rv} () const }
84\label{classepdf_ca0d32aabb4cbba347e0c37fe8607562}
85
86\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
87\hypertarget{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{
88void \hyperlink{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{\_\-renewrv} (const \hyperlink{classRV}{RV} \&in\_\-rv)}
89\label{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}
90
91\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
[30]92\subsection*{Protected Attributes}
93\begin{CompactItemize}
94\item 
[172]95\hypertarget{classeEmp_8c33034de0e35f03f8bb85d3d67438fd}{
96int \hyperlink{classeEmp_8c33034de0e35f03f8bb85d3d67438fd}{n}}
97\label{classeEmp_8c33034de0e35f03f8bb85d3d67438fd}
[30]98
99\begin{CompactList}\small\item\em Number of particles. \item\end{CompactList}\item 
[172]100\hypertarget{classeEmp_ae78d144404ddba843c93b171b215de8}{
101vec \hyperlink{classeEmp_ae78d144404ddba843c93b171b215de8}{w}}
102\label{classeEmp_ae78d144404ddba843c93b171b215de8}
[30]103
[91]104\begin{CompactList}\small\item\em Sample weights $w$. \item\end{CompactList}\item 
[172]105\hypertarget{classeEmp_a4d6f4bbd6a6824fc39f14676701279a}{
106Array$<$ vec $>$ \hyperlink{classeEmp_a4d6f4bbd6a6824fc39f14676701279a}{samples}}
107\label{classeEmp_a4d6f4bbd6a6824fc39f14676701279a}
[30]108
[33]109\begin{CompactList}\small\item\em Samples $x^{(i)}, i=1..n$. \item\end{CompactList}\item 
[172]110\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
111\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
112\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
[30]113
[33]114\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
[30]115
116
117\subsection{Detailed Description}
118Weighted empirical density.
119
120Used e.g. in particle filters.
121
122The documentation for this class was generated from the following files:\begin{CompactItemize}
123\item 
[172]124work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\item 
[145]125work/git/mixpp/bdm/stat/libEF.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.