root/doc/latex/classbdm_1_1mlnorm.tex @ 271

Revision 271, 10.4 kB (checked in by smidl, 16 years ago)

Next major revision

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