root/doc/latex/classmerger.tex @ 180

Revision 180, 9.7 kB (checked in by smidl, 16 years ago)

Modifications of BDM to reflect changes in basics

Line 
1\hypertarget{classmerger}{
2\section{merger Class Reference}
3\label{classmerger}\index{merger@{merger}}
4}
5Function for general combination of pdfs. 
6
7
8{\tt \#include $<$merger.h$>$}
9
10Inheritance diagram for merger:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=89pt]{classmerger__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for merger:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[height=400pt]{classmerger__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classmerger_3f9a955329eab65026e8322e9027d469}{
28\hyperlink{classmerger_3f9a955329eab65026e8322e9027d469}{merger} (const Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \&S)}
29\label{classmerger_3f9a955329eab65026e8322e9027d469}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classmerger_79420e251308df4502c834171d518ad9}{
33void \hyperlink{classmerger_79420e251308df4502c834171d518ad9}{set\_\-parameters} (double beta0, int Ns0, int Nc0)}
34\label{classmerger_79420e251308df4502c834171d518ad9}
35
36\begin{CompactList}\small\item\em Set internal parameters used in approximation. \item\end{CompactList}\item 
37\hypertarget{classmerger_02d2a445e44a87f37ee3a2b9b40cffd1}{
38void \hyperlink{classmerger_02d2a445e44a87f37ee3a2b9b40cffd1}{init} ()}
39\label{classmerger_02d2a445e44a87f37ee3a2b9b40cffd1}
40
41\begin{CompactList}\small\item\em Initialize the proposal density. This function must be called before \hyperlink{classmerger_bc23accc77ec766bce7202934e2c180c}{merge()}! \item\end{CompactList}\item 
42\hypertarget{classmerger_e56ad4a2bc9be2ddfc051626adf27715}{
43void \hyperlink{classmerger_e56ad4a2bc9be2ddfc051626adf27715}{merge} (const \hyperlink{classepdf}{epdf} $\ast$g0)}
44\label{classmerger_e56ad4a2bc9be2ddfc051626adf27715}
45
46\begin{CompactList}\small\item\em Create a mixture density using known proposal. \item\end{CompactList}\item 
47\hypertarget{classmerger_bc23accc77ec766bce7202934e2c180c}{
48void \hyperlink{classmerger_bc23accc77ec766bce7202934e2c180c}{merge} ()}
49\label{classmerger_bc23accc77ec766bce7202934e2c180c}
50
51\begin{CompactList}\small\item\em Create a mixture density, make sure to call \hyperlink{classmerger_02d2a445e44a87f37ee3a2b9b40cffd1}{init()} before the first call. \item\end{CompactList}\item 
52\hypertarget{classmerger_217c65f335c603033fa09a2ecc64bc05}{
53vec \hyperlink{classmerger_217c65f335c603033fa09a2ecc64bc05}{lognorm\_\-merge} (mat \&lW)}
54\label{classmerger_217c65f335c603033fa09a2ecc64bc05}
55
56\begin{CompactList}\small\item\em Merge log-likelihood values. \item\end{CompactList}\item 
57vec \hyperlink{classmerger_379198c3d2063bfa63f5d1245a2511ba}{sample} () const
58\item 
59\hypertarget{classmerger_8c37688902b1a1e9fa32edc5709e5a00}{
60double \hyperlink{classmerger_8c37688902b1a1e9fa32edc5709e5a00}{evalpdflog} (const vec \&dt) const }
61\label{classmerger_8c37688902b1a1e9fa32edc5709e5a00}
62
63\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
64\hypertarget{classmerger_3a46999cd77047d5d4ac6c1cb735a83e}{
65vec \hyperlink{classmerger_3a46999cd77047d5d4ac6c1cb735a83e}{mean} () const }
66\label{classmerger_3a46999cd77047d5d4ac6c1cb735a83e}
67
68\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
69\hypertarget{classmerger_51e425ee1dd46d73353526e6a1c24ca3}{
70virtual \hyperlink{classmerger_51e425ee1dd46d73353526e6a1c24ca3}{$\sim$merger} ()}
71\label{classmerger_51e425ee1dd46d73353526e6a1c24ca3}
72
73\begin{CompactList}\small\item\em for future use \item\end{CompactList}\item 
74\hypertarget{classcompositepdf_635d219fb3e32852400d6f98aa4bdc93}{
75\hyperlink{classRV}{RV} \textbf{getrv} (bool checkoverlap=false)}
76\label{classcompositepdf_635d219fb3e32852400d6f98aa4bdc93}
77
78\item 
79\hypertarget{classcompositepdf_5a4479785c1fdb2cc351fbea07b899ac}{
80void \textbf{setrvc} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}, \hyperlink{classRV}{RV} \&rvc)}
81\label{classcompositepdf_5a4479785c1fdb2cc351fbea07b899ac}
82
83\item 
84\hypertarget{classcompositepdf_08958c8f76d65de94ecc37b8d90bc77a}{
85void \textbf{setindices} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
86\label{classcompositepdf_08958c8f76d65de94ecc37b8d90bc77a}
87
88\item 
89\hypertarget{classcompositepdf_3bd4ada95f381ea6c4cff2dc86e957c4}{
90void \textbf{setrvcinrv} (const \hyperlink{classRV}{RV} \&rvc, Array$<$ ivec $>$ \&rvcind)}
91\label{classcompositepdf_3bd4ada95f381ea6c4cff2dc86e957c4}
92
93\item 
94\hypertarget{classepdf_54d7dd53a641b618771cd9bee135181f}{
95virtual mat \hyperlink{classepdf_54d7dd53a641b618771cd9bee135181f}{sampleN} (int N) const }
96\label{classepdf_54d7dd53a641b618771cd9bee135181f}
97
98\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
99\hypertarget{classepdf_3ea597362e11a0040fe7c990269d072c}{
100virtual double \hyperlink{classepdf_3ea597362e11a0040fe7c990269d072c}{eval} (const vec \&val) const }
101\label{classepdf_3ea597362e11a0040fe7c990269d072c}
102
103\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
104\hypertarget{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{
105virtual vec \hyperlink{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{evalpdflog\_\-m} (const mat \&Val) const }
106\label{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}
107
108\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
109\hypertarget{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{
110const \hyperlink{classRV}{RV} \& \hyperlink{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{\_\-rv} () const }
111\label{classepdf_ca0d32aabb4cbba347e0c37fe8607562}
112
113\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
114\hypertarget{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{
115void \hyperlink{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{\_\-renewrv} (const \hyperlink{classRV}{RV} \&in\_\-rv)}
116\label{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}
117
118\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
119\subsection*{Protected Attributes}
120\begin{CompactItemize}
121\item 
122\hypertarget{classmerger_021d1522cea70db8545d708afd32ec2f}{
123\hyperlink{classMixEF}{MixEF} \hyperlink{classmerger_021d1522cea70db8545d708afd32ec2f}{Mix}}
124\label{classmerger_021d1522cea70db8545d708afd32ec2f}
125
126\begin{CompactList}\small\item\em Internal mixture of EF models. \item\end{CompactList}\item 
127\hypertarget{classmerger_ce84de1824875b4262eefb640e8c6d69}{
128int \hyperlink{classmerger_ce84de1824875b4262eefb640e8c6d69}{Ns}}
129\label{classmerger_ce84de1824875b4262eefb640e8c6d69}
130
131\begin{CompactList}\small\item\em Number of samples used in approximation. \item\end{CompactList}\item 
132\hypertarget{classmerger_6acf33e1c64aaaee20689725e8110f65}{
133int \hyperlink{classmerger_6acf33e1c64aaaee20689725e8110f65}{Nc}}
134\label{classmerger_6acf33e1c64aaaee20689725e8110f65}
135
136\begin{CompactList}\small\item\em Number of components in a mixture. \item\end{CompactList}\item 
137\hypertarget{classmerger_e68a72e2740007ae68545e378c7701ad}{
138double \hyperlink{classmerger_e68a72e2740007ae68545e378c7701ad}{beta}}
139\label{classmerger_e68a72e2740007ae68545e378c7701ad}
140
141\begin{CompactList}\small\item\em Prior on the log-normal merging model. \item\end{CompactList}\item 
142\hypertarget{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}{
143int \hyperlink{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}{n}}
144\label{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}
145
146\begin{CompactList}\small\item\em Number of mpdfs in the composite. \item\end{CompactList}\item 
147\hypertarget{classcompositepdf_637877061b917a16a0421bb5c4cd480d}{
148Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \hyperlink{classcompositepdf_637877061b917a16a0421bb5c4cd480d}{mpdfs}}
149\label{classcompositepdf_637877061b917a16a0421bb5c4cd480d}
150
151\begin{CompactList}\small\item\em Elements of composition. \item\end{CompactList}\item 
152\hypertarget{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}{
153Array$<$ ivec $>$ \hyperlink{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}{rvsinrv}}
154\label{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}
155
156\begin{CompactList}\small\item\em Indeces of rvs in common rv. \item\end{CompactList}\item 
157\hypertarget{classcompositepdf_3df07bb5e3ed36a3119b145043296676}{
158Array$<$ ivec $>$ \hyperlink{classcompositepdf_3df07bb5e3ed36a3119b145043296676}{rvcsinrv}}
159\label{classcompositepdf_3df07bb5e3ed36a3119b145043296676}
160
161\begin{CompactList}\small\item\em Indeces of rvc in common rv. \item\end{CompactList}\item 
162\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
163\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
164\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
165
166\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
167
168
169\subsection{Detailed Description}
170Function for general combination of pdfs.
171
172Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial.
173
174\subsection{Member Function Documentation}
175\hypertarget{classmerger_379198c3d2063bfa63f5d1245a2511ba}{
176\index{merger@{merger}!sample@{sample}}
177\index{sample@{sample}!merger@{merger}}
178\subsubsection[sample]{\setlength{\rightskip}{0pt plus 5cm}vec merger::sample () const\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
179\label{classmerger_379198c3d2063bfa63f5d1245a2511ba}
180
181
182sample from merged density weight w is a
183
184Implements \hyperlink{classepdf_8019654e494bf5e458f6fb947e11b262}{epdf}.
185
186References MixEF::\_\-epdf(), Mix, and epdf::sample().
187
188The documentation for this class was generated from the following files:\begin{CompactItemize}
189\item 
190work/git/mixpp/bdm/estim/\hyperlink{merger_8h}{merger.h}\item 
191work/git/mixpp/bdm/estim/merger.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.