root/doc/latex/classbdm_1_1epdf.tex @ 275

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

Next major revision

Line 
1\hypertarget{classbdm_1_1epdf}{
2\section{bdm::epdf Class Reference}
3\label{classbdm_1_1epdf}\index{bdm::epdf@{bdm::epdf}}
4}
5{\tt \#include $<$libBM.h$>$}
6
7Inheritance diagram for bdm::epdf::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=7.17949cm]{classbdm_1_1epdf}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Probability density function with numerical statistics, e.g. posterior density. \subsection*{Public Member Functions}
17\begin{Indent}{\bf Constructors}\par
18{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize}
19\item empty constructor, \item copy constructor,\end{itemize}
20The following constructors should be supported for convenience: \begin{itemize}
21\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize}
22All 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}
23\item 
24\hypertarget{classbdm_1_1epdf_992f3de956fb3439c62225156aafb6f6}{
25\textbf{epdf} ()}
26\label{classbdm_1_1epdf_992f3de956fb3439c62225156aafb6f6}
27
28\item 
29\hypertarget{classbdm_1_1epdf_e50af83245e56edf5cd76dbb4347d030}{
30\textbf{epdf} (const \hyperlink{classbdm_1_1epdf}{epdf} \&e)}
31\label{classbdm_1_1epdf_e50af83245e56edf5cd76dbb4347d030}
32
33\item 
34\hypertarget{classbdm_1_1epdf_fdfed7aa18f2870951888b1dde977415}{
35\textbf{epdf} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
36\label{classbdm_1_1epdf_fdfed7aa18f2870951888b1dde977415}
37
38\item 
39\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{
40void \textbf{set\_\-parameters} (int dim0)}
41\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}
42
43\end{CompactItemize}
44\end{Indent}
45\begin{Indent}{\bf Matematical Operations}\par
46\begin{CompactItemize}
47\item 
48\hypertarget{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}{
49virtual vec \hyperlink{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}{sample} () const }
50\label{classbdm_1_1epdf_75ba57a89681a8efec488f5796c7cc1b}
51
52\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
53\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
54virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
55\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
56
57\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
58\hypertarget{classbdm_1_1epdf_deab266d63c236c277538867d5c3f249}{
59virtual double \hyperlink{classbdm_1_1epdf_deab266d63c236c277538867d5c3f249}{evallog} (const vec \&val) const }
60\label{classbdm_1_1epdf_deab266d63c236c277538867d5c3f249}
61
62\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
63\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
64virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
65\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
66
67\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
68\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
69virtual \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 }
70\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
71
72\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 
73\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
74virtual \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 }
75\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
76
77\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 
78\hypertarget{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}{
79virtual vec \hyperlink{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}{mean} () const }
80\label{classbdm_1_1epdf_0c8d13d788094605b3cdab20a6e22b75}
81
82\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
83\hypertarget{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}{
84virtual vec \hyperlink{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}{variance} () const }
85\label{classbdm_1_1epdf_4543d40ccfc5d549b0c831a57a3ed84c}
86
87\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\end{CompactItemize}
88\end{Indent}
89\begin{Indent}{\bf Connection to other classes}\par
90{\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}
91\item 
92\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
93void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
94\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}
95
96\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
97\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
98bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
99\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}
100
101\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
102\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
103const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
104\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
105
106\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
107\end{Indent}
108\begin{Indent}{\bf Access to attributes}\par
109\begin{CompactItemize}
110\item 
111\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{
112int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const }
113\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}
114
115\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
116\end{Indent}
117\subsection*{Protected Attributes}
118\begin{CompactItemize}
119\item 
120\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
121int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
122\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}
123
124\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
125\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
126\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
127\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
128
129\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
130
131
132The documentation for this class was generated from the following files:\begin{CompactItemize}
133\item 
134\hyperlink{libBM_8h}{libBM.h}\item 
135libBM.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.