root/doc/latex/classmepdf.tex @ 162

Revision 162, 4.7 kB (checked in by smidl, 16 years ago)

opravy a dokumentace

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