root/doc/latex/classmgamma__fix.tex @ 259

Revision 234, 9.3 kB (checked in by smidl, 15 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classmgamma__fix}{
2\section{mgamma\_\-fix Class Reference}
3\label{classmgamma__fix}\index{mgamma\_\-fix@{mgamma\_\-fix}}
4}
5Gamma random walk around a fixed point. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for mgamma\_\-fix:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=58pt]{classmgamma__fix__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for mgamma\_\-fix:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=76pt]{classmgamma__fix__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classmgamma__fix_b92c3d2e5fd0381033a072e5ef3bcf80}{
28\hyperlink{classmgamma__fix_b92c3d2e5fd0381033a072e5ef3bcf80}{mgamma\_\-fix} (const \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}, const \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc})}
29\label{classmgamma__fix_b92c3d2e5fd0381033a072e5ef3bcf80}
30
31\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
32\hypertarget{classmgamma__fix_ec6f846896749e27cb7be9fa48dd1cb1}{
33void \hyperlink{classmgamma__fix_ec6f846896749e27cb7be9fa48dd1cb1}{set\_\-parameters} (double k0, vec ref0, double l0)}
34\label{classmgamma__fix_ec6f846896749e27cb7be9fa48dd1cb1}
35
36\begin{CompactList}\small\item\em Set value of {\tt k}. \item\end{CompactList}\item 
37\hypertarget{classmgamma__fix_6ea3931eec7b7da7b693e45981052460}{
38void \hyperlink{classmgamma__fix_6ea3931eec7b7da7b693e45981052460}{condition} (const vec \&val)}
39\label{classmgamma__fix_6ea3931eec7b7da7b693e45981052460}
40
41\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classmpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
42\hypertarget{classmgamma_a9d646cf758a70126dde7c48790b6e94}{
43void \hyperlink{classmgamma_a9d646cf758a70126dde7c48790b6e94}{set\_\-parameters} (double \hyperlink{classmgamma_43f733cce0245a52363d566099add687}{k})}
44\label{classmgamma_a9d646cf758a70126dde7c48790b6e94}
45
46\begin{CompactList}\small\item\em Set value of {\tt k}. \item\end{CompactList}\item 
47virtual vec \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{samplecond} (const vec \&cond, double \&ll)
48\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
49virtual mat \hyperlink{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}{samplecond\_\-m} (const vec \&cond, vec \&ll, int N)
50\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
51\hypertarget{classmpdf_2ef8a6374029d990a678782f6decebbe}{
52virtual double \hyperlink{classmpdf_2ef8a6374029d990a678782f6decebbe}{evallogcond} (const vec \&dt, const vec \&cond)}
53\label{classmpdf_2ef8a6374029d990a678782f6decebbe}
54
55\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \hyperlink{classepdf}{epdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item 
56\hypertarget{classmpdf_95fcff214848f66f1b489459370573fa}{
57virtual vec \hyperlink{classmpdf_95fcff214848f66f1b489459370573fa}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
58\label{classmpdf_95fcff214848f66f1b489459370573fa}
59
60\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\item 
61\hypertarget{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{
62\hyperlink{classRV}{RV} \hyperlink{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{\_\-rvc} () const }
63\label{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
66\hypertarget{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{
67\hyperlink{classRV}{RV} \hyperlink{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{\_\-rv} () const }
68\label{classmpdf_71256ffb5fbd08f41d650e606a5bd585}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
71\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
72\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
73\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
74
75\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
76\hypertarget{classmpdf_75ded3b0f657cd7da6590691a810963c}{
77\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_75ded3b0f657cd7da6590691a810963c}{\_\-e} ()}
78\label{classmpdf_75ded3b0f657cd7da6590691a810963c}
79
80\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
81\subsection*{Protected Attributes}
82\begin{CompactItemize}
83\item 
84\hypertarget{classmgamma__fix_3f48c09caddc298901ad75fe7c0529f6}{
85double \hyperlink{classmgamma__fix_3f48c09caddc298901ad75fe7c0529f6}{l}}
86\label{classmgamma__fix_3f48c09caddc298901ad75fe7c0529f6}
87
88\begin{CompactList}\small\item\em parameter l \item\end{CompactList}\item 
89\hypertarget{classmgamma__fix_81ce49029ecc385418619b200dcafeb0}{
90vec \hyperlink{classmgamma__fix_81ce49029ecc385418619b200dcafeb0}{refl}}
91\label{classmgamma__fix_81ce49029ecc385418619b200dcafeb0}
92
93\begin{CompactList}\small\item\em reference vector \item\end{CompactList}\item 
94\hypertarget{classmgamma_612dbf35c770a780027619aaac2c443e}{
95\hyperlink{classegamma}{egamma} \hyperlink{classmgamma_612dbf35c770a780027619aaac2c443e}{epdf}}
96\label{classmgamma_612dbf35c770a780027619aaac2c443e}
97
98\begin{CompactList}\small\item\em Internal \hyperlink{classepdf}{epdf} that arise by conditioning on {\tt rvc}. \item\end{CompactList}\item 
99\hypertarget{classmgamma_43f733cce0245a52363d566099add687}{
100double \hyperlink{classmgamma_43f733cce0245a52363d566099add687}{k}}
101\label{classmgamma_43f733cce0245a52363d566099add687}
102
103\begin{CompactList}\small\item\em Constant $k$. \item\end{CompactList}\item 
104\hypertarget{classmgamma_5e90652837448bcc29707e7412f99691}{
105vec $\ast$ \hyperlink{classmgamma_5e90652837448bcc29707e7412f99691}{\_\-beta}}
106\label{classmgamma_5e90652837448bcc29707e7412f99691}
107
108\begin{CompactList}\small\item\em cache of epdf.beta \item\end{CompactList}\item 
109\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
110\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
111\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
112
113\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
114\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
115\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
116\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
117
118\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
119\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
120\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
121\label{classmpdf_7aa894208a32f3487827df6d5054424c}
122
123\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
124
125
126\subsection{Detailed Description}
127Gamma random walk around a fixed point.
128
129Mean value, $\mu$, of this density is given by a geometric combination of {\tt rvc} and given fixed point, $p$. $l$ is the coefficient of the geometric combimation \[ \mu = \mu_{t-1} ^{l} p^{1-l}\]
130
131Standard deviation of the random walk is proportional to one $k$-th the mean. This is achieved by setting $\alpha=k$ and $\beta=k/\mu$.
132
133The standard deviation of the walk is then: $\mu/\sqrt(k)$.
134
135\subsection{Member Function Documentation}
136\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
137\index{mgamma\_\-fix@{mgamma\_\-fix}!samplecond@{samplecond}}
138\index{samplecond@{samplecond}!mgamma_fix@{mgamma\_\-fix}}
139\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
140\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
141
142
143Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
144
145\begin{Desc}
146\item[Parameters:]
147\begin{description}
148\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
149\end{Desc}
150
151
152Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}.
153
154References mpdf::condition(), mpdf::ep, epdf::evallog(), and epdf::sample().
155
156Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}{
157\index{mgamma\_\-fix@{mgamma\_\-fix}!samplecond\_\-m@{samplecond\_\-m}}
158\index{samplecond\_\-m@{samplecond\_\-m}!mgamma_fix@{mgamma\_\-fix}}
159\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
160\label{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}
161
162
163Returns.
164
165\begin{Desc}
166\item[Parameters:]
167\begin{description}
168\item[{\em N}]samples from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
169\end{Desc}
170
171
172References mpdf::condition(), RV::count(), mpdf::ep, epdf::evallog(), mpdf::rv, and epdf::sample().
173
174The documentation for this class was generated from the following file:\begin{CompactItemize}
175\item 
176work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.