root/doc/latex/classbdm_1_1mmix.tex @ 271

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

Next major revision

Line 
1\hypertarget{classbdm_1_1mmix}{
2\section{bdm::mmix Class Reference}
3\label{classbdm_1_1mmix}\index{bdm::mmix@{bdm::mmix}}
4}
5{\tt \#include $<$emix.h$>$}
6
7Inheritance diagram for bdm::mmix::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=3cm]{classbdm_1_1mmix}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Mixture of mpdfs with constant weights, all mpdfs are of equal type.
17
18\subsection*{Public Member Functions}
19\begin{CompactItemize}
20\item 
21\hypertarget{classbdm_1_1mmix_a0cf51b7daeb6751103e94e6b96213fb}{
22\hyperlink{classbdm_1_1mmix_a0cf51b7daeb6751103e94e6b96213fb}{mmix} ()}
23\label{classbdm_1_1mmix_a0cf51b7daeb6751103e94e6b96213fb}
24
25\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
26\hypertarget{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}{
27void \hyperlink{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}{set\_\-parameters} (const vec \&w, const Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \&\hyperlink{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{Coms})}
28\label{classbdm_1_1mmix_ad8d9df36cb0ca093a29af0eca12da32}
29
30\begin{CompactList}\small\item\em Set weights {\tt w} and components {\tt R}. \item\end{CompactList}\item 
31\hypertarget{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}{
32void \hyperlink{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}{condition} (const vec \&cond)}
33\label{classbdm_1_1mmix_0a5241ecc9911e816b00b92d5c7c8df0}
34
35\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}\end{CompactItemize}
36\begin{Indent}{\bf Matematical operations}\par
37\begin{CompactItemize}
38\item 
39virtual vec \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{samplecond} (const vec \&cond)
40\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
41virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
42\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
43\hypertarget{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{
44virtual double \hyperlink{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{evallogcond} (const vec \&dt, const vec \&cond)}
45\label{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}
46
47\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 
48\hypertarget{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{
49virtual vec \hyperlink{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
50\label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
51
52\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\end{CompactItemize}
53\end{Indent}
54\begin{Indent}{\bf Access to attributes}\par
55\begin{CompactItemize}
56\item 
57\hypertarget{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}{
58\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rv} ()}
59\label{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}
60
61\item 
62\hypertarget{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}{
63\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rvc} ()}
64\label{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}
65
66\item 
67\hypertarget{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}{
68int \textbf{dimension} ()}
69\label{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}
70
71\item 
72\hypertarget{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}{
73int \textbf{dimensionc} ()}
74\label{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}
75
76\item 
77\hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
78\hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} ()}
79\label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
80
81\item 
82\hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
83\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} ()}
84\label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
85
86\end{CompactItemize}
87\end{Indent}
88\begin{Indent}{\bf Connection to other objects}\par
89\begin{CompactItemize}
90\item 
91\hypertarget{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}{
92void \textbf{set\_\-rvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rvc0)}
93\label{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}
94
95\item 
96\hypertarget{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}{
97void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
98\label{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}
99
100\item 
101\hypertarget{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}{
102bool \textbf{isnamed} ()}
103\label{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}
104
105\end{CompactItemize}
106\end{Indent}
107\subsection*{Protected Attributes}
108\begin{CompactItemize}
109\item 
110\hypertarget{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{
111Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \hyperlink{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}{Coms}}
112\label{classbdm_1_1mmix_52e0bcc70d5b26babeba08097579da9c}
113
114\begin{CompactList}\small\item\em Component (epdfs). \item\end{CompactList}\item 
115\hypertarget{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}{
116\hyperlink{classbdm_1_1emix}{emix} \hyperlink{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}{Epdf}}
117\label{classbdm_1_1mmix_0c4dd6ca6556ddd8ae3c5f3257c04b60}
118
119\begin{CompactList}\small\item\em Internal \hyperlink{classbdm_1_1epdf}{epdf}. \item\end{CompactList}\item 
120\hypertarget{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
121int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
122\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
123
124\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
125\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
126\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
127\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
128
129\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
130\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
131\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
132\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
133
134\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
135
136
137\subsection{Member Function Documentation}
138\hypertarget{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{
139\index{bdm::mmix@{bdm::mmix}!samplecond@{samplecond}}
140\index{samplecond@{samplecond}!bdm::mmix@{bdm::mmix}}
141\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{]}}}}
142\label{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}
143
144
145Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
146
147\begin{Desc}
148\item[Parameters:]
149\begin{description}
150\item[{\em cond}]is numeric value of {\tt rv} \end{description}
151\end{Desc}
152
153
154Reimplemented in \hyperlink{classbdm_1_1mprod_ee715a8013acf9892f6cb489db595555}{bdm::mprod}.
155
156References bdm::mpdf::condition(), bdm::mpdf::ep, and bdm::epdf::sample().
157
158Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
159\index{bdm::mmix@{bdm::mmix}!samplecond\_\-m@{samplecond\_\-m}}
160\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mmix@{bdm::mmix}}
161\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{]}}}}
162\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
163
164
165Returns.
166
167\begin{Desc}
168\item[Parameters:]
169\begin{description}
170\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}
171\end{Desc}
172
173
174References bdm::mpdf::condition(), bdm::epdf::dimension(), bdm::mpdf::ep, and bdm::epdf::sample().
175
176The documentation for this class was generated from the following file:\begin{CompactItemize}
177\item 
178\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.