root/doc/latex/classepdf.tex @ 252

Revision 234, 5.5 kB (checked in by smidl, 15 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classepdf}{
2\section{epdf Class Reference}
3\label{classepdf}\index{epdf@{epdf}}
4}
5Probability density function with numerical statistics, e.g. posterior density. 
6
7
8{\tt \#include $<$libBM.h$>$}
9
10Inheritance diagram for epdf:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=400pt]{classepdf__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for epdf:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=39pt]{classepdf__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classepdf_d8eb760037b3bad5a0d64081606697cd}{
28\hyperlink{classepdf_d8eb760037b3bad5a0d64081606697cd}{epdf} ()}
29\label{classepdf_d8eb760037b3bad5a0d64081606697cd}
30
31\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
32\hypertarget{classepdf_c95b1a27a8dd9507bb9a5a3cb2809c7a}{
33\hyperlink{classepdf_c95b1a27a8dd9507bb9a5a3cb2809c7a}{epdf} (const \hyperlink{classRV}{RV} \&rv0)}
34\label{classepdf_c95b1a27a8dd9507bb9a5a3cb2809c7a}
35
36\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
37\hypertarget{classepdf_8019654e494bf5e458f6fb947e11b262}{
38virtual vec \hyperlink{classepdf_8019654e494bf5e458f6fb947e11b262}{sample} () const =0}
39\label{classepdf_8019654e494bf5e458f6fb947e11b262}
40
41\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
42\hypertarget{classepdf_76608914c3b19e150292d5c56e93e508}{
43virtual mat \hyperlink{classepdf_76608914c3b19e150292d5c56e93e508}{sample\_\-m} (int N) const }
44\label{classepdf_76608914c3b19e150292d5c56e93e508}
45
46\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
47\hypertarget{classepdf_e1996af1da1fa1214270066a96ca113e}{
48virtual double \hyperlink{classepdf_e1996af1da1fa1214270066a96ca113e}{evallog} (const vec \&val) const =0}
49\label{classepdf_e1996af1da1fa1214270066a96ca113e}
50
51\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
52\hypertarget{classepdf_2495a04bbacb9b55fe5a3a59b78affca}{
53virtual vec \hyperlink{classepdf_2495a04bbacb9b55fe5a3a59b78affca}{evallog\_\-m} (const mat \&Val) const }
54\label{classepdf_2495a04bbacb9b55fe5a3a59b78affca}
55
56\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
57\hypertarget{classepdf_e87dc8260a5c37bc1b03eb66174741a0}{
58virtual \hyperlink{classmpdf}{mpdf} $\ast$ \hyperlink{classepdf_e87dc8260a5c37bc1b03eb66174741a0}{condition} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}) const }
59\label{classepdf_e87dc8260a5c37bc1b03eb66174741a0}
60
61\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classRV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
62\hypertarget{classepdf_38de9f59b65ee06028554f3f74b66025}{
63virtual \hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classepdf_38de9f59b65ee06028554f3f74b66025}{marginal} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}) const }
64\label{classepdf_38de9f59b65ee06028554f3f74b66025}
65
66\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classRV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
67\hypertarget{classepdf_bf0a070a8f3e67a93604ca724638b870}{
68virtual vec \hyperlink{classepdf_bf0a070a8f3e67a93604ca724638b870}{mean} () const =0}
69\label{classepdf_bf0a070a8f3e67a93604ca724638b870}
70
71\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
72\hypertarget{classepdf_29f17cea338692f4cb6d4ac9f7d89e1f}{
73virtual vec \hyperlink{classepdf_29f17cea338692f4cb6d4ac9f7d89e1f}{variance} () const =0}
74\label{classepdf_29f17cea338692f4cb6d4ac9f7d89e1f}
75
76\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
77\hypertarget{classepdf_0a322dd106f04c0a2915e3d4f4227396}{
78virtual \hyperlink{classepdf_0a322dd106f04c0a2915e3d4f4227396}{$\sim$epdf} ()}
79\label{classepdf_0a322dd106f04c0a2915e3d4f4227396}
80
81\begin{CompactList}\small\item\em Destructor for future use;. \item\end{CompactList}\item 
82\hypertarget{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{
83const \hyperlink{classRV}{RV} \& \hyperlink{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{\_\-rv} () const }
84\label{classepdf_ca0d32aabb4cbba347e0c37fe8607562}
85
86\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
87\hypertarget{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{
88void \hyperlink{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{\_\-renewrv} (const \hyperlink{classRV}{RV} \&in\_\-rv)}
89\label{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}
90
91\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
92\subsection*{Protected Attributes}
93\begin{CompactItemize}
94\item 
95\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
96\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
97\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
98
99\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
100
101
102\subsection{Detailed Description}
103Probability density function with numerical statistics, e.g. posterior density.
104
105The documentation for this class was generated from the following files:\begin{CompactItemize}
106\item 
107work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\item 
108work/git/mixpp/bdm/stat/libBM.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.