root/doc/latex/classbdm_1_1eEF.tex @ 271

Revision 271, 8.9 kB (checked in by smidl, 16 years ago)

Next major revision

RevLine 
[261]1\hypertarget{classbdm_1_1eEF}{
2\section{bdm::eEF Class Reference}
3\label{classbdm_1_1eEF}\index{bdm::eEF@{bdm::eEF}}
4}
5{\tt \#include $<$libEF.h$>$}
6
[271]7Inheritance diagram for bdm::eEF::\begin{figure}[H]
[261]8\begin{center}
9\leavevmode
[271]10\includegraphics[height=11cm]{classbdm_1_1eEF}
[261]11\end{center}
12\end{figure}
[270]13
14
15\subsection{Detailed Description}
16General conjugate exponential family posterior density.
17
18More?... \subsection*{Public Member Functions}
[261]19\begin{CompactItemize}
20\item 
[270]21\hypertarget{classbdm_1_1eEF_d5459d472d0feca7cf1fb5f65c4b9ef4}{
22\hyperlink{classbdm_1_1eEF_d5459d472d0feca7cf1fb5f65c4b9ef4}{eEF} ()}
23\label{classbdm_1_1eEF_d5459d472d0feca7cf1fb5f65c4b9ef4}
[261]24
25\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
26\hypertarget{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}{
27virtual double \hyperlink{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}{lognc} () const =0}
28\label{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}
29
30\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
31\hypertarget{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{
32virtual void \hyperlink{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{dupdate} (mat \&v)}
33\label{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}
34
35\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
36\hypertarget{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{
37virtual double \hyperlink{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{evallog\_\-nn} (const vec \&val) const }
38\label{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}
39
40\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
41\hypertarget{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{
42virtual double \hyperlink{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{evallog} (const vec \&val) const }
43\label{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}
44
45\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
46\hypertarget{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{
47virtual vec \hyperlink{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{evallog} (const mat \&Val) const }
48\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}
49
50\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
51\hypertarget{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{
52virtual void \hyperlink{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{pow} (double p)}
53\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}
54
[270]55\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\end{CompactItemize}
[271]56\begin{Indent}{\bf Constructors}\par
57{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize}
58\item empty constructor, \item copy constructor,\end{itemize}
59The following constructors should be supported for convenience: \begin{itemize}
60\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize}
61All internal data structures are constructed as empty. Their values (including sizes) will be set by method {\tt set\_\-parameters()}. This way references can be initialized in constructors. }\begin{CompactItemize}
62\item 
63\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{
64void \textbf{set\_\-parameters} (int dim0)}
65\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}
66
67\end{CompactItemize}
68\end{Indent}
[270]69\begin{Indent}{\bf Matematical Operations}\par
70\begin{CompactItemize}
71\item 
[271]72\hypertarget{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}{
73virtual vec \hyperlink{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}{sample} () const }
74\label{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}
[261]75
[270]76\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
[261]77\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
78virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
79\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
80
[270]81\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
[261]82\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
83virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
84\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
85
86\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
87\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
88virtual \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{condition} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
89\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
90
91\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classbdm_1_1RV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
92\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
93virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{marginal} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
94\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
95
96\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classbdm_1_1RV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
[271]97\hypertarget{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}{
98virtual vec \hyperlink{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}{mean} () const }
99\label{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}
[261]100
101\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
[271]102\hypertarget{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}{
103virtual vec \hyperlink{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}{variance} () const }
104\label{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}
[261]105
[270]106\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\end{CompactItemize}
107\end{Indent}
108\begin{Indent}{\bf Connection to other classes}\par
109{\em Description of the random quantity via attribute {\tt rv} is optional. For operations such as sampling {\tt rv} does not need to be set. However, for {\tt marginalization} and {\tt conditioning} {\tt rv} has to be set. NB: }\begin{CompactItemize}
110\item 
111\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
112void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
113\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}
114
115\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
116\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
117bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
118\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}
119
120\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
[261]121\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
122const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
123\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
124
[270]125\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
126\end{Indent}
127\begin{Indent}{\bf Access to attributes}\par
128\begin{CompactItemize}
129\item 
[271]130\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{
131int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const }
132\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}
[261]133
[270]134\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
135\end{Indent}
[261]136\subsection*{Protected Attributes}
137\begin{CompactItemize}
138\item 
[270]139\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
140int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
141\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}
142
143\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
[261]144\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
145\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
146\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
147
[270]148\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
[261]149
150
151The documentation for this class was generated from the following file:\begin{CompactItemize}
152\item 
153\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.