root/doc/latex/classmmix.tex @ 199

Revision 181, 7.3 kB (checked in by smidl, 17 years ago)

Regenerated doc

Line 
1\hypertarget{classmmix}{
2\section{mmix Class Reference}
3\label{classmmix}\index{mmix@{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 mmix:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=43pt]{classmmix__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for mmix:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=70pt]{classmmix__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classmmix_6769a962f1f4d0ecc5b903b5f7d26ad3}{
28\hyperlink{classmmix_6769a962f1f4d0ecc5b903b5f7d26ad3}{mmix} (\hyperlink{classRV}{RV} \&\hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}, \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc})}
29\label{classmmix_6769a962f1f4d0ecc5b903b5f7d26ad3}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classmmix_e7681490a5c5b2d0a43f4e5842e10a9d}{
33void \hyperlink{classmmix_e7681490a5c5b2d0a43f4e5842e10a9d}{set\_\-parameters} (const vec \&w, const Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \&\hyperlink{classmmix_460632c7a0afd41b7840902181a7d85f}{Coms})}
34\label{classmmix_e7681490a5c5b2d0a43f4e5842e10a9d}
35
36\begin{CompactList}\small\item\em Set weights {\tt w} and components {\tt R}. \item\end{CompactList}\item 
37\hypertarget{classmmix_1a66629ec5c2b6f4740606cf737f0193}{
38void \hyperlink{classmmix_1a66629ec5c2b6f4740606cf737f0193}{condition} (const vec \&cond)}
39\label{classmmix_1a66629ec5c2b6f4740606cf737f0193}
40
41\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 
42virtual vec \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{samplecond} (const vec \&cond, double \&ll)
43\begin{CompactList}\small\item\em Returns the required moment of the \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
44virtual mat \hyperlink{classmpdf_0e37163660f93df2a4d723cedb1da89c}{samplecond} (const vec \&cond, vec \&ll, int N)
45\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
46\hypertarget{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{
47virtual double \hyperlink{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{evalcond} (const vec \&dt, const vec \&cond)}
48\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}
49
50\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 
51\hypertarget{classmpdf_ec9c850305984582548e8deb64f0ffe8}{
52\hyperlink{classRV}{RV} \hyperlink{classmpdf_ec9c850305984582548e8deb64f0ffe8}{\_\-rvc} ()}
53\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{
57\hyperlink{classRV}{RV} \hyperlink{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{\_\-rv} ()}
58\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
62\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
63\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
66\subsection*{Protected Attributes}
67\begin{CompactItemize}
68\item 
69\hypertarget{classmmix_460632c7a0afd41b7840902181a7d85f}{
70Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \hyperlink{classmmix_460632c7a0afd41b7840902181a7d85f}{Coms}}
71\label{classmmix_460632c7a0afd41b7840902181a7d85f}
72
73\begin{CompactList}\small\item\em Component (epdfs). \item\end{CompactList}\item 
74\hypertarget{classmmix_507a5e6df53e6e9a6a330f1271cf0914}{
75\hyperlink{classemix}{emix} \hyperlink{classmmix_507a5e6df53e6e9a6a330f1271cf0914}{Epdf}}
76\label{classmmix_507a5e6df53e6e9a6a330f1271cf0914}
77
78\begin{CompactList}\small\item\em Internal \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
79\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
80\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
81\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
82
83\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
84\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
85\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
86\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
87
88\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
89\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
90\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
91\label{classmpdf_7aa894208a32f3487827df6d5054424c}
92
93\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
94
95
96\subsection{Detailed Description}
97Mixture of mpdfs with constant weights, all mpdfs are of equal type.
98
99
100
101\subsection{Member Function Documentation}
102\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
103\index{mmix@{mmix}!samplecond@{samplecond}}
104\index{samplecond@{samplecond}!mmix@{mmix}}
105\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{]}}}}
106\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
107
108
109Returns the required moment of the \hyperlink{classepdf}{epdf}.
110
111Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
112\item[Parameters:]
113\begin{description}
114\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
115\end{Desc}
116
117
118Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}, and \hyperlink{classmlnorm_1bd939dbf8ec7b8066d3f18abba6822b}{mlnorm$<$ sq\_\-T $>$}.
119
120References mpdf::condition(), mpdf::ep, epdf::evalpdflog(), and epdf::sample().
121
122Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_0e37163660f93df2a4d723cedb1da89c}{
123\index{mmix@{mmix}!samplecond@{samplecond}}
124\index{samplecond@{samplecond}!mmix@{mmix}}
125\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{]}}}}
126\label{classmpdf_0e37163660f93df2a4d723cedb1da89c}
127
128
129Returns.
130
131\begin{Desc}
132\item[Parameters:]
133\begin{description}
134\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}
135\end{Desc}
136
137
138Reimplemented in \hyperlink{classmprod_e171c40e210539c2af01d6237785620b}{mprod}, and \hyperlink{classmlnorm_06a3600a414b4b0f006ce9440f462817}{mlnorm$<$ sq\_\-T $>$}.
139
140References mpdf::condition(), RV::count(), mpdf::ep, epdf::evalpdflog(), mpdf::rv, and epdf::sample().
141
142The documentation for this class was generated from the following file:\begin{CompactItemize}
143\item 
144work/git/mixpp/bdm/stat/\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.