root/doc/latex/classeuni.tex @ 250

Revision 234, 6.7 kB (checked in by smidl, 16 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classeuni}{
2\section{euni Class Reference}
3\label{classeuni}\index{euni@{euni}}
4}
5Uniform distributed density on a rectangular support. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for euni:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=39pt]{classeuni__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for euni:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=39pt]{classeuni__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classeuni_2537a6c239cff52e3ba814851a1116cd}{
28\hyperlink{classeuni_2537a6c239cff52e3ba814851a1116cd}{euni} (const \hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
29\label{classeuni_2537a6c239cff52e3ba814851a1116cd}
30
31\begin{CompactList}\small\item\em Defualt constructor. \item\end{CompactList}\item 
32\hypertarget{classeuni_2723d4992900b5c5495bfa03628195ed}{
33double \textbf{eval} (const vec \&val) const }
34\label{classeuni_2723d4992900b5c5495bfa03628195ed}
35
36\item 
37\hypertarget{classeuni_357b36417ef4c9211d12e7a4a602fd6a}{
38double \hyperlink{classeuni_357b36417ef4c9211d12e7a4a602fd6a}{evallog} (const vec \&val) const }
39\label{classeuni_357b36417ef4c9211d12e7a4a602fd6a}
40
41\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
42\hypertarget{classeuni_4a0e09392be17beaee120ba98fc038cd}{
43vec \hyperlink{classeuni_4a0e09392be17beaee120ba98fc038cd}{sample} () const }
44\label{classeuni_4a0e09392be17beaee120ba98fc038cd}
45
46\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
47\hypertarget{classeuni_4fd7c6a05100616ad16ece405cad7bf2}{
48void \hyperlink{classeuni_4fd7c6a05100616ad16ece405cad7bf2}{set\_\-parameters} (const vec \&low0, const vec \&high0)}
49\label{classeuni_4fd7c6a05100616ad16ece405cad7bf2}
50
51\begin{CompactList}\small\item\em set values of {\tt low} and {\tt high} \item\end{CompactList}\item 
52\hypertarget{classeuni_8050087e421a9cfd1b4b1f8bd33b1cc1}{
53vec \hyperlink{classeuni_8050087e421a9cfd1b4b1f8bd33b1cc1}{mean} () const }
54\label{classeuni_8050087e421a9cfd1b4b1f8bd33b1cc1}
55
56\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
57\hypertarget{classeuni_15d7d8b2c8f13a0b1535ebc35551f01c}{
58vec \hyperlink{classeuni_15d7d8b2c8f13a0b1535ebc35551f01c}{variance} () const }
59\label{classeuni_15d7d8b2c8f13a0b1535ebc35551f01c}
60
61\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
62\hypertarget{classepdf_76608914c3b19e150292d5c56e93e508}{
63virtual mat \hyperlink{classepdf_76608914c3b19e150292d5c56e93e508}{sample\_\-m} (int N) const }
64\label{classepdf_76608914c3b19e150292d5c56e93e508}
65
66\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
67\hypertarget{classepdf_2495a04bbacb9b55fe5a3a59b78affca}{
68virtual vec \hyperlink{classepdf_2495a04bbacb9b55fe5a3a59b78affca}{evallog\_\-m} (const mat \&Val) const }
69\label{classepdf_2495a04bbacb9b55fe5a3a59b78affca}
70
71\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
72\hypertarget{classepdf_e87dc8260a5c37bc1b03eb66174741a0}{
73virtual \hyperlink{classmpdf}{mpdf} $\ast$ \hyperlink{classepdf_e87dc8260a5c37bc1b03eb66174741a0}{condition} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}) const }
74\label{classepdf_e87dc8260a5c37bc1b03eb66174741a0}
75
76\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 
77\hypertarget{classepdf_38de9f59b65ee06028554f3f74b66025}{
78virtual \hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classepdf_38de9f59b65ee06028554f3f74b66025}{marginal} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}) const }
79\label{classepdf_38de9f59b65ee06028554f3f74b66025}
80
81\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classRV}{RV}, the remainig rvs are intergrated out. \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{classeuni_ef42cd8d7645422048d46c46ec5cdac1}{
96vec \hyperlink{classeuni_ef42cd8d7645422048d46c46ec5cdac1}{low}}
97\label{classeuni_ef42cd8d7645422048d46c46ec5cdac1}
98
99\begin{CompactList}\small\item\em lower bound on support \item\end{CompactList}\item 
100\hypertarget{classeuni_71b6d6b41aeb61a7f76f682b72119231}{
101vec \hyperlink{classeuni_71b6d6b41aeb61a7f76f682b72119231}{high}}
102\label{classeuni_71b6d6b41aeb61a7f76f682b72119231}
103
104\begin{CompactList}\small\item\em upper bound on support \item\end{CompactList}\item 
105\hypertarget{classeuni_52a6ff4a54010f88a6a19fca605c64a4}{
106vec \hyperlink{classeuni_52a6ff4a54010f88a6a19fca605c64a4}{distance}}
107\label{classeuni_52a6ff4a54010f88a6a19fca605c64a4}
108
109\begin{CompactList}\small\item\em internal \item\end{CompactList}\item 
110\hypertarget{classeuni_63105490e946e43372d6187ad1bafdda}{
111double \hyperlink{classeuni_63105490e946e43372d6187ad1bafdda}{nk}}
112\label{classeuni_63105490e946e43372d6187ad1bafdda}
113
114\begin{CompactList}\small\item\em normalizing coefficients \item\end{CompactList}\item 
115\hypertarget{classeuni_f445a0ce24f39d14c1a4eed53fc8e2c3}{
116double \hyperlink{classeuni_f445a0ce24f39d14c1a4eed53fc8e2c3}{lnk}}
117\label{classeuni_f445a0ce24f39d14c1a4eed53fc8e2c3}
118
119\begin{CompactList}\small\item\em cache of log( {\tt nk} ) \item\end{CompactList}\item 
120\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
121\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
122\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
123
124\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
125
126
127\subsection{Detailed Description}
128Uniform distributed density on a rectangular support.
129
130The documentation for this class was generated from the following file:\begin{CompactItemize}
131\item 
132work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.