Changeset 140 for doc/latex/classmepdf.tex

Timestamp:

08/18/08 14:28:04 (16 years ago)

Author:

smidl

Message:

Latex doc

Files:

• doc/latex/classmepdf.tex (copied) (copied from doc/latex/classmpdf.tex) (5 diffs)

doc/latex/classmepdf.tex

@@ -1 @@
-\section{mpdf Class Reference}
-\label{classmpdf}\index{mpdf@{mpdf}}
-Conditional probability density, e.g. modeling some dependencies.  
+\section{mepdf Class Reference}
+\label{classmepdf}\index{mepdf@{mepdf}}
+Unconditional \doxyref{mpdf}{p.}{classmpdf}, allows using \doxyref{epdf}{p.}{classepdf} in the role of \doxyref{mpdf}{p.}{classmpdf}.  
 
 
 {\tt \#include $<$libBM.h$>$}
 
-Inheritance diagram for mpdf:\nopagebreak
+Inheritance diagram for mepdf:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
-\includegraphics[width=107pt]{classmpdf__inherit__graph}
+\includegraphics[width=45pt]{classmepdf__inherit__graph}
 \end{center}
 \end{figure}
-Collaboration diagram for mpdf:\nopagebreak
+Collaboration diagram for mepdf:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
-\includegraphics[width=56pt]{classmpdf__coll__graph}
+\includegraphics[width=59pt]{classmepdf__coll__graph}
 \end{center}
 \end{figure}
@@ -23 +23 @@
 \begin{CompactItemize}
 \item 
+{\bf mepdf} (const {\bf RV} \&{\bf rv}, const {\bf RV} \&{\bf rvc}, {\bf epdf} $\ast$em)\label{classmepdf_213e3a177540a0815aa7bdcc1bb25c6e}
+
+\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
 virtual vec {\bf samplecond} (vec \&cond, double \&ll)
 \begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item 
+virtual mat {\bf samplecond} (vec \&cond, vec \&ll, int N)
+\begin{CompactList}\small\item\em Returns N samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
 virtual void {\bf condition} (const vec \&cond)\label{classmpdf_0f95a0cc6ab40611f46804682446ed83}
 
@@ -31 +36 @@
 
 \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 
-virtual {\bf $\sim$mpdf} ()\label{classmpdf_6788be9f3a888796499c5293a318fcfb}
-
-\begin{CompactList}\small\item\em Destructor for future use;. \item\end{CompactList}\item 
-{\bf mpdf} (const {\bf RV} \&rv0, const {\bf RV} \&rvc0)\label{classmpdf_581ecf362185d37c08bb31cb9d046d6f}
-
-\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
 {\bf RV} {\bf \_\-rvc} ()\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
 
@@ -58 +57 @@
 
 \subsection{Detailed Description}
-Conditional probability density, e.g. modeling some dependencies. 
+Unconditional \doxyref{mpdf}{p.}{classmpdf}, allows using \doxyref{epdf}{p.}{classepdf} in the role of \doxyref{mpdf}{p.}{classmpdf}. 
+
+WARNING: the class does not check validity of the {\tt ep} pointer nor its existence. 
 
 \subsection{Member Function Documentation}
-\index{mpdf@{mpdf}!samplecond@{samplecond}}
-\index{samplecond@{samplecond}!mpdf@{mpdf}}
-\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classmpdf_b0193a350c97933ddf15b15a130da352}
+\index{mepdf@{mepdf}!samplecond@{samplecond}}
+\index{samplecond@{samplecond}!mepdf@{mepdf}}
+\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}
 
 
@@ -77 +78 @@
 Reimplemented in {\bf mlnorm$<$ sq\_\-T $>$} \doxyref{}{p.}{classmlnorm_decf3e3b5c8e0812e5b4dbe94fa2ae18}, and {\bf mgamma} \doxyref{}{p.}{classmgamma_9f40dc43885085fad8e3d6652b79e139}.
 
-References condition(), ep, epdf::evalpdflog(), and epdf::sample().
+References mpdf::condition(), mpdf::ep, epdf::evalpdflog(), and epdf::sample().
 
-Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().
+Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\index{mepdf@{mepdf}!samplecond@{samplecond}}
+\index{samplecond@{samplecond}!mepdf@{mepdf}}
+\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}
+
+
+Returns N samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
+\end{Desc}
+
+
+Reimplemented in {\bf mlnorm$<$ sq\_\-T $>$} \doxyref{}{p.}{classmlnorm_215fb88cc8b95d64cdefd6849abdd1e8}, and {\bf mgamma} \doxyref{}{p.}{classmgamma_e9d52749793f40aad85b70c6db4435ae}.
+
+References mpdf::condition(), RV::count(), mpdf::ep, epdf::evalpdflog(), mpdf::rv, and epdf::sample().
 
 The documentation for this class was generated from the following file:\begin{CompactItemize}