root/doc/latex/classbdm_1_1eprod.tex @ 271

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

Next major revision

Line 
1\hypertarget{classbdm_1_1eprod}{
2\section{bdm::eprod Class Reference}
3\label{classbdm_1_1eprod}\index{bdm::eprod@{bdm::eprod}}
4}
5{\tt \#include $<$emix.h$>$}
6
7Inheritance diagram for bdm::eprod::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=3cm]{classbdm_1_1eprod}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Product of independent epdfs. For dependent pdfs, use \hyperlink{classbdm_1_1mprod}{mprod}. \subsection*{Public Member Functions}
17\begin{CompactItemize}
18\item 
19\hypertarget{classbdm_1_1eprod_5f11492068875f95a8a377924ee0c611}{
20\textbf{eprod} (const Array$<$ const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ $>$ epdfs0)}
21\label{classbdm_1_1eprod_5f11492068875f95a8a377924ee0c611}
22
23\item 
24\hypertarget{classbdm_1_1eprod_1d494351e7e385ad3382387c96915d24}{
25vec \hyperlink{classbdm_1_1eprod_1d494351e7e385ad3382387c96915d24}{mean} () const }
26\label{classbdm_1_1eprod_1d494351e7e385ad3382387c96915d24}
27
28\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1eprod_cc53a151f5ac5dfba68d425acc3a5615}{
30vec \hyperlink{classbdm_1_1eprod_cc53a151f5ac5dfba68d425acc3a5615}{variance} () const }
31\label{classbdm_1_1eprod_cc53a151f5ac5dfba68d425acc3a5615}
32
33\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1eprod_af48debea25d3473bcb71b6a77fac741}{
35vec \hyperlink{classbdm_1_1eprod_af48debea25d3473bcb71b6a77fac741}{sample} () const }
36\label{classbdm_1_1eprod_af48debea25d3473bcb71b6a77fac741}
37
38\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1eprod_a5a91e67d2f74ff2b0b8eecde2fa42e2}{
40double \hyperlink{classbdm_1_1eprod_a5a91e67d2f74ff2b0b8eecde2fa42e2}{evallog} (const vec \&val) const }
41\label{classbdm_1_1eprod_a5a91e67d2f74ff2b0b8eecde2fa42e2}
42
43\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
44\hypertarget{classbdm_1_1eprod_5194b47dd05a5886e0745250b6704953}{
45const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1eprod_5194b47dd05a5886e0745250b6704953}{operator()} (int i) const }
46\label{classbdm_1_1eprod_5194b47dd05a5886e0745250b6704953}
47
48\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
49\hypertarget{classbdm_1_1eprod_708b37971aab3667f20e325c358632cf}{
50\hyperlink{classbdm_1_1eprod_708b37971aab3667f20e325c358632cf}{$\sim$eprod} ()}
51\label{classbdm_1_1eprod_708b37971aab3667f20e325c358632cf}
52
53\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\end{CompactItemize}
54\begin{Indent}{\bf Constructors}\par
55{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize}
56\item empty constructor, \item copy constructor,\end{itemize}
57The following constructors should be supported for convenience: \begin{itemize}
58\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize}
59All internal data structures are constructed as empty. Their values (including sizes) will be set by method {\tt set\_\-parameters()}. This way references can be initialized in constructors. }\begin{CompactItemize}
60\item 
61\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{
62void \textbf{set\_\-parameters} (int dim0)}
63\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}
64
65\end{CompactItemize}
66\end{Indent}
67\begin{Indent}{\bf Matematical Operations}\par
68\begin{CompactItemize}
69\item 
70\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
71virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
72\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
73
74\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
75\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
76virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
77\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
78
79\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
80\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
81virtual \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 }
82\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
83
84\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 
85\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
86virtual \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 }
87\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
88
89\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}\end{CompactItemize}
90\end{Indent}
91\begin{Indent}{\bf Connection to other classes}\par
92{\em Description of the random quantity via attribute {\tt rv} is optional. For operations such as sampling {\tt rv} does not need to be set. However, for {\tt marginalization} and {\tt conditioning} {\tt rv} has to be set. NB: }\begin{CompactItemize}
93\item 
94\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
95void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
96\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}
97
98\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
99\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
100bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
101\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}
102
103\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
104\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
105const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
106\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
107
108\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
109\end{Indent}
110\begin{Indent}{\bf Access to attributes}\par
111\begin{CompactItemize}
112\item 
113\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{
114int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const }
115\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}
116
117\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
118\end{Indent}
119\subsection*{Protected Attributes}
120\begin{CompactItemize}
121\item 
122\hypertarget{classbdm_1_1eprod_fa0b0981730f0a8339b9ff3e29d78391}{
123Array$<$ const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ $>$ \hyperlink{classbdm_1_1eprod_fa0b0981730f0a8339b9ff3e29d78391}{epdfs}}
124\label{classbdm_1_1eprod_fa0b0981730f0a8339b9ff3e29d78391}
125
126\begin{CompactList}\small\item\em Components (epdfs). \item\end{CompactList}\item 
127\hypertarget{classbdm_1_1eprod_6b5a9be71a644f6009e7beda6c762a43}{
128Array$<$ \hyperlink{classbdm_1_1datalink}{datalink} $\ast$ $>$ \hyperlink{classbdm_1_1eprod_6b5a9be71a644f6009e7beda6c762a43}{dls}}
129\label{classbdm_1_1eprod_6b5a9be71a644f6009e7beda6c762a43}
130
131\begin{CompactList}\small\item\em Array of indeces. \item\end{CompactList}\item 
132\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
133int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
134\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}
135
136\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
137\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
138\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
139\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
140
141\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
142
143
144The documentation for this class was generated from the following file:\begin{CompactItemize}
145\item 
146\hyperlink{emix_8h}{emix.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.