root/doc/latex/classbdm_1_1merger.tex @ 261

Revision 261, 13.4 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[261]1\hypertarget{classbdm_1_1merger}{
2\section{bdm::merger Class Reference}
3\label{classbdm_1_1merger}\index{bdm::merger@{bdm::merger}}
4}
5Function for general combination of pdfs. 
6
7
8{\tt \#include $<$merger.h$>$}
9
10Inheritance diagram for bdm::merger:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=122pt]{classbdm_1_1merger__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::merger:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=400pt]{classbdm_1_1merger__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1merger_30ae0fa8a88737185f598bf63fec0569}{
28\hyperlink{classbdm_1_1merger_30ae0fa8a88737185f598bf63fec0569}{merger} (const Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \&S)}
29\label{classbdm_1_1merger_30ae0fa8a88737185f598bf63fec0569}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1merger_bc867c8e2b4709041bf8802ae9c78e37}{
33void \hyperlink{classbdm_1_1merger_bc867c8e2b4709041bf8802ae9c78e37}{set\_\-parameters} (double beta0, int Ns0, int Nc0)}
34\label{classbdm_1_1merger_bc867c8e2b4709041bf8802ae9c78e37}
35
36\begin{CompactList}\small\item\em Set internal parameters used in approximation. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1merger_8ae79a651e93d6e2d611556001af8aa8}{
38void \hyperlink{classbdm_1_1merger_8ae79a651e93d6e2d611556001af8aa8}{init} ()}
39\label{classbdm_1_1merger_8ae79a651e93d6e2d611556001af8aa8}
40
41\begin{CompactList}\small\item\em Initialize the proposal density. This function must be called before \hyperlink{classbdm_1_1merger_b72f4662c9ac760a8b17ebe5d697f3c2}{merge()}! \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1merger_3d9f0ba04c8e74be8246d840cc537879}{
43void \hyperlink{classbdm_1_1merger_3d9f0ba04c8e74be8246d840cc537879}{merge} (const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$g0)}
44\label{classbdm_1_1merger_3d9f0ba04c8e74be8246d840cc537879}
45
46\begin{CompactList}\small\item\em Create a mixture density using known proposal. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1merger_b72f4662c9ac760a8b17ebe5d697f3c2}{
48void \hyperlink{classbdm_1_1merger_b72f4662c9ac760a8b17ebe5d697f3c2}{merge} ()}
49\label{classbdm_1_1merger_b72f4662c9ac760a8b17ebe5d697f3c2}
50
51\begin{CompactList}\small\item\em Create a mixture density, make sure to call \hyperlink{classbdm_1_1merger_8ae79a651e93d6e2d611556001af8aa8}{init()} before the first call. \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1merger_b90f1b8a21a693176dd953a3b983aa0b}{
53vec \hyperlink{classbdm_1_1merger_b90f1b8a21a693176dd953a3b983aa0b}{lognorm\_\-merge} (mat \&lW)}
54\label{classbdm_1_1merger_b90f1b8a21a693176dd953a3b983aa0b}
55
56\begin{CompactList}\small\item\em Merge log-likelihood values. \item\end{CompactList}\item 
57vec \hyperlink{classbdm_1_1merger_0ef73e76eeee44c8e3896e3a271ad974}{sample} () const
58\item 
59\hypertarget{classbdm_1_1merger_c47543661897638cab9f506c76a1f92f}{
60double \hyperlink{classbdm_1_1merger_c47543661897638cab9f506c76a1f92f}{evallog} (const vec \&dt) const }
61\label{classbdm_1_1merger_c47543661897638cab9f506c76a1f92f}
62
63\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
64\hypertarget{classbdm_1_1merger_82c5ad7677315fde8e9fc9381c17ece5}{
65vec \hyperlink{classbdm_1_1merger_82c5ad7677315fde8e9fc9381c17ece5}{mean} () const }
66\label{classbdm_1_1merger_82c5ad7677315fde8e9fc9381c17ece5}
67
68\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
69\hypertarget{classbdm_1_1merger_88e75fe2b9d7c1247b20ea7760c061f1}{
70mat \textbf{covariance} () const }
71\label{classbdm_1_1merger_88e75fe2b9d7c1247b20ea7760c061f1}
72
73\item 
74\hypertarget{classbdm_1_1merger_bcef70ece256b1ab1fa7a3a354eb1cc4}{
75vec \hyperlink{classbdm_1_1merger_bcef70ece256b1ab1fa7a3a354eb1cc4}{variance} () const }
76\label{classbdm_1_1merger_bcef70ece256b1ab1fa7a3a354eb1cc4}
77
78\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1merger_febef179bb5e074ae6e34d15b4596273}{
80virtual \hyperlink{classbdm_1_1merger_febef179bb5e074ae6e34d15b4596273}{$\sim$merger} ()}
81\label{classbdm_1_1merger_febef179bb5e074ae6e34d15b4596273}
82
83\begin{CompactList}\small\item\em for future use \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1merger_13f8534f626a37bed91a6d9db54d6d2f}{
85\hyperlink{classbdm_1_1MixEF}{MixEF} \& \hyperlink{classbdm_1_1merger_13f8534f626a37bed91a6d9db54d6d2f}{\_\-Mix} ()}
86\label{classbdm_1_1merger_13f8534f626a37bed91a6d9db54d6d2f}
87
88\begin{CompactList}\small\item\em Access function. \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1merger_23f5f8b80df579b05681006fbcfe3699}{
90\hyperlink{classbdm_1_1eEmp}{eEmp} \& \hyperlink{classbdm_1_1merger_23f5f8b80df579b05681006fbcfe3699}{\_\-Smp} ()}
91\label{classbdm_1_1merger_23f5f8b80df579b05681006fbcfe3699}
92
93\begin{CompactList}\small\item\em Access function. \item\end{CompactList}\item 
94\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{getrv} (bool checkoverlap=false)
95\begin{CompactList}\small\item\em find common rv, flag \item\end{CompactList}\item 
96\hypertarget{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{
97void \hyperlink{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{setrvc} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}, \hyperlink{classbdm_1_1RV}{RV} \&rvc)}
98\label{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}
99
100\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\item 
101\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
102virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
103\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
104
105\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
106\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
107virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
108\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
109
110\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
111\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
112virtual \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{condition} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
113\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
114
115\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classbdm_1_1RV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
116\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
117virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{marginal} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
118\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
119
120\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classbdm_1_1RV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
121\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
122const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
123\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
124
125\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
126\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
127void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
128\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
129
130\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
131\subsection*{Protected Attributes}
132\begin{CompactItemize}
133\item 
134\hypertarget{classbdm_1_1merger_67ae71cbf0686d7c7bf116fa5db86d81}{
135\hyperlink{classbdm_1_1MixEF}{MixEF} \hyperlink{classbdm_1_1merger_67ae71cbf0686d7c7bf116fa5db86d81}{Mix}}
136\label{classbdm_1_1merger_67ae71cbf0686d7c7bf116fa5db86d81}
137
138\begin{CompactList}\small\item\em Internal mixture of EF models. \item\end{CompactList}\item 
139\hypertarget{classbdm_1_1merger_ea3c9f4739f857877fd5285b3973289c}{
140Array$<$ \hyperlink{classbdm_1_1datalink__m2e}{datalink\_\-m2e} $\ast$ $>$ \hyperlink{classbdm_1_1merger_ea3c9f4739f857877fd5285b3973289c}{dls}}
141\label{classbdm_1_1merger_ea3c9f4739f857877fd5285b3973289c}
142
143\begin{CompactList}\small\item\em Data link for each \hyperlink{classbdm_1_1mpdf}{mpdf} in mpdfs. \item\end{CompactList}\item 
144\hypertarget{classbdm_1_1merger_135b938f841cb88ad00a8bbded818703}{
145Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1merger_135b938f841cb88ad00a8bbded818703}{rvzs}}
146\label{classbdm_1_1merger_135b938f841cb88ad00a8bbded818703}
147
148\begin{CompactList}\small\item\em Array of rvs that are not modelled by mpdfs at all (aux). \item\end{CompactList}\item 
149\hypertarget{classbdm_1_1merger_6c48bf36ec1f3f7b52e3159cf428a193}{
150Array$<$ \hyperlink{classbdm_1_1datalink__m2e}{datalink\_\-m2e} $\ast$ $>$ \hyperlink{classbdm_1_1merger_6c48bf36ec1f3f7b52e3159cf428a193}{zdls}}
151\label{classbdm_1_1merger_6c48bf36ec1f3f7b52e3159cf428a193}
152
153\begin{CompactList}\small\item\em Data Links of rv0 mpdfs - these will be conditioned the (rv,rvc) of mpdfs. \item\end{CompactList}\item 
154\hypertarget{classbdm_1_1merger_e91b83e6d9076848c71ae27664072109}{
155int \hyperlink{classbdm_1_1merger_e91b83e6d9076848c71ae27664072109}{Ns}}
156\label{classbdm_1_1merger_e91b83e6d9076848c71ae27664072109}
157
158\begin{CompactList}\small\item\em Number of samples used in approximation. \item\end{CompactList}\item 
159\hypertarget{classbdm_1_1merger_214ca7c566e8f75d45bb243d7c74580d}{
160int \hyperlink{classbdm_1_1merger_214ca7c566e8f75d45bb243d7c74580d}{Nc}}
161\label{classbdm_1_1merger_214ca7c566e8f75d45bb243d7c74580d}
162
163\begin{CompactList}\small\item\em Number of components in a mixture. \item\end{CompactList}\item 
164\hypertarget{classbdm_1_1merger_1a85d299f202a70afe0cdc1045c26a5d}{
165double \hyperlink{classbdm_1_1merger_1a85d299f202a70afe0cdc1045c26a5d}{beta}}
166\label{classbdm_1_1merger_1a85d299f202a70afe0cdc1045c26a5d}
167
168\begin{CompactList}\small\item\em Prior on the log-normal merging model. \item\end{CompactList}\item 
169\hypertarget{classbdm_1_1merger_522d43f7aa13fe6701e93fba174dec94}{
170\hyperlink{classbdm_1_1eEmp}{eEmp} \hyperlink{classbdm_1_1merger_522d43f7aa13fe6701e93fba174dec94}{eSmp}}
171\label{classbdm_1_1merger_522d43f7aa13fe6701e93fba174dec94}
172
173\begin{CompactList}\small\item\em Projection to empirical density. \item\end{CompactList}\item 
174\hypertarget{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{
175int \hyperlink{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{n}}
176\label{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}
177
178\begin{CompactList}\small\item\em Number of mpdfs in the composite. \item\end{CompactList}\item 
179\hypertarget{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{
180Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \hyperlink{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{mpdfs}}
181\label{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}
182
183\begin{CompactList}\small\item\em Elements of composition. \item\end{CompactList}\item 
184\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
185\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
186\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
187
188\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
189
190
191\subsection{Detailed Description}
192Function for general combination of pdfs.
193
194Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial.
195
196\subsection{Member Function Documentation}
197\hypertarget{classbdm_1_1merger_0ef73e76eeee44c8e3896e3a271ad974}{
198\index{bdm::merger@{bdm::merger}!sample@{sample}}
199\index{sample@{sample}!bdm::merger@{bdm::merger}}
200\subsubsection[sample]{\setlength{\rightskip}{0pt plus 5cm}vec bdm::merger::sample () const\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
201\label{classbdm_1_1merger_0ef73e76eeee44c8e3896e3a271ad974}
202
203
204sample from merged density weight w is a
205
206Implements \hyperlink{classbdm_1_1epdf_09721eb148bc49d6ec2f1956039f3a10}{bdm::epdf}.
207
208References bdm::MixEF::\_\-epdf(), Mix, and bdm::epdf::sample().\hypertarget{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{
209\index{bdm::merger@{bdm::merger}!getrv@{getrv}}
210\index{getrv@{getrv}!bdm::merger@{bdm::merger}}
211\subsubsection[getrv]{\setlength{\rightskip}{0pt plus 5cm}{\bf RV} bdm::compositepdf::getrv (bool {\em checkoverlap} = {\tt false})\hspace{0.3cm}{\tt  \mbox{[}inherited\mbox{]}}}}
212\label{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}
213
214
215find common rv, flag
216
217\begin{Desc}
218\item[Parameters:]
219\begin{description}
220\item[{\em checkoverlap}]modifies whether overlaps are acceptable \end{description}
221\end{Desc}
222
223
224References bdm::RV::add(), bdm::compositepdf::mpdfs, and bdm::compositepdf::n.
225
226The documentation for this class was generated from the following files:\begin{CompactItemize}
227\item 
228\hyperlink{merger_8h}{merger.h}\item 
229merger.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.