root/doc/latex/classbdm_1_1mprod.tex @ 275

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

Next major revision

Line 
1\hypertarget{classbdm_1_1mprod}{
2\section{bdm::mprod Class Reference}
3\label{classbdm_1_1mprod}\index{bdm::mprod@{bdm::mprod}}
4}
5{\tt \#include $<$emix.h$>$}
6
7Inheritance diagram for bdm::mprod::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=3cm]{classbdm_1_1mprod}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Chain rule decomposition of \hyperlink{classbdm_1_1epdf}{epdf}.
17
18Probability density in the form of Chain-rule decomposition: $\backslash$\mbox{[} f(x\_\-1,x\_\-2,x\_\-3) = f(x\_\-1$|$x\_\-2,x\_\-3)f(x\_\-2,x\_\-3)f(x\_\-3) $\backslash$\mbox{]} Note that \subsection*{Public Member Functions}
19\begin{CompactItemize}
20\item 
21\hypertarget{classbdm_1_1mprod_680c3e2d95b116c7cfb227c7f2984525}{
22\hyperlink{classbdm_1_1mprod_680c3e2d95b116c7cfb227c7f2984525}{mprod} (Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ mFacs)}
23\label{classbdm_1_1mprod_680c3e2d95b116c7cfb227c7f2984525}
24
25\begin{CompactList}\small\item\em Constructor from list of mFacs,. \item\end{CompactList}\item 
26\hypertarget{classbdm_1_1mprod_800f21d94c919137608a2fd5c88719e2}{
27double \hyperlink{classbdm_1_1mprod_800f21d94c919137608a2fd5c88719e2}{evallogcond} (const vec \&val, const vec \&cond)}
28\label{classbdm_1_1mprod_800f21d94c919137608a2fd5c88719e2}
29
30\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 
31vec \hyperlink{classbdm_1_1mprod_ee715a8013acf9892f6cb489db595555}{samplecond} (const vec \&cond)
32\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
33\hypertarget{classbdm_1_1mprod_d193dcc89fbc6f21979e0ced6d84568c}{
34mat \textbf{samplecond} (const vec \&cond, int N)}
35\label{classbdm_1_1mprod_d193dcc89fbc6f21979e0ced6d84568c}
36
37\item 
38\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{getrv} (bool checkoverlap=false)
39\begin{CompactList}\small\item\em find common rv, flag \item\end{CompactList}\item 
40\hypertarget{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{
41void \hyperlink{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{setrvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc})}
42\label{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}
43
44\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\end{CompactItemize}
45\begin{Indent}{\bf Matematical operations}\par
46\begin{CompactItemize}
47\item 
48virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
49\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
50\hypertarget{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{
51virtual void \hyperlink{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{condition} (const vec \&cond)}
52\label{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}
53
54\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 
55\hypertarget{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{
56virtual vec \hyperlink{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}{evallogcond\_\-m} (const mat \&Dt, const vec \&cond)}
57\label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
58
59\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\end{CompactItemize}
60\end{Indent}
61\begin{Indent}{\bf Access to attributes}\par
62\begin{CompactItemize}
63\item 
64\hypertarget{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}{
65\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rv} ()}
66\label{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}
67
68\item 
69\hypertarget{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}{
70\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rvc} ()}
71\label{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}
72
73\item 
74\hypertarget{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}{
75int \textbf{dimension} ()}
76\label{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}
77
78\item 
79\hypertarget{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}{
80int \textbf{dimensionc} ()}
81\label{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}
82
83\item 
84\hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
85\hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} ()}
86\label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
87
88\item 
89\hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
90\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} ()}
91\label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
92
93\end{CompactItemize}
94\end{Indent}
95\begin{Indent}{\bf Connection to other objects}\par
96\begin{CompactItemize}
97\item 
98\hypertarget{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}{
99void \textbf{set\_\-rvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rvc0)}
100\label{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}
101
102\item 
103\hypertarget{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}{
104void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
105\label{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}
106
107\item 
108\hypertarget{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}{
109bool \textbf{isnamed} ()}
110\label{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}
111
112\end{CompactItemize}
113\end{Indent}
114\subsection*{Protected Attributes}
115\begin{CompactItemize}
116\item 
117\hypertarget{classbdm_1_1mprod_eca722ed1b219727c6c0f8cbc6bf1e51}{
118Array$<$ \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ $>$ \hyperlink{classbdm_1_1mprod_eca722ed1b219727c6c0f8cbc6bf1e51}{epdfs}}
119\label{classbdm_1_1mprod_eca722ed1b219727c6c0f8cbc6bf1e51}
120
121\begin{CompactList}\small\item\em pointers to epdfs - shortcut to \hyperlink{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{mpdfs()}.posterior() \item\end{CompactList}\item 
122\hypertarget{classbdm_1_1mprod_acf679b3b1d48629c5a042d9ac0d973f}{
123Array$<$ \hyperlink{classbdm_1_1datalink__m2m}{datalink\_\-m2m} $\ast$ $>$ \hyperlink{classbdm_1_1mprod_acf679b3b1d48629c5a042d9ac0d973f}{dls}}
124\label{classbdm_1_1mprod_acf679b3b1d48629c5a042d9ac0d973f}
125
126\begin{CompactList}\small\item\em Data link for each mpdfs. \item\end{CompactList}\item 
127\hypertarget{classbdm_1_1mprod_e3fe66c257e5eca9de1031ef44907677}{
128\hyperlink{classbdm_1_1epdf}{epdf} \hyperlink{classbdm_1_1mprod_e3fe66c257e5eca9de1031ef44907677}{dummy}}
129\label{classbdm_1_1mprod_e3fe66c257e5eca9de1031ef44907677}
130
131\begin{CompactList}\small\item\em dummy ep \item\end{CompactList}\item 
132\hypertarget{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{
133int \hyperlink{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{n}}
134\label{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}
135
136\begin{CompactList}\small\item\em Number of mpdfs in the composite. \item\end{CompactList}\item 
137\hypertarget{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{
138Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \hyperlink{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{mpdfs}}
139\label{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}
140
141\begin{CompactList}\small\item\em Elements of composition. \item\end{CompactList}\item 
142\hypertarget{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
143int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
144\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
145
146\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
147\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
148\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
149\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
150
151\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
152\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
153\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
154\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
155
156\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
157
158
159\subsection{Member Function Documentation}
160\hypertarget{classbdm_1_1mprod_ee715a8013acf9892f6cb489db595555}{
161\index{bdm::mprod@{bdm::mprod}!samplecond@{samplecond}}
162\index{samplecond@{samplecond}!bdm::mprod@{bdm::mprod}}
163\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}vec bdm::mprod::samplecond (const vec \& {\em cond})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
164\label{classbdm_1_1mprod_ee715a8013acf9892f6cb489db595555}
165
166
167Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
168
169\begin{Desc}
170\item[Parameters:]
171\begin{description}
172\item[{\em cond}]is numeric value of {\tt rv} \end{description}
173\end{Desc}
174
175
176Reimplemented from \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{bdm::mpdf}.
177
178References bdm::epdf::dimension(), dls, bdm::mpdf::ep, epdfs, bdm::compositepdf::mpdfs, and bdm::compositepdf::n.\hypertarget{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{
179\index{bdm::mprod@{bdm::mprod}!getrv@{getrv}}
180\index{getrv@{getrv}!bdm::mprod@{bdm::mprod}}
181\subsubsection[getrv]{\setlength{\rightskip}{0pt plus 5cm}{\bf RV} bdm::compositepdf::getrv (bool {\em checkoverlap} = {\tt false})\hspace{0.3cm}{\tt  \mbox{[}inherited\mbox{]}}}}
182\label{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}
183
184
185find common rv, flag
186
187\begin{Desc}
188\item[Parameters:]
189\begin{description}
190\item[{\em checkoverlap}]modifies whether overlaps are acceptable \end{description}
191\end{Desc}
192
193
194References bdm::RV::add(), bdm::compositepdf::mpdfs, and bdm::compositepdf::n.
195
196Referenced by mprod().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
197\index{bdm::mprod@{bdm::mprod}!samplecond\_\-m@{samplecond\_\-m}}
198\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mprod@{bdm::mprod}}
199\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{]}}}}
200\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
201
202
203Returns.
204
205\begin{Desc}
206\item[Parameters:]
207\begin{description}
208\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}
209\end{Desc}
210
211
212References bdm::mpdf::condition(), bdm::epdf::dimension(), bdm::mpdf::ep, and bdm::epdf::sample().
213
214The documentation for this class was generated from the following file:\begin{CompactItemize}
215\item 
216\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.