root/doc/latex/classbdm_1_1eEF.tex @ 261

Revision 261, 7.0 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[261]1\hypertarget{classbdm_1_1eEF}{
2\section{bdm::eEF Class Reference}
3\label{classbdm_1_1eEF}\index{bdm::eEF@{bdm::eEF}}
4}
5General conjugate exponential family posterior density. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for bdm::eEF:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=400pt]{classbdm_1_1eEF__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::eEF:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=75pt]{classbdm_1_1eEF__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1eEF_1e92e3f94e594edb20adfa81ae9e2959}{
28\hyperlink{classbdm_1_1eEF_1e92e3f94e594edb20adfa81ae9e2959}{eEF} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv})}
29\label{classbdm_1_1eEF_1e92e3f94e594edb20adfa81ae9e2959}
30
31\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}{
33virtual double \hyperlink{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}{lognc} () const =0}
34\label{classbdm_1_1eEF_cd678fc9b02007a4b8d6692e746f1bf8}
35
36\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{
38virtual void \hyperlink{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{dupdate} (mat \&v)}
39\label{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}
40
41\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{
43virtual double \hyperlink{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{evallog\_\-nn} (const vec \&val) const }
44\label{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}
45
46\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{
48virtual double \hyperlink{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{evallog} (const vec \&val) const }
49\label{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}
50
51\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{
53virtual vec \hyperlink{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{evallog} (const mat \&Val) const }
54\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}
55
56\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
57\hypertarget{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{
58virtual void \hyperlink{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{pow} (double p)}
59\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}
60
61\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1epdf_09721eb148bc49d6ec2f1956039f3a10}{
63virtual vec \hyperlink{classbdm_1_1epdf_09721eb148bc49d6ec2f1956039f3a10}{sample} () const =0}
64\label{classbdm_1_1epdf_09721eb148bc49d6ec2f1956039f3a10}
65
66\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
68virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
69\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
70
71\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
73virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
74\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
75
76\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
77\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
78virtual \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 }
79\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
80
81\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 
82\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
83virtual \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 }
84\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
85
86\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 
87\hypertarget{classbdm_1_1epdf_565300f603ca00c989e16389d9eb42f5}{
88virtual vec \hyperlink{classbdm_1_1epdf_565300f603ca00c989e16389d9eb42f5}{mean} () const =0}
89\label{classbdm_1_1epdf_565300f603ca00c989e16389d9eb42f5}
90
91\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
92\hypertarget{classbdm_1_1epdf_45c2b64faa4bf526799e4154a6ec6097}{
93virtual vec \hyperlink{classbdm_1_1epdf_45c2b64faa4bf526799e4154a6ec6097}{variance} () const =0}
94\label{classbdm_1_1epdf_45c2b64faa4bf526799e4154a6ec6097}
95
96\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
97\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
98const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
99\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
100
101\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
102\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
103void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
104\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
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{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
111\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
112\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
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 
124\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.