root/doc/latex/classmepdf.tex @ 140

Revision 140, 5.0 kB (checked in by smidl, 16 years ago)

Latex doc

  • Property svn:eol-style set to native
Line 
1\section{mepdf Class Reference}
2\label{classmepdf}\index{mepdf@{mepdf}}
3Unconditional \doxyref{mpdf}{p.}{classmpdf}, allows using \doxyref{epdf}{p.}{classepdf} in the role of \doxyref{mpdf}{p.}{classmpdf}
4
5
6{\tt \#include $<$libBM.h$>$}
7
8Inheritance diagram for mepdf:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=45pt]{classmepdf__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for mepdf:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=59pt]{classmepdf__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf mepdf} (const {\bf RV} \&{\bf rv}, const {\bf RV} \&{\bf rvc}, {\bf epdf} $\ast$em)\label{classmepdf_213e3a177540a0815aa7bdcc1bb25c6e}
26
27\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
28virtual vec {\bf samplecond} (vec \&cond, double \&ll)
29\begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item 
30virtual mat {\bf samplecond} (vec \&cond, vec \&ll, int N)
31\begin{CompactList}\small\item\em Returns N samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
32virtual void {\bf condition} (const vec \&cond)\label{classmpdf_0f95a0cc6ab40611f46804682446ed83}
33
34\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \doxyref{mpdf}{p.}{classmpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
35virtual double {\bf evalcond} (const vec \&dt, const vec \&cond)\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}
36
37\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \doxyref{epdf}{p.}{classepdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item 
38{\bf RV} {\bf \_\-rvc} ()\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
39
40\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
41{\bf epdf} \& {\bf \_\-epdf} ()\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
42
43\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
44\subsection*{Protected Attributes}
45\begin{CompactItemize}
46\item 
47{\bf RV} {\bf rv}\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
48
49\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
50{\bf RV} {\bf rvc}\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
51
52\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
53{\bf epdf} $\ast$ {\bf ep}\label{classmpdf_7aa894208a32f3487827df6d5054424c}
54
55\begin{CompactList}\small\item\em pointer to internal \doxyref{epdf}{p.}{classepdf} \item\end{CompactList}\end{CompactItemize}
56
57
58\subsection{Detailed Description}
59Unconditional \doxyref{mpdf}{p.}{classmpdf}, allows using \doxyref{epdf}{p.}{classepdf} in the role of \doxyref{mpdf}{p.}{classmpdf}.
60
61WARNING: the class does not check validity of the {\tt ep} pointer nor its existence.
62
63\subsection{Member Function Documentation}
64\index{mepdf@{mepdf}!samplecond@{samplecond}}
65\index{samplecond@{samplecond}!mepdf@{mepdf}}
66\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  [inline, virtual, inherited]}}\label{classmpdf_b0193a350c97933ddf15b15a130da352}
67
68
69Returns the required moment of the \doxyref{epdf}{p.}{classepdf}.
70
71Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
72\item[Parameters:]
73\begin{description}
74\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
75\end{Desc}
76
77
78Reimplemented in {\bf mlnorm$<$ sq\_\-T $>$} \doxyref{}{p.}{classmlnorm_decf3e3b5c8e0812e5b4dbe94fa2ae18}, and {\bf mgamma} \doxyref{}{p.}{classmgamma_9f40dc43885085fad8e3d6652b79e139}.
79
80References mpdf::condition(), mpdf::ep, epdf::evalpdflog(), and epdf::sample().
81
82Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\index{mepdf@{mepdf}!samplecond@{samplecond}}
83\index{samplecond@{samplecond}!mepdf@{mepdf}}
84\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond (vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  [inline, virtual, inherited]}}\label{classmpdf_6bf806badfdac606c847e458e8fce18c}
85
86
87Returns N samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
88
89\begin{Desc}
90\item[Parameters:]
91\begin{description}
92\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
93\end{Desc}
94
95
96Reimplemented in {\bf mlnorm$<$ sq\_\-T $>$} \doxyref{}{p.}{classmlnorm_215fb88cc8b95d64cdefd6849abdd1e8}, and {\bf mgamma} \doxyref{}{p.}{classmgamma_e9d52749793f40aad85b70c6db4435ae}.
97
98References mpdf::condition(), RV::count(), mpdf::ep, epdf::evalpdflog(), mpdf::rv, and epdf::sample().
99
100The documentation for this class was generated from the following file:\begin{CompactItemize}
101\item 
102work/mixpp/bdm/stat/{\bf libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.