root/doc/latex/classmmix.tex @ 226

Revision 219, 7.4 kB (checked in by smidl, 16 years ago)

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_b1dae6171ee39a6a05976c7b1007a3c5}{samplecond\_\-m} (const vec \&cond, vec \&ll, int N)
45\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
46\hypertarget{classmpdf_2ef8a6374029d990a678782f6decebbe}{
47virtual double \hyperlink{classmpdf_2ef8a6374029d990a678782f6decebbe}{evallogcond} (const vec \&dt, const vec \&cond)}
48\label{classmpdf_2ef8a6374029d990a678782f6decebbe}
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_95fcff214848f66f1b489459370573fa}{
52virtual vec \hyperlink{classmpdf_95fcff214848f66f1b489459370573fa}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
53\label{classmpdf_95fcff214848f66f1b489459370573fa}
54
55\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\item 
56\hypertarget{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{
57\hyperlink{classRV}{RV} \hyperlink{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}{\_\-rvc} () const }
58\label{classmpdf_15ef062183b1ccdf794732d5fa0b77cd}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{
62\hyperlink{classRV}{RV} \hyperlink{classmpdf_71256ffb5fbd08f41d650e606a5bd585}{\_\-rv} () const }
63\label{classmpdf_71256ffb5fbd08f41d650e606a5bd585}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
66\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
67\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
68\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
71\subsection*{Protected Attributes}
72\begin{CompactItemize}
73\item 
74\hypertarget{classmmix_460632c7a0afd41b7840902181a7d85f}{
75Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \hyperlink{classmmix_460632c7a0afd41b7840902181a7d85f}{Coms}}
76\label{classmmix_460632c7a0afd41b7840902181a7d85f}
77
78\begin{CompactList}\small\item\em Component (epdfs). \item\end{CompactList}\item 
79\hypertarget{classmmix_507a5e6df53e6e9a6a330f1271cf0914}{
80\hyperlink{classemix}{emix} \hyperlink{classmmix_507a5e6df53e6e9a6a330f1271cf0914}{Epdf}}
81\label{classmmix_507a5e6df53e6e9a6a330f1271cf0914}
82
83\begin{CompactList}\small\item\em Internal \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
84\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
85\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
86\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
87
88\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
89\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
90\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
91\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
92
93\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
94\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
95\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
96\label{classmpdf_7aa894208a32f3487827df6d5054424c}
97
98\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
99
100
101\subsection{Detailed Description}
102Mixture of mpdfs with constant weights, all mpdfs are of equal type.
103
104
105
106\subsection{Member Function Documentation}
107\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{
108\index{mmix@{mmix}!samplecond@{samplecond}}
109\index{samplecond@{samplecond}!mmix@{mmix}}
110\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{]}}}}
111\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}
112
113
114Returns the required moment of the \hyperlink{classepdf}{epdf}.
115
116Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
117\item[Parameters:]
118\begin{description}
119\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
120\end{Desc}
121
122
123Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}.
124
125References mpdf::condition(), mpdf::ep, epdf::evallog(), and epdf::sample().
126
127Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}{
128\index{mmix@{mmix}!samplecond\_\-m@{samplecond\_\-m}}
129\index{samplecond\_\-m@{samplecond\_\-m}!mmix@{mmix}}
130\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
131\label{classmpdf_b1dae6171ee39a6a05976c7b1007a3c5}
132
133
134Returns.
135
136\begin{Desc}
137\item[Parameters:]
138\begin{description}
139\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}
140\end{Desc}
141
142
143References mpdf::condition(), RV::count(), mpdf::ep, epdf::evallog(), mpdf::rv, and epdf::sample().
144
145The documentation for this class was generated from the following file:\begin{CompactItemize}
146\item 
147work/git/mixpp/bdm/stat/\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.