root/doc/latex/classbdm_1_1eigamma.tex @ 261

Revision 261, 8.9 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[261]1\hypertarget{classbdm_1_1eigamma}{
2\section{bdm::eigamma Class Reference}
3\label{classbdm_1_1eigamma}\index{bdm::eigamma@{bdm::eigamma}}
4}
5Inverse-Gamma posterior density. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for bdm::eigamma:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=67pt]{classbdm_1_1eigamma__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::eigamma:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=92pt]{classbdm_1_1eigamma__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1eigamma_34a8d2cd08399c3449e2efcda6ea2f89}{
28\hyperlink{classbdm_1_1eigamma_34a8d2cd08399c3449e2efcda6ea2f89}{eigamma} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv})}
29\label{classbdm_1_1eigamma_34a8d2cd08399c3449e2efcda6ea2f89}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1eigamma_09e616c95f31acddf7dfef96d1c5d645}{
33void \hyperlink{classbdm_1_1eigamma_09e616c95f31acddf7dfef96d1c5d645}{set\_\-parameters} (const vec \&a, const vec \&b)}
34\label{classbdm_1_1eigamma_09e616c95f31acddf7dfef96d1c5d645}
35
36\begin{CompactList}\small\item\em Sets parameters. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1eigamma_3aff7bf25ddac27731c60826fcfd878f}{
38vec \hyperlink{classbdm_1_1eigamma_3aff7bf25ddac27731c60826fcfd878f}{sample} () const }
39\label{classbdm_1_1eigamma_3aff7bf25ddac27731c60826fcfd878f}
40
41\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1eigamma_9e26c80c8e6708bfcf2e684958af6f91}{
43double \hyperlink{classbdm_1_1eigamma_9e26c80c8e6708bfcf2e684958af6f91}{evallog} (const vec \&val) const }
44\label{classbdm_1_1eigamma_9e26c80c8e6708bfcf2e684958af6f91}
45
46\begin{CompactList}\small\item\em TODO: is it used anywhere? \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1eigamma_a52ac6d523e2fe05642d1f50fe66aec2}{
48double \hyperlink{classbdm_1_1eigamma_a52ac6d523e2fe05642d1f50fe66aec2}{lognc} () const }
49\label{classbdm_1_1eigamma_a52ac6d523e2fe05642d1f50fe66aec2}
50
51\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1eigamma_57b9ee79ef5d2cea243bbe6b274a2abe}{
53void \hyperlink{classbdm_1_1eigamma_57b9ee79ef5d2cea243bbe6b274a2abe}{\_\-param} (vec $\ast$\&a, vec $\ast$\&b)}
54\label{classbdm_1_1eigamma_57b9ee79ef5d2cea243bbe6b274a2abe}
55
56\begin{CompactList}\small\item\em Returns poiter to alpha and beta. Potentially dangerous: use with care! \item\end{CompactList}\item 
57\hypertarget{classbdm_1_1eigamma_46cecb295edbabd28120cb0f6f572bcb}{
58vec \hyperlink{classbdm_1_1eigamma_46cecb295edbabd28120cb0f6f572bcb}{mean} () const }
59\label{classbdm_1_1eigamma_46cecb295edbabd28120cb0f6f572bcb}
60
61\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1eigamma_c2c696f8c668e9f65392c9449f6a5133}{
63vec \hyperlink{classbdm_1_1eigamma_c2c696f8c668e9f65392c9449f6a5133}{variance} () const }
64\label{classbdm_1_1eigamma_c2c696f8c668e9f65392c9449f6a5133}
65
66\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{
68virtual void \hyperlink{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{dupdate} (mat \&v)}
69\label{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}
70
71\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{
73virtual double \hyperlink{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}{evallog\_\-nn} (const vec \&val) const }
74\label{classbdm_1_1eEF_a4135778ecd9ab774762936c82a097c6}
75
76\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
77\hypertarget{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{
78virtual vec \hyperlink{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{evallog} (const mat \&Val) const }
79\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}
80
81\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
82\hypertarget{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{
83virtual void \hyperlink{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{pow} (double p)}
84\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}
85
86\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\item 
87\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
88virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
89\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
90
91\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
92\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
93virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
94\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
95
96\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
97\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
98virtual \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{condition} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
99\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
100
101\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classbdm_1_1RV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
102\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
103virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{marginal} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
104\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
105
106\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classbdm_1_1RV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
107\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
108const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
109\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
110
111\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
112\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
113void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
114\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
115
116\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
117\subsection*{Protected Attributes}
118\begin{CompactItemize}
119\item 
120\hypertarget{classbdm_1_1eigamma_e2c49c77e04a96a9e6a4a628318ceb73}{
121vec $\ast$ \hyperlink{classbdm_1_1eigamma_e2c49c77e04a96a9e6a4a628318ceb73}{alpha}}
122\label{classbdm_1_1eigamma_e2c49c77e04a96a9e6a4a628318ceb73}
123
124\begin{CompactList}\small\item\em Vector $\alpha$. \item\end{CompactList}\item 
125\hypertarget{classbdm_1_1eigamma_b2c62f2e869d1304a4055f6a7ac59cde}{
126vec $\ast$ \hyperlink{classbdm_1_1eigamma_b2c62f2e869d1304a4055f6a7ac59cde}{beta}}
127\label{classbdm_1_1eigamma_b2c62f2e869d1304a4055f6a7ac59cde}
128
129\begin{CompactList}\small\item\em Vector $\beta$ (in fact it is 1/beta as used in definition of iG). \item\end{CompactList}\item 
130\hypertarget{classbdm_1_1eigamma_3e5c03201f073033a7db894fa15ddb96}{
131\hyperlink{classbdm_1_1egamma}{egamma} \hyperlink{classbdm_1_1eigamma_3e5c03201f073033a7db894fa15ddb96}{eg}}
132\label{classbdm_1_1eigamma_3e5c03201f073033a7db894fa15ddb96}
133
134\begin{CompactList}\small\item\em internal \hyperlink{classbdm_1_1egamma}{egamma} \item\end{CompactList}\item 
135\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
136\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
137\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
138
139\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
140
141
142\subsection{Detailed Description}
143Inverse-Gamma posterior density.
144
145Multivariate inverse-Gamma density as product of independent univariate densities. \[ f(x|\alpha,\beta) = \prod f(x_i|\alpha_i,\beta_i) \]
146
147Inverse Gamma can be converted to Gamma using \[ x\sim iG(a,b) => 1/x\sim G(a,1/b) \] This relation is used in sampling.
148
149The documentation for this class was generated from the following file:\begin{CompactItemize}
150\item 
151\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.