root/doc/latex/classmpdf.tex @ 174

Revision 172, 6.3 kB (checked in by smidl, 16 years ago)

Latex 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=172pt]{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 the required moment of the \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
29virtual mat \hyperlink{classmpdf_0e37163660f93df2a4d723cedb1da89c}{samplecond} (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_80b738ece5bd4f8c4edaee4b38906f91}{
37virtual double \hyperlink{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{evalcond} (const vec \&dt, const vec \&cond)}
38\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}
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_6788be9f3a888796499c5293a318fcfb}{
42virtual \hyperlink{classmpdf_6788be9f3a888796499c5293a318fcfb}{$\sim$mpdf} ()}
43\label{classmpdf_6788be9f3a888796499c5293a318fcfb}
44
45\begin{CompactList}\small\item\em Destructor for future use;. \item\end{CompactList}\item 
46\hypertarget{classmpdf_581ecf362185d37c08bb31cb9d046d6f}{
47\hyperlink{classmpdf_581ecf362185d37c08bb31cb9d046d6f}{mpdf} (const \hyperlink{classRV}{RV} \&rv0, const \hyperlink{classRV}{RV} \&rvc0)}
48\label{classmpdf_581ecf362185d37c08bb31cb9d046d6f}
49
50\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
51\hypertarget{classmpdf_ec9c850305984582548e8deb64f0ffe8}{
52\hyperlink{classRV}{RV} \hyperlink{classmpdf_ec9c850305984582548e8deb64f0ffe8}{\_\-rvc} ()}
53\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{
57\hyperlink{classRV}{RV} \hyperlink{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{\_\-rv} ()}
58\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}
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}\end{CompactItemize}
66\subsection*{Protected Attributes}
67\begin{CompactItemize}
68\item 
69\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
70\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
71\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
72
73\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
74\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
75\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
76\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
77
78\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
79\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
80\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
81\label{classmpdf_7aa894208a32f3487827df6d5054424c}
82
83\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
84
85
86\subsection{Detailed Description}
87Conditional probability density, e.g. modeling some dependencies.
88
89\subsection{Member Function Documentation}
90\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
91\index{mpdf@{mpdf}!samplecond@{samplecond}}
92\index{samplecond@{samplecond}!mpdf@{mpdf}}
93\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{]}}}}
94\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
95
96
97Returns the required moment of the \hyperlink{classepdf}{epdf}.
98
99Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
100\item[Parameters:]
101\begin{description}
102\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
103\end{Desc}
104
105
106Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}.
107
108References condition(), ep, epdf::evalpdflog(), and epdf::sample().
109
110Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_0e37163660f93df2a4d723cedb1da89c}{
111\index{mpdf@{mpdf}!samplecond@{samplecond}}
112\index{samplecond@{samplecond}!mpdf@{mpdf}}
113\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
114\label{classmpdf_0e37163660f93df2a4d723cedb1da89c}
115
116
117Returns.
118
119\begin{Desc}
120\item[Parameters:]
121\begin{description}
122\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}
123\end{Desc}
124
125
126Reimplemented in \hyperlink{classmprod_e171c40e210539c2af01d6237785620b}{mprod}.
127
128References condition(), RV::count(), ep, epdf::evalpdflog(), rv, and epdf::sample().
129
130The documentation for this class was generated from the following file:\begin{CompactItemize}
131\item 
132work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.