root/doc/latex/classbdm_1_1mEF.tex @ 271

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

Next major revision

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