root/doc/latex/classmepdf.tex @ 252

Revision 234, 6.7 kB (checked in by smidl, 15 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classmepdf}{
2\section{mepdf Class Reference}
3\label{classmepdf}\index{mepdf@{mepdf}}
4}
5Unconditional \hyperlink{classmpdf}{mpdf}, allows using \hyperlink{classepdf}{epdf} in the role of \hyperlink{classmpdf}{mpdf}. 
6
7
8{\tt \#include $<$libBM.h$>$}
9
10Inheritance diagram for mepdf:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=45pt]{classmepdf__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for mepdf:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=59pt]{classmepdf__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classmepdf_0f39973ffd94c1e20e2d8aacc4adc6fa}{
28\hyperlink{classmepdf_0f39973ffd94c1e20e2d8aacc4adc6fa}{mepdf} (const \hyperlink{classepdf}{epdf} $\ast$em)}
29\label{classmepdf_0f39973ffd94c1e20e2d8aacc4adc6fa}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classmepdf_bc87d89dbc3cf5eb6a0ad7d6d572488f}{
33void \hyperlink{classmepdf_bc87d89dbc3cf5eb6a0ad7d6d572488f}{condition} (const vec \&cond)}
34\label{classmepdf_bc87d89dbc3cf5eb6a0ad7d6d572488f}
35
36\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classmpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
37virtual vec \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{samplecond} (const vec \&cond, double \&ll)
38\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
39virtual mat \hyperlink{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}{samplecond\_\-m} (const vec \&cond, vec \&ll, int N)
40\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
41\hypertarget{classmpdf_2ef8a6374029d990a678782f6decebbe}{
42virtual double \hyperlink{classmpdf_2ef8a6374029d990a678782f6decebbe}{evallogcond} (const vec \&dt, const vec \&cond)}
43\label{classmpdf_2ef8a6374029d990a678782f6decebbe}
44
45\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \hyperlink{classepdf}{epdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item 
46\hypertarget{classmpdf_95fcff214848f66f1b489459370573fa}{
47virtual vec \hyperlink{classmpdf_95fcff214848f66f1b489459370573fa}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
48\label{classmpdf_95fcff214848f66f1b489459370573fa}
49
50\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\item 
51\hypertarget{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{
52\hyperlink{classRV}{RV} \hyperlink{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{\_\-rvc} () const }
53\label{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{
57\hyperlink{classRV}{RV} \hyperlink{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{\_\-rv} () const }
58\label{classmpdf_71256ffb5fbd08f41d650e606a5bd585}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
62\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
63\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
66\hypertarget{classmpdf_75ded3b0f657cd7da6590691a810963c}{
67\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_75ded3b0f657cd7da6590691a810963c}{\_\-e} ()}
68\label{classmpdf_75ded3b0f657cd7da6590691a810963c}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
71\subsection*{Protected Attributes}
72\begin{CompactItemize}
73\item 
74\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
75\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
76\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
77
78\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
79\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
80\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
81\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
82
83\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
84\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
85\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
86\label{classmpdf_7aa894208a32f3487827df6d5054424c}
87
88\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
89
90
91\subsection{Detailed Description}
92Unconditional \hyperlink{classmpdf}{mpdf}, allows using \hyperlink{classepdf}{epdf} in the role of \hyperlink{classmpdf}{mpdf}.
93
94
95
96\subsection{Member Function Documentation}
97\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
98\index{mepdf@{mepdf}!samplecond@{samplecond}}
99\index{samplecond@{samplecond}!mepdf@{mepdf}}
100\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
101\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
102
103
104Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
105
106\begin{Desc}
107\item[Parameters:]
108\begin{description}
109\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
110\end{Desc}
111
112
113Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}.
114
115References mpdf::condition(), mpdf::ep, epdf::evallog(), and epdf::sample().
116
117Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}{
118\index{mepdf@{mepdf}!samplecond\_\-m@{samplecond\_\-m}}
119\index{samplecond\_\-m@{samplecond\_\-m}!mepdf@{mepdf}}
120\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
121\label{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}
122
123
124Returns.
125
126\begin{Desc}
127\item[Parameters:]
128\begin{description}
129\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}
130\end{Desc}
131
132
133References mpdf::condition(), RV::count(), mpdf::ep, epdf::evallog(), mpdf::rv, and epdf::sample().
134
135The documentation for this class was generated from the following file:\begin{CompactItemize}
136\item 
137work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.