root/doc/latex/classbdm_1_1mEF.tex @ 270

Revision 270, 7.1 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

Line 
1\hypertarget{classbdm_1_1mEF}{
2\section{bdm::mEF Class Reference}
3\label{classbdm_1_1mEF}\index{bdm::mEF@{bdm::mEF}}
4}
5{\tt \#include $<$libEF.h$>$}
6
7Inheritance diagram for bdm::mEF:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=400pt]{classbdm_1_1mEF__inherit__graph}
12\end{center}
13\end{figure}
14
15
16\subsection{Detailed Description}
17Exponential family model.
18
19More?... \subsection*{Public Member Functions}
20\begin{CompactItemize}
21\item 
22\hypertarget{classbdm_1_1mEF_dd7caad7026b778af66e34480eec6f9e}{
23\hyperlink{classbdm_1_1mEF_dd7caad7026b778af66e34480eec6f9e}{mEF} ()}
24\label{classbdm_1_1mEF_dd7caad7026b778af66e34480eec6f9e}
25
26\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\end{CompactItemize}
27\begin{Indent}{\bf Matematical operations}\par
28\begin{CompactItemize}
29\item 
30virtual vec \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{samplecond} (const vec \&cond)
31\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
32virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
33\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{
35virtual void \hyperlink{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{condition} (const vec \&cond)}
36\label{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}
37
38\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classbdm_1_1mpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{
40virtual double \hyperlink{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{evallogcond} (const vec \&dt, const vec \&cond)}
41\label{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}
42
43\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \hyperlink{classbdm_1_1epdf}{epdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item 
44\hypertarget{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{
45virtual vec \hyperlink{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
46\label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
47
48\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\end{CompactItemize}
49\end{Indent}
50\begin{Indent}{\bf Access to attributes}\par
51\begin{CompactItemize}
52\item 
53\hypertarget{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}{
54\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rv} ()}
55\label{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}
56
57\item 
58\hypertarget{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}{
59\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rvc} ()}
60\label{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}
61
62\item 
63\hypertarget{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}{
64int \textbf{dimension} ()}
65\label{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}
66
67\item 
68\hypertarget{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}{
69int \textbf{dimensionc} ()}
70\label{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}
71
72\item 
73\hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
74\hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} ()}
75\label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
76
77\item 
78\hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
79\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} ()}
80\label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
81
82\end{CompactItemize}
83\end{Indent}
84\begin{Indent}{\bf Connection to other objects}\par
85\begin{CompactItemize}
86\item 
87\hypertarget{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}{
88void \textbf{set\_\-rvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rvc0)}
89\label{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}
90
91\item 
92\hypertarget{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}{
93void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
94\label{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}
95
96\item 
97\hypertarget{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}{
98bool \textbf{isnamed} ()}
99\label{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}
100
101\end{CompactItemize}
102\end{Indent}
103\subsection*{Protected Attributes}
104\begin{CompactItemize}
105\item 
106\hypertarget{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
107int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
108\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
109
110\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
111\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
112\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
113\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
114
115\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
116\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
117\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
118\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
119
120\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
121
122
123\subsection{Member Function Documentation}
124\hypertarget{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{
125\index{bdm::mEF@{bdm::mEF}!samplecond@{samplecond}}
126\index{samplecond@{samplecond}!bdm::mEF@{bdm::mEF}}
127\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec bdm::mpdf::samplecond (const vec \& {\em cond})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
128\label{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}
129
130
131Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
132
133\begin{Desc}
134\item[Parameters:]
135\begin{description}
136\item[{\em cond}]is numeric value of {\tt rv} \end{description}
137\end{Desc}
138
139
140References bdm::mpdf::condition(), bdm::mpdf::ep, and bdm::epdf::sample().
141
142Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
143\index{bdm::mEF@{bdm::mEF}!samplecond\_\-m@{samplecond\_\-m}}
144\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mEF@{bdm::mEF}}
145\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat bdm::mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
146\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
147
148
149Returns.
150
151\begin{Desc}
152\item[Parameters:]
153\begin{description}
154\item[{\em N}]samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
155\end{Desc}
156
157
158References bdm::mpdf::condition(), bdm::epdf::dimension(), bdm::mpdf::ep, and bdm::epdf::sample().
159
160The documentation for this class was generated from the following file:\begin{CompactItemize}
161\item 
162\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.