root/doc/latex/classbdm_1_1mlnorm.tex @ 270

Revision 270, 9.7 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

Line 
1\hypertarget{classbdm_1_1mlnorm}{
2\section{bdm::mlnorm$<$ sq\_\-T $>$ Class Template Reference}
3\label{classbdm_1_1mlnorm}\index{bdm::mlnorm@{bdm::mlnorm}}
4}
5{\tt \#include $<$libEF.h$>$}
6
7Inheritance diagram for bdm::mlnorm$<$ sq\_\-T $>$:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=164pt]{classbdm_1_1mlnorm__inherit__graph}
12\end{center}
13\end{figure}
14
15
16\subsection{Detailed Description}
17\subsubsection*{template$<$class sq\_\-T$>$ class bdm::mlnorm$<$ sq\_\-T $>$}
18
19Normal distributed linear function with linear function of mean value;.
20
21Mean value $mu=A*rvc+mu_0$. \subsection*{Public Member Functions}
22\begin{CompactItemize}
23\item 
24\hypertarget{classbdm_1_1mlnorm_2dcc06a3dd71f038efbe14dc34d937ae}{
25\hyperlink{classbdm_1_1mlnorm_2dcc06a3dd71f038efbe14dc34d937ae}{mlnorm} ()}
26\label{classbdm_1_1mlnorm_2dcc06a3dd71f038efbe14dc34d937ae}
27
28\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1mlnorm_5d18dec3167584338a4775c1d165d96f}{
30void \hyperlink{classbdm_1_1mlnorm_5d18dec3167584338a4775c1d165d96f}{set\_\-parameters} (const mat \&A, const vec \&mu0, const sq\_\-T \&R)}
31\label{classbdm_1_1mlnorm_5d18dec3167584338a4775c1d165d96f}
32
33\begin{CompactList}\small\item\em Set {\tt A} and {\tt R}. \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1mlnorm_0dafc0196e7e07fd06dc6716e0e18bc2}{
35void \hyperlink{classbdm_1_1mlnorm_0dafc0196e7e07fd06dc6716e0e18bc2}{condition} (const vec \&cond)}
36\label{classbdm_1_1mlnorm_0dafc0196e7e07fd06dc6716e0e18bc2}
37
38\begin{CompactList}\small\item\em Set value of {\tt rvc} . Result of this operation is stored in {\tt \hyperlink{classbdm_1_1epdf}{epdf}} use function {\tt \_\-ep} to access it. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1mlnorm_56e587952f94fcac6cfc999eae6dbced}{
40vec \& \hyperlink{classbdm_1_1mlnorm_56e587952f94fcac6cfc999eae6dbced}{\_\-mu\_\-const} ()}
41\label{classbdm_1_1mlnorm_56e587952f94fcac6cfc999eae6dbced}
42
43\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
44\hypertarget{classbdm_1_1mlnorm_262a2a486bff585f34bb6a5005b02614}{
45mat \& \hyperlink{classbdm_1_1mlnorm_262a2a486bff585f34bb6a5005b02614}{\_\-A} ()}
46\label{classbdm_1_1mlnorm_262a2a486bff585f34bb6a5005b02614}
47
48\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
49\hypertarget{classbdm_1_1mlnorm_78120ecd1c2b1d7e80124b4603504604}{
50mat \hyperlink{classbdm_1_1mlnorm_78120ecd1c2b1d7e80124b4603504604}{\_\-R} ()}
51\label{classbdm_1_1mlnorm_78120ecd1c2b1d7e80124b4603504604}
52
53\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
54\begin{Indent}{\bf Matematical operations}\par
55\begin{CompactItemize}
56\item 
57virtual vec \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{samplecond} (const vec \&cond)
58\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
59virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
60\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
61\hypertarget{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{
62virtual double \hyperlink{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{evallogcond} (const vec \&dt, const vec \&cond)}
63\label{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}
64
65\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \hyperlink{classbdm_1_1epdf}{epdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item 
66\hypertarget{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{
67virtual vec \hyperlink{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
68\label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
69
70\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\end{CompactItemize}
71\end{Indent}
72\begin{Indent}{\bf Access to attributes}\par
73\begin{CompactItemize}
74\item 
75\hypertarget{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}{
76\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rv} ()}
77\label{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}
78
79\item 
80\hypertarget{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}{
81\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rvc} ()}
82\label{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}
83
84\item 
85\hypertarget{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}{
86int \textbf{dimension} ()}
87\label{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}
88
89\item 
90\hypertarget{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}{
91int \textbf{dimensionc} ()}
92\label{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}
93
94\item 
95\hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
96\hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} ()}
97\label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
98
99\item 
100\hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
101\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} ()}
102\label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
103
104\end{CompactItemize}
105\end{Indent}
106\begin{Indent}{\bf Connection to other objects}\par
107\begin{CompactItemize}
108\item 
109\hypertarget{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}{
110void \textbf{set\_\-rvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rvc0)}
111\label{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}
112
113\item 
114\hypertarget{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}{
115void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
116\label{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}
117
118\item 
119\hypertarget{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}{
120bool \textbf{isnamed} ()}
121\label{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}
122
123\end{CompactItemize}
124\end{Indent}
125\subsection*{Protected Attributes}
126\begin{CompactItemize}
127\item 
128\hypertarget{classbdm_1_1mlnorm_150ad6acb223b0a0abeaf92346686dcd}{
129\hyperlink{classbdm_1_1enorm}{enorm}$<$ sq\_\-T $>$ \hyperlink{classbdm_1_1mlnorm_150ad6acb223b0a0abeaf92346686dcd}{epdf}}
130\label{classbdm_1_1mlnorm_150ad6acb223b0a0abeaf92346686dcd}
131
132\begin{CompactList}\small\item\em Internal \hyperlink{classbdm_1_1epdf}{epdf} that arise by conditioning on {\tt rvc}. \item\end{CompactList}\item 
133\hypertarget{classbdm_1_1mlnorm_8207ae86d1722102897e139a23e29af8}{
134mat \textbf{A}}
135\label{classbdm_1_1mlnorm_8207ae86d1722102897e139a23e29af8}
136
137\item 
138\hypertarget{classbdm_1_1mlnorm_3a019144d414d1737aea331ffe1c3845}{
139vec \textbf{mu\_\-const}}
140\label{classbdm_1_1mlnorm_3a019144d414d1737aea331ffe1c3845}
141
142\item 
143\hypertarget{classbdm_1_1mlnorm_dea5ea658d5020c11da91275f592244b}{
144vec \& \textbf{\_\-mu}}
145\label{classbdm_1_1mlnorm_dea5ea658d5020c11da91275f592244b}
146
147\item 
148\hypertarget{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
149int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
150\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
151
152\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
153\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
154\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
155\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
156
157\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
158\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
159\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
160\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
161
162\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
163\subsection*{Friends}
164\begin{CompactItemize}
165\item 
166\hypertarget{classbdm_1_1mlnorm_1917009347bb410f73bf827df8767b09}{
167{\footnotesize template$<$class sq\_\-M$>$ }\\std::ostream \& \textbf{operator$<$$<$} (std::ostream \&os, \hyperlink{classbdm_1_1mlnorm}{mlnorm}$<$ sq\_\-M $>$ \&ml)}
168\label{classbdm_1_1mlnorm_1917009347bb410f73bf827df8767b09}
169
170\end{CompactItemize}
171
172
173\subsection{Member Function Documentation}
174\hypertarget{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{
175\index{bdm::mlnorm@{bdm::mlnorm}!samplecond@{samplecond}}
176\index{samplecond@{samplecond}!bdm::mlnorm@{bdm::mlnorm}}
177\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec bdm::mpdf::samplecond (const vec \& {\em cond})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
178\label{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}
179
180
181Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
182
183\begin{Desc}
184\item[Parameters:]
185\begin{description}
186\item[{\em cond}]is numeric value of {\tt rv} \end{description}
187\end{Desc}
188
189
190References bdm::mpdf::condition(), bdm::mpdf::ep, and bdm::epdf::sample().
191
192Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
193\index{bdm::mlnorm@{bdm::mlnorm}!samplecond\_\-m@{samplecond\_\-m}}
194\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mlnorm@{bdm::mlnorm}}
195\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat bdm::mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
196\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
197
198
199Returns.
200
201\begin{Desc}
202\item[Parameters:]
203\begin{description}
204\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}
205\end{Desc}
206
207
208References bdm::mpdf::condition(), bdm::epdf::dimension(), bdm::mpdf::ep, and bdm::epdf::sample().
209
210The documentation for this class was generated from the following file:\begin{CompactItemize}
211\item 
212\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.