root/doc/latex/classmerger.tex @ 178

Revision 172, 8.8 kB (checked in by smidl, 16 years ago)

Latex doc

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=47pt]{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_1a6a721294321c2e412ca0084c636b69}{
28\hyperlink{classmerger_1a6a721294321c2e412ca0084c636b69}{merger} (const Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \&in\_\-sources)}
29\label{classmerger_1a6a721294321c2e412ca0084c636b69}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32virtual \hyperlink{classmerger_51e425ee1dd46d73353526e6a1c24ca3}{$\sim$merger} ()
33\begin{CompactList}\small\item\em for future use \item\end{CompactList}\item 
34\hypertarget{classmprod_c15df5d0c7bb9dc82dd78f037b2550a8}{
35double \textbf{evalpdflog} (const vec \&val) const }
36\label{classmprod_c15df5d0c7bb9dc82dd78f037b2550a8}
37
38\item 
39vec \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{samplecond} (const vec \&cond, double \&ll)
40\begin{CompactList}\small\item\em Returns the required moment of the \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item 
41mat \hyperlink{classmprod_e171c40e210539c2af01d6237785620b}{samplecond} (const vec \&cond, vec \&ll, int N)
42\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
43\hypertarget{classmpdf_0f95a0cc6ab40611f46804682446ed83}{
44virtual void \hyperlink{classmpdf_0f95a0cc6ab40611f46804682446ed83}{condition} (const vec \&cond)}
45\label{classmpdf_0f95a0cc6ab40611f46804682446ed83}
46
47\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 
48\hypertarget{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{
49virtual double \hyperlink{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{evalcond} (const vec \&dt, const vec \&cond)}
50\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}
51
52\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 
53\hypertarget{classmpdf_ec9c850305984582548e8deb64f0ffe8}{
54\hyperlink{classRV}{RV} \hyperlink{classmpdf_ec9c850305984582548e8deb64f0ffe8}{\_\-rvc} ()}
55\label{classmpdf_ec9c850305984582548e8deb64f0ffe8}
56
57\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
58\hypertarget{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{
59\hyperlink{classRV}{RV} \hyperlink{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{\_\-rv} ()}
60\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}
61
62\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
63\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{
64\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()}
65\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}
66
67\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
68\subsection*{Protected Attributes}
69\begin{CompactItemize}
70\item 
71\hypertarget{classmerger_1712341746811f2844de5499817abb46}{
72\hyperlink{classenorm}{enorm}$<$ \hyperlink{classfsqmat}{fsqmat} $>$ \hyperlink{classmerger_1712341746811f2844de5499817abb46}{condpdf}}
73\label{classmerger_1712341746811f2844de5499817abb46}
74
75\begin{CompactList}\small\item\em Additional pdf on the part in condition (if undefined);. \item\end{CompactList}\item 
76\hypertarget{classmerger_11eb177ef6409926b2ba3b4630bceab1}{
77Array$<$ ivec $>$ \hyperlink{classmerger_11eb177ef6409926b2ba3b4630bceab1}{overlaps}}
78\label{classmerger_11eb177ef6409926b2ba3b4630bceab1}
79
80\begin{CompactList}\small\item\em Find potential overlaps in rv. \item\end{CompactList}\item 
81\hypertarget{classmprod_7dcf1dde4a220f8c7b97ed987bff6c1f}{
82int \textbf{n}}
83\label{classmprod_7dcf1dde4a220f8c7b97ed987bff6c1f}
84
85\item 
86\hypertarget{classmprod_0883ce383e8475546df138719918f70e}{
87Array$<$ \hyperlink{classepdf}{epdf} $\ast$ $>$ \textbf{epdfs}}
88\label{classmprod_0883ce383e8475546df138719918f70e}
89
90\item 
91\hypertarget{classmprod_2389c7585ac5d0d79587625186818889}{
92Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \textbf{mpdfs}}
93\label{classmprod_2389c7585ac5d0d79587625186818889}
94
95\item 
96\hypertarget{classmprod_c8f78fbcdb4e38ecd3197d2958082497}{
97Array$<$ ivec $>$ \hyperlink{classmprod_c8f78fbcdb4e38ecd3197d2958082497}{rvinds}}
98\label{classmprod_c8f78fbcdb4e38ecd3197d2958082497}
99
100\begin{CompactList}\small\item\em Indeces of rvs in common rv. \item\end{CompactList}\item 
101\hypertarget{classmprod_1725c7b497a27ab3c4889b846666b516}{
102Array$<$ ivec $>$ \hyperlink{classmprod_1725c7b497a27ab3c4889b846666b516}{rvcinrv}}
103\label{classmprod_1725c7b497a27ab3c4889b846666b516}
104
105\begin{CompactList}\small\item\em Indeces of rvc in common rv. \item\end{CompactList}\item 
106\hypertarget{classmprod_cc85192d8abc01832937ed8b62e363a6}{
107Array$<$ ivec $>$ \hyperlink{classmprod_cc85192d8abc01832937ed8b62e363a6}{rvcinds}}
108\label{classmprod_cc85192d8abc01832937ed8b62e363a6}
109
110\begin{CompactList}\small\item\em Indeces of rvc in common rvc. \item\end{CompactList}\item 
111\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{
112\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}}
113\label{classmpdf_f6687c07ff07d47812dd565368ca59eb}
114
115\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
116\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{
117\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}}
118\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab}
119
120\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item 
121\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{
122\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}}
123\label{classmpdf_7aa894208a32f3487827df6d5054424c}
124
125\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize}
126
127
128\subsection{Detailed Description}
129Function for general combination of pdfs.
130
131Parent of simple arithmentic or geometric combinations
132
133\subsection{Constructor \& Destructor Documentation}
134\hypertarget{classmerger_51e425ee1dd46d73353526e6a1c24ca3}{
135\index{merger@{merger}!$\sim$merger@{$\sim$merger}}
136\index{$\sim$merger@{$\sim$merger}!merger@{merger}}
137\subsubsection[$\sim$merger]{\setlength{\rightskip}{0pt plus 5cm}virtual merger::$\sim$merger ()\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
138\label{classmerger_51e425ee1dd46d73353526e6a1c24ca3}
139
140
141for future use
142
143sample from merged density weight w is a
144
145\subsection{Member Function Documentation}
146\hypertarget{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{
147\index{merger@{merger}!samplecond@{samplecond}}
148\index{samplecond@{samplecond}!merger@{merger}}
149\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}vec mprod::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
150\label{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}
151
152
153Returns the required moment of the \hyperlink{classepdf}{epdf}.
154
155Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc}
156\item[Parameters:]
157\begin{description}
158\item[{\em cond}]is numeric value of {\tt rv} \item[{\em ll}]is a return value of log-likelihood of the sample. \end{description}
159\end{Desc}
160
161
162Reimplemented from \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{mpdf}.
163
164References RV::count(), mpdf::rv, mprod::rvcinds, mprod::rvcinrv, and mprod::rvinds.
165
166Referenced by mprod::samplecond().\hypertarget{classmprod_e171c40e210539c2af01d6237785620b}{
167\index{merger@{merger}!samplecond@{samplecond}}
168\index{samplecond@{samplecond}!merger@{merger}}
169\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}mat mprod::samplecond (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
170\label{classmprod_e171c40e210539c2af01d6237785620b}
171
172
173Returns.
174
175\begin{Desc}
176\item[Parameters:]
177\begin{description}
178\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}
179\end{Desc}
180
181
182Reimplemented from \hyperlink{classmpdf_0e37163660f93df2a4d723cedb1da89c}{mpdf}.
183
184References RV::count(), mpdf::rv, and mprod::samplecond().
185
186The documentation for this class was generated from the following file:\begin{CompactItemize}
187\item 
188work/git/mixpp/bdm/stat/\hyperlink{merger_8h}{merger.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.