root/doc/latex/classbdm_1_1mpdf.tex @ 275

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

Next major revision

Line 
1\hypertarget{classbdm_1_1mpdf}{
2\section{bdm::mpdf Class Reference}
3\label{classbdm_1_1mpdf}\index{bdm::mpdf@{bdm::mpdf}}
4}
5{\tt \#include $<$libBM.h$>$}
6
7Inheritance diagram for bdm::mpdf::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=2.8169cm]{classbdm_1_1mpdf}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Conditional probability density, e.g. modeling some dependencies. \subsection*{Public Member Functions}
17\begin{Indent}{\bf Constructors}\par
18\begin{CompactItemize}
19\item 
20\hypertarget{classbdm_1_1mpdf_dc3f5e531994dd42447d678deb92fe48}{
21\textbf{mpdf} ()}
22\label{classbdm_1_1mpdf_dc3f5e531994dd42447d678deb92fe48}
23
24\item 
25\hypertarget{classbdm_1_1mpdf_7089fcbd918f201fdf4256119e31f173}{
26\hyperlink{classbdm_1_1mpdf_7089fcbd918f201fdf4256119e31f173}{mpdf} (const \hyperlink{classbdm_1_1mpdf}{mpdf} \&m)}
27\label{classbdm_1_1mpdf_7089fcbd918f201fdf4256119e31f173}
28
29\begin{CompactList}\small\item\em copy constructor does not set pointer {\tt ep} - has to be done in offsprings! \item\end{CompactList}\end{CompactItemize}
30\end{Indent}
31\begin{Indent}{\bf Matematical operations}\par
32\begin{CompactItemize}
33\item 
34virtual vec \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{samplecond} (const vec \&cond)
35\begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
36virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
37\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
38\hypertarget{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{
39virtual void \hyperlink{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}{condition} (const vec \&cond)}
40\label{classbdm_1_1mpdf_db94784a9aacf74c65c5a014f6743530}
41
42\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 
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_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
111int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
112\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
113
114\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
115\hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
116\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
117\label{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}
118
119\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
120\hypertarget{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{
121\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}{ep}}
122\label{classbdm_1_1mpdf_5eea43c56d38e4441bfb30270db949c0}
123
124\begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
125
126
127\subsection{Member Function Documentation}
128\hypertarget{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{
129\index{bdm::mpdf@{bdm::mpdf}!samplecond@{samplecond}}
130\index{samplecond@{samplecond}!bdm::mpdf@{bdm::mpdf}}
131\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec bdm::mpdf::samplecond (const vec \& {\em cond})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
132\label{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}
133
134
135Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$.
136
137\begin{Desc}
138\item[Parameters:]
139\begin{description}
140\item[{\em cond}]is numeric value of {\tt rv} \end{description}
141\end{Desc}
142
143
144Reimplemented in \hyperlink{classbdm_1_1mprod_ee715a8013acf9892f6cb489db595555}{bdm::mprod}.
145
146References condition(), ep, and bdm::epdf::sample().
147
148Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
149\index{bdm::mpdf@{bdm::mpdf}!samplecond\_\-m@{samplecond\_\-m}}
150\index{samplecond\_\-m@{samplecond\_\-m}!bdm::mpdf@{bdm::mpdf}}
151\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\mbox{]}}}}
152\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
153
154
155Returns.
156
157\begin{Desc}
158\item[Parameters:]
159\begin{description}
160\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}
161\end{Desc}
162
163
164References condition(), bdm::epdf::dimension(), ep, and bdm::epdf::sample().
165
166The documentation for this class was generated from the following file:\begin{CompactItemize}
167\item 
168\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.