root/doc/latex/classmlnorm.tex @ 178

Revision 172, 7.7 kB (checked in by smidl, 16 years ago)

Latex doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classmlnorm}{
2\section{mlnorm$<$ sq\_\-T $>$ Class Template Reference}
3\label{classmlnorm}\index{mlnorm@{mlnorm}}
4}
5Normal distributed linear function with linear function of mean value;. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for mlnorm$<$ sq\_\-T $>$:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=66pt]{classmlnorm__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for mlnorm$<$ sq\_\-T $>$:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=68pt]{classmlnorm__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classmlnorm_f927203b3f31171c5c10ffc7caa797f5}{
28\hyperlink{classmlnorm_f927203b3f31171c5c10ffc7caa797f5}{mlnorm} (\hyperlink{classRV}{RV} \&\hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}, \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc})}
29\label{classmlnorm_f927203b3f31171c5c10ffc7caa797f5}
30
31\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
32\hypertarget{classmlnorm_b6749030c5d5abcb3eb6898f74cea3c0}{
33void \hyperlink{classmlnorm_b6749030c5d5abcb3eb6898f74cea3c0}{set\_\-parameters} (const mat \&A, const sq\_\-T \&R)}
34\label{classmlnorm_b6749030c5d5abcb3eb6898f74cea3c0}
35
36\begin{CompactList}\small\item\em Set {\tt A} and {\tt R}. \item\end{CompactList}\item 
37\hypertarget{classmlnorm_decf3e3b5c8e0812e5b4dbe94fa2ae18}{
38vec \hyperlink{classmlnorm_decf3e3b5c8e0812e5b4dbe94fa2ae18}{samplecond} (vec \&cond, double \&lik)}
39\label{classmlnorm_decf3e3b5c8e0812e5b4dbe94fa2ae18}
40
41\begin{CompactList}\small\item\em Generate one sample of the posterior. \item\end{CompactList}\item 
42\hypertarget{classmlnorm_215fb88cc8b95d64cdefd6849abdd1e8}{
43mat \hyperlink{classmlnorm_215fb88cc8b95d64cdefd6849abdd1e8}{samplecond} (vec \&cond, vec \&lik, int n)}
44\label{classmlnorm_215fb88cc8b95d64cdefd6849abdd1e8}
45
46\begin{CompactList}\small\item\em Generate matrix of samples of the posterior. \item\end{CompactList}\item 
47\hypertarget{classmlnorm_5232fc7e305eceab4e2bd6a8daa44195}{
48void \hyperlink{classmlnorm_5232fc7e305eceab4e2bd6a8daa44195}{condition} (vec \&cond)}
49\label{classmlnorm_5232fc7e305eceab4e2bd6a8daa44195}
50
51\begin{CompactList}\small\item\em Set value of {\tt rvc} . Result of this operation is stored in {\tt \hyperlink{classepdf}{epdf}} use function {\tt \_\-ep} to access it. \item\end{CompactList}\item 
52virtual vec \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{samplecond} (const vec \&cond, double \&ll)
53\begin{CompactList}\small\item\em Returns the required moment of the \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
54virtual mat \hyperlink{classmpdf_0e37163660f93df2a4d723cedb1da89c}{samplecond} (const vec \&cond, vec \&ll, int N)
55\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
56\hypertarget{classmpdf_0f95a0cc6ab40611f46804682446ed83}{
57virtual void \hyperlink{classmpdf_0f95a0cc6ab40611f46804682446ed83}{condition} (const vec \&cond)}
58\label{classmpdf_0f95a0cc6ab40611f46804682446ed83}
59
60\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 
61\hypertarget{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{
62virtual double \hyperlink{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{evalcond} (const vec \&dt, const vec \&cond)}
63\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}
64
65\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 
66\hypertarget{classmpdf_ec9c850305984582548e8deb64f0ffe8}{
67\hyperlink{classRV}{RV} \hyperlink{classmpdf_ec9c850305984582548e8deb64f0ffe8}{\_\-rvc} ()}
68\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
71\hypertarget{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{
72\hyperlink{classRV}{RV} \hyperlink{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{\_\-rv} ()}
73\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}
74
75\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
76\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
77\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
78\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
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{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
85\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
86\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
87
88\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
89\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
90\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
91\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
92
93\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
94\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
95\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
96\label{classmpdf_7aa894208a32f3487827df6d5054424c}
97
98\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
99
100
101\subsection{Detailed Description}
102\subsubsection*{template$<$class sq\_\-T$>$ class mlnorm$<$ sq\_\-T $>$}
103
104Normal distributed linear function with linear function of mean value;.
105
106Mean value $mu=A*rvc$.
107
108\subsection{Member Function Documentation}
109\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
110\index{mlnorm@{mlnorm}!samplecond@{samplecond}}
111\index{samplecond@{samplecond}!mlnorm@{mlnorm}}
112\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{]}}}}
113\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
114
115
116Returns the required moment of the \hyperlink{classepdf}{epdf}.
117
118Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
119\item[Parameters:]
120\begin{description}
121\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
122\end{Desc}
123
124
125Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}.
126
127References mpdf::condition(), mpdf::ep, epdf::evalpdflog(), and epdf::sample().
128
129Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_0e37163660f93df2a4d723cedb1da89c}{
130\index{mlnorm@{mlnorm}!samplecond@{samplecond}}
131\index{samplecond@{samplecond}!mlnorm@{mlnorm}}
132\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
133\label{classmpdf_0e37163660f93df2a4d723cedb1da89c}
134
135
136Returns.
137
138\begin{Desc}
139\item[Parameters:]
140\begin{description}
141\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}
142\end{Desc}
143
144
145Reimplemented in \hyperlink{classmprod_e171c40e210539c2af01d6237785620b}{mprod}.
146
147References mpdf::condition(), RV::count(), mpdf::ep, epdf::evalpdflog(), mpdf::rv, and epdf::sample().
148
149The documentation for this class was generated from the following file:\begin{CompactItemize}
150\item 
151work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.