root/doc/latex/classbdm_1_1euni.tex @ 261

Revision 261, 7.2 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[261]1\hypertarget{classbdm_1_1euni}{
2\section{bdm::euni Class Reference}
3\label{classbdm_1_1euni}\index{bdm::euni@{bdm::euni}}
4}
5Uniform distributed density on a rectangular support. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for bdm::euni:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1euni__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::euni:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=75pt]{classbdm_1_1euni__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1euni_dca02eda833d6295e0c19f6e120b64e0}{
28\hyperlink{classbdm_1_1euni_dca02eda833d6295e0c19f6e120b64e0}{euni} (const \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv})}
29\label{classbdm_1_1euni_dca02eda833d6295e0c19f6e120b64e0}
30
31\begin{CompactList}\small\item\em Defualt constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}{
33double \textbf{eval} (const vec \&val) const }
34\label{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}
35
36\item 
37\hypertarget{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{
38double \hyperlink{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{evallog} (const vec \&val) const }
39\label{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}
40
41\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{
43vec \hyperlink{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{sample} () const }
44\label{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}
45
46\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}{
48void \hyperlink{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}{set\_\-parameters} (const vec \&low0, const vec \&high0)}
49\label{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}
50
51\begin{CompactList}\small\item\em set values of {\tt low} and {\tt high} \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{
53vec \hyperlink{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{mean} () const }
54\label{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}
55
56\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
57\hypertarget{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{
58vec \hyperlink{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{variance} () const }
59\label{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}
60
61\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
63virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
64\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
65
66\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
68virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
69\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
70
71\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
73virtual \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 }
74\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
75
76\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 
77\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
78virtual \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 }
79\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
80
81\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 
82\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
83const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
84\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
85
86\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
87\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
88void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
89\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
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{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{
96vec \hyperlink{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{low}}
97\label{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}
98
99\begin{CompactList}\small\item\em lower bound on support \item\end{CompactList}\item 
100\hypertarget{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{
101vec \hyperlink{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{high}}
102\label{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}
103
104\begin{CompactList}\small\item\em upper bound on support \item\end{CompactList}\item 
105\hypertarget{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{
106vec \hyperlink{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{distance}}
107\label{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}
108
109\begin{CompactList}\small\item\em internal \item\end{CompactList}\item 
110\hypertarget{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{
111double \hyperlink{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{nk}}
112\label{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}
113
114\begin{CompactList}\small\item\em normalizing coefficients \item\end{CompactList}\item 
115\hypertarget{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{
116double \hyperlink{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{lnk}}
117\label{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}
118
119\begin{CompactList}\small\item\em cache of log( {\tt nk} ) \item\end{CompactList}\item 
120\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
121\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
122\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
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 
132\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.