root/doc/latex/classeEF.tex @ 185

Revision 181, 6.5 kB (checked in by smidl, 17 years ago)

Regenerated doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classeEF}{
2\section{eEF Class Reference}
3\label{classeEF}\index{eEF@{eEF}}
4}
5General conjugate exponential family posterior density. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for eEF:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=400pt]{classeEF__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for eEF:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=39pt]{classeEF__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classeEF_7e3c63655e8375c76bf1f421245427a7}{
28\hyperlink{classeEF_7e3c63655e8375c76bf1f421245427a7}{eEF} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
29\label{classeEF_7e3c63655e8375c76bf1f421245427a7}
30
31\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
32\hypertarget{classeEF_69e5680dac10375d62520d26c672477d}{
33virtual double \hyperlink{classeEF_69e5680dac10375d62520d26c672477d}{lognc} () const =0}
34\label{classeEF_69e5680dac10375d62520d26c672477d}
35
36\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
37\hypertarget{classeEF_a89bef8996410609004fa019b5b48964}{
38virtual void \hyperlink{classeEF_a89bef8996410609004fa019b5b48964}{dupdate} (mat \&v)}
39\label{classeEF_a89bef8996410609004fa019b5b48964}
40
41\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
42\hypertarget{classeEF_48cdd33d0e20d1a1aa45683c956bc61c}{
43virtual double \hyperlink{classeEF_48cdd33d0e20d1a1aa45683c956bc61c}{evalpdflog\_\-nn} (const vec \&val) const }
44\label{classeEF_48cdd33d0e20d1a1aa45683c956bc61c}
45
46\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
47\hypertarget{classeEF_6466e8d4aa9dd64698ed288cbb1afc03}{
48virtual double \hyperlink{classeEF_6466e8d4aa9dd64698ed288cbb1afc03}{evalpdflog} (const vec \&val) const }
49\label{classeEF_6466e8d4aa9dd64698ed288cbb1afc03}
50
51\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
52\hypertarget{classeEF_c71faf4b2d153efda14bf1f87dca1507}{
53virtual vec \hyperlink{classeEF_c71faf4b2d153efda14bf1f87dca1507}{evalpdflog} (const mat \&Val) const }
54\label{classeEF_c71faf4b2d153efda14bf1f87dca1507}
55
56\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
57\hypertarget{classeEF_4f8385dd1cc9740522dc373b1dc3cbf5}{
58virtual void \hyperlink{classeEF_4f8385dd1cc9740522dc373b1dc3cbf5}{pow} (double p)}
59\label{classeEF_4f8385dd1cc9740522dc373b1dc3cbf5}
60
61\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\item 
62\hypertarget{classepdf_8019654e494bf5e458f6fb947e11b262}{
63virtual vec \hyperlink{classepdf_8019654e494bf5e458f6fb947e11b262}{sample} () const =0}
64\label{classepdf_8019654e494bf5e458f6fb947e11b262}
65
66\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
67\hypertarget{classepdf_54d7dd53a641b618771cd9bee135181f}{
68virtual mat \hyperlink{classepdf_54d7dd53a641b618771cd9bee135181f}{sampleN} (int N) const }
69\label{classepdf_54d7dd53a641b618771cd9bee135181f}
70
71\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
72\hypertarget{classepdf_3ea597362e11a0040fe7c990269d072c}{
73virtual double \hyperlink{classepdf_3ea597362e11a0040fe7c990269d072c}{eval} (const vec \&val) const }
74\label{classepdf_3ea597362e11a0040fe7c990269d072c}
75
76\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
77\hypertarget{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{
78virtual vec \hyperlink{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{evalpdflog\_\-m} (const mat \&Val) const }
79\label{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}
80
81\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
82\hypertarget{classepdf_3ba08c0e788deff22134c049b9269666}{
83\hyperlink{classmpdf}{mpdf} $\ast$ \hyperlink{classepdf_3ba08c0e788deff22134c049b9269666}{condition} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
84\label{classepdf_3ba08c0e788deff22134c049b9269666}
85
86\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classRV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
87\hypertarget{classepdf_bc0c171b6dafacd78d26263913b1d0c0}{
88\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classepdf_bc0c171b6dafacd78d26263913b1d0c0}{marginal} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
89\label{classepdf_bc0c171b6dafacd78d26263913b1d0c0}
90
91\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classRV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
92\hypertarget{classepdf_bf0a070a8f3e67a93604ca724638b870}{
93virtual vec \hyperlink{classepdf_bf0a070a8f3e67a93604ca724638b870}{mean} () const =0}
94\label{classepdf_bf0a070a8f3e67a93604ca724638b870}
95
96\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
97\hypertarget{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{
98const \hyperlink{classRV}{RV} \& \hyperlink{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{\_\-rv} () const }
99\label{classepdf_ca0d32aabb4cbba347e0c37fe8607562}
100
101\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
102\hypertarget{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{
103void \hyperlink{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{\_\-renewrv} (const \hyperlink{classRV}{RV} \&in\_\-rv)}
104\label{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}
105
106\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
107\subsection*{Protected Attributes}
108\begin{CompactItemize}
109\item 
110\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
111\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
112\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
113
114\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
115
116
117\subsection{Detailed Description}
118General conjugate exponential family posterior density.
119
120More?...
121
122The documentation for this class was generated from the following file:\begin{CompactItemize}
123\item 
124work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.