root/doc/latex/classegamma.tex @ 91

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

drobnosti a dokumentace

  • Property svn:eol-style set to native
Line 
1\section{egamma Class Reference}
2\label{classegamma}\index{egamma@{egamma}}
3Gamma posterior density. 
4
5
6{\tt \#include $<$libEF.h$>$}
7
8Inheritance diagram for egamma:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=49pt]{classegamma__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for egamma:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=49pt]{classegamma__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf egamma} (const {\bf RV} \&{\bf rv})\label{classegamma_4b1d34f3b244ea51a58ec10c468788c1}
26
27\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
28void {\bf set\_\-parameters} (const vec \&a, const vec \&b)\label{classegamma_8e348b89be82b70471fe8c5630f61339}
29
30\begin{CompactList}\small\item\em Sets parameters. \item\end{CompactList}\item 
31vec {\bf sample} () const
32\begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item 
33mat {\bf sample} (int N) const \label{classegamma_13ae455ec9621b99ca2eb4850f586b45}
34
35\begin{CompactList}\small\item\em TODO: is it used anywhere? \item\end{CompactList}\item 
36double {\bf evalpdflog} (const vec \&val) const \label{classegamma_de84faac8f9799dfe2777ddbedf997ef}
37
38\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
39void {\bf \_\-param} (vec $\ast$\&a, vec $\ast$\&b)\label{classegamma_44445c56e60b91b377f207f8d5089790}
40
41\begin{CompactList}\small\item\em Returns poiter to alpha and beta. Potentially dengerous: use with care! \item\end{CompactList}\item 
42vec {\bf mean} () const \label{classegamma_6ab5ba56f7cdb2e5921c3e77524fa50a}
43
44\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
45virtual void {\bf tupdate} (double phi, mat \&vbar, double nubar)\label{classeEF_fd88bc35550ec8fe9281d358216d0fcf}
46
47\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
48virtual void {\bf dupdate} (mat \&v, double nu=1.0)\label{classeEF_5863718c3b2fb1496dece10c5b745d5c}
49
50\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
51virtual double {\bf eval} (const vec \&val) const \label{classepdf_3ea597362e11a0040fe7c990269d072c}
52
53\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
54{\bf RV} {\bf \_\-rv} () const \label{classepdf_b89143f12c9b49282e30841e4fb5f337}
55
56\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
57\subsection*{Protected Attributes}
58\begin{CompactItemize}
59\item 
60vec {\bf alpha}\label{classegamma_376cebd8932546c440f21b182910b01b}
61
62\begin{CompactList}\small\item\em Vector $\alpha$. \item\end{CompactList}\item 
63vec {\bf beta}\label{classegamma_cfc5f136467488a421ab22f886323790}
64
65\begin{CompactList}\small\item\em Vector $\beta$. \item\end{CompactList}\item 
66{\bf RV} {\bf rv}\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
67
68\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
69
70
71\subsection{Detailed Description}
72Gamma posterior density.
73
74Multvariate Gamma density as product of independent univariate densities. \[ f(x|\alpha,\beta) = \prod f(x_i|\alpha_i,\beta_i) \] 
75
76\subsection{Member Function Documentation}
77\index{egamma@{egamma}!sample@{sample}}
78\index{sample@{sample}!egamma@{egamma}}
79\subsubsection{\setlength{\rightskip}{0pt plus 5cm}vec egamma::sample () const\hspace{0.3cm}{\tt  [virtual]}}\label{classegamma_8e10c0021b5dfdd9cb62c6959b5ef425}
80
81
82Returns the required moment of the \doxyref{epdf}{p.}{classepdf}.
83
84Returns a sample from the density, $x \sim epdf(rv)$ 
85
86Implements {\bf epdf} \doxyref{}{p.}{classepdf_8019654e494bf5e458f6fb947e11b262}.
87
88References alpha, beta, RV::count(), epdf::rv, and itpp::Gamma\_\-RNG::setup().
89
90The documentation for this class was generated from the following files:\begin{CompactItemize}
91\item 
92work/mixpp/bdm/stat/{\bf libEF.h}\item 
93work/mixpp/bdm/stat/libEF.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.