root/doc/latex/classeEF.tex @ 167

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

opravy a dokumentace

  • Property svn:eol-style set to native
Line 
1\section{eEF Class Reference}
2\label{classeEF}\index{eEF@{eEF}}
3General conjugate exponential family posterior density. 
4
5
6{\tt \#include $<$libEF.h$>$}
7
8Inheritance diagram for eEF:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=400pt]{classeEF__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for eEF:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=39pt]{classeEF__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf eEF} (const {\bf RV} \&{\bf rv})\label{classeEF_7e3c63655e8375c76bf1f421245427a7}
26
27\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
28virtual double {\bf lognc} () const =0\label{classeEF_69e5680dac10375d62520d26c672477d}
29
30\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
31virtual void {\bf tupdate} (double phi, mat \&vbar, double nubar)\label{classeEF_fd88bc35550ec8fe9281d358216d0fcf}
32
33\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
34virtual void {\bf dupdate} (mat \&v, double nu=1.0)\label{classeEF_5863718c3b2fb1496dece10c5b745d5c}
35
36\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
37virtual vec {\bf sample} () const =0
38\begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item 
39virtual mat {\bf sampleN} (int N) const \label{classepdf_54d7dd53a641b618771cd9bee135181f}
40
41\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
42virtual double {\bf eval} (const vec \&val) const \label{classepdf_3ea597362e11a0040fe7c990269d072c}
43
44\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
45virtual double {\bf evalpdflog} (const vec \&val) const =0\label{classepdf_6aef3eca74899692503769c18add1a4c}
46
47\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
48virtual vec {\bf mean} () const =0\label{classepdf_bf0a070a8f3e67a93604ca724638b870}
49
50\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
51{\bf RV} \& {\bf \_\-rv} ()\label{classepdf_4778ea61ef400813e47750e024e9fc2f}
52
53\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\end{CompactItemize}
54\subsection*{Protected Attributes}
55\begin{CompactItemize}
56\item 
57{\bf RV} {\bf rv}\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
58
59\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
60
61
62\subsection{Detailed Description}
63General conjugate exponential family posterior density.
64
65More?...
66
67\subsection{Member Function Documentation}
68\index{eEF@{eEF}!sample@{sample}}
69\index{sample@{sample}!eEF@{eEF}}
70\subsubsection[sample]{\setlength{\rightskip}{0pt plus 5cm}virtual vec epdf::sample () const\hspace{0.3cm}{\tt  [pure virtual, inherited]}}\label{classepdf_8019654e494bf5e458f6fb947e11b262}
71
72
73Returns the required moment of the \doxyref{epdf}{p.}{classepdf}.
74
75Returns a sample, $x$ from density $epdf(rv)$ 
76
77Implemented in {\bf emix} \doxyref{}{p.}{classemix_0650601f24e633e0ab09aa1e46c14483}, {\bf enorm$<$ sq\_\-T $>$} \doxyref{}{p.}{classenorm_60b47544f6181ffd4530d3e415ce12c5}, {\bf egiw} \doxyref{}{p.}{classegiw_3d2c1f2ba0f9966781f1e0ae695e8a6f}, {\bf egamma} \doxyref{}{p.}{classegamma_8e10c0021b5dfdd9cb62c6959b5ef425}, {\bf euni} \doxyref{}{p.}{classeuni_4a0e09392be17beaee120ba98fc038cd}, {\bf eEmp} \doxyref{}{p.}{classeEmp_83f9283f92b805508d896479dc1ccf12}, {\bf enorm$<$ ldmat $>$} \doxyref{}{p.}{classenorm_60b47544f6181ffd4530d3e415ce12c5}, {\bf enorm$<$ chmat $>$} \doxyref{}{p.}{classenorm_60b47544f6181ffd4530d3e415ce12c5}, and {\bf enorm$<$ fsqmat $>$} \doxyref{}{p.}{classenorm_60b47544f6181ffd4530d3e415ce12c5}.
78
79Referenced by mpdf::samplecond(), PF::set\_\-est(), and eEmp::set\_\-parameters().
80
81The documentation for this class was generated from the following file:\begin{CompactItemize}
82\item 
83work/git/mixpp/bdm/stat/{\bf libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.