root/doc/latex/classbdm_1_1mmix.tex @ 261

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

doc

RevLine 
[261]1\hypertarget{classbdm_1_1mmix}{
2\section{bdm::mmix Class Reference}
3\label{classbdm_1_1mmix}\index{bdm::mmix@{bdm::mmix}}
4}
5Mixture of mpdfs with constant weights, all mpdfs are of equal type. 
6
7
8{\tt \#include $<$emix.h$>$}
9
10Inheritance diagram for bdm::mmix:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1mmix__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::mmix:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=98pt]{classbdm_1_1mmix__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1mmix_580a05ae61b179de3fccfcb60f11efd9}{
28\hyperlink{classbdm_1_1mmix_580a05ae61b179de3fccfcb60f11efd9}{mmix} (\hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{rv}, \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc})}
29\label{classbdm_1_1mmix_580a05ae61b179de3fccfcb60f11efd9}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}{
33void \hyperlink{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}{set\_\-parameters} (const vec \&w, const Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \&\hyperlink{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{Coms})}
34\label{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}
35
36\begin{CompactList}\small\item\em Set weights {\tt w} and components {\tt R}. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}{
38void \hyperlink{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}{condition} (const vec \&cond)}
39\label{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}
40
41\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classbdm_1_1mpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
42virtual vec \hyperlink{classbdm_1_1mpdf_e4848a428d8ef0549c6e4a9ed386d9f2}{samplecond} (const vec \&cond, double \&ll)
43\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
44virtual mat \hyperlink{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}{samplecond\_\-m} (const vec \&cond, vec \&ll, int N)
45\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
46\hypertarget{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{
47virtual double \hyperlink{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{evallogcond} (const vec \&dt, const vec \&cond)}
48\label{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}
49
50\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 
51\hypertarget{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{
52virtual vec \hyperlink{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
53\label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
54
55\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\item 
56\hypertarget{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}{
57\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}{\_\-rvc} () const }
58\label{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}{
62\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}{\_\-rv} () const }
63\label{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
66\hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
67\hyperlink{classbdm_1_1epdf}{epdf} \& \hyperlink{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{\_\-epdf} ()}
68\label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
71\hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
72\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{\_\-e} ()}
73\label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
74
75\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
76\subsection*{Protected Attributes}
77\begin{CompactItemize}
78\item 
79\hypertarget{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{
80Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \hyperlink{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{Coms}}
81\label{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}
82
83\begin{CompactList}\small\item\em Component (epdfs). \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}{
85\hyperlink{classbdm_1_1emix}{emix} \hyperlink{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}{Epdf}}
86\label{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}
87
88\begin{CompactList}\small\item\em Internal \hyperlink{classbdm_1_1epdf}{epdf}. \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{
90\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{rv}}
91\label{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}
92
93\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
94\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
95\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
96\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
97
98\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
99\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
100\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
101\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
102
103\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
104
105
106\subsection{Detailed Description}
107Mixture of mpdfs with constant weights, all mpdfs are of equal type.
108
109
110
111\subsection{Member Function Documentation}
112\hypertarget{classbdm_1_1mpdf_e4848a428d8ef0549c6e4a9ed386d9f2}{
113\index{bdm::mmix@{bdm::mmix}!samplecond@{samplecond}}
114\index{samplecond@{samplecond}!bdm::mmix@{bdm::mmix}}
115\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec bdm::mpdf::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
116\label{classbdm_1_1mpdf_e4848a428d8ef0549c6e4a9ed386d9f2}
117
118
119Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
120
121\begin{Desc}
122\item[Parameters:]
123\begin{description}
124\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
125\end{Desc}
126
127
128Reimplemented in \hyperlink{classbdm_1_1mprod_1a37c2aaba8bde7fce5351c39b6e1168}{bdm::mprod}.
129
130References bdm::mpdf::condition(), bdm::mpdf::ep, bdm::epdf::evallog(), and bdm::epdf::sample().
131
132Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}{
133\index{bdm::mmix@{bdm::mmix}!samplecond\_\-m@{samplecond\_\-m}}
134\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mmix@{bdm::mmix}}
135\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat bdm::mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
136\label{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}
137
138
139Returns.
140
141\begin{Desc}
142\item[Parameters:]
143\begin{description}
144\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}
145\end{Desc}
146
147
148References bdm::mpdf::condition(), bdm::RV::count(), bdm::mpdf::ep, bdm::epdf::evallog(), bdm::mpdf::rv, and bdm::epdf::sample().
149
150The documentation for this class was generated from the following file:\begin{CompactItemize}
151\item 
152\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.