root/doc/latex/classegiw.tex @ 162

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

opravy a dokumentace

  • Property svn:eol-style set to native
Line 
1\section{egiw Class Reference}
2\label{classegiw}\index{egiw@{egiw}}
3Gauss-inverse-Wishart density stored in LD form. 
4
5
6{\tt \#include $<$libEF.h$>$}
7
8Inheritance diagram for egiw:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=40pt]{classegiw__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for egiw:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=69pt]{classegiw__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf egiw} ({\bf RV} {\bf rv}, mat V0, double nu0)\label{classegiw_c52a2173c6eb1490edce9c6c7c05d60b}
26
27\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
28vec {\bf sample} () const
29\begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item 
30vec {\bf mean} () const \label{classegiw_6deb0ff2859f41ef7cbdf6a842cabb29}
31
32\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
33double {\bf evalpdflog} (const vec \&val) const \label{classegiw_425cbc53b377274e28c6add942bab62d}
34
35\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
36double {\bf lognc} () const \label{classegiw_70eb1a0b88459b227f919b425b0d3359}
37
38\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
39{\bf ldmat} \& {\bf \_\-V} ()\label{classegiw_533e792e1175bfa06d5d595dc5d080d5}
40
41\begin{CompactList}\small\item\em returns a pointer to the internal statistics. Use with Care! \item\end{CompactList}\item 
42double \& {\bf \_\-nu} ()\label{classegiw_08029c481ff95d24f093df0573879afe}
43
44\begin{CompactList}\small\item\em returns a pointer to the internal statistics. Use with Care! \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 {\bf 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 mat {\bf sampleN} (int N) const \label{classepdf_54d7dd53a641b618771cd9bee135181f}
52
53\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
54virtual double {\bf eval} (const vec \&val) const \label{classepdf_3ea597362e11a0040fe7c990269d072c}
55
56\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
57{\bf RV} \& {\bf \_\-rv} ()\label{classepdf_4778ea61ef400813e47750e024e9fc2f}
58
59\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\end{CompactItemize}
60\subsection*{Protected Attributes}
61\begin{CompactItemize}
62\item 
63{\bf ldmat} {\bf V}\label{classegiw_f343d03ede89db820edf44a6297fa442}
64
65\begin{CompactList}\small\item\em Extended information matrix of sufficient statistics. \item\end{CompactList}\item 
66double {\bf nu}\label{classegiw_4a2f130b91afe84f6d62fed289d5d453}
67
68\begin{CompactList}\small\item\em Number of data records (degrees of freedom) of sufficient statistics. \item\end{CompactList}\item 
69{\bf RV} {\bf rv}\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
70
71\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
72
73
74\subsection{Detailed Description}
75Gauss-inverse-Wishart density stored in LD form.
76
77More?...
78
79\subsection{Member Function Documentation}
80\index{egiw@{egiw}!sample@{sample}}
81\index{sample@{sample}!egiw@{egiw}}
82\subsubsection[sample]{\setlength{\rightskip}{0pt plus 5cm}vec egiw::sample () const\hspace{0.3cm}{\tt  [virtual]}}\label{classegiw_3d2c1f2ba0f9966781f1e0ae695e8a6f}
83
84
85Returns the required moment of the \doxyref{epdf}{p.}{classepdf}.
86
87Returns a sample, $x$ from density $epdf(rv)$ 
88
89Implements {\bf epdf} \doxyref{}{p.}{classepdf_8019654e494bf5e458f6fb947e11b262}.
90
91The documentation for this class was generated from the following files:\begin{CompactItemize}
92\item 
93work/git/mixpp/bdm/stat/{\bf libEF.h}\item 
94work/git/mixpp/bdm/stat/libEF.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.