root/doc/latex/classmpdf.tex @ 242

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

doc

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