root/doc/latex/classbdm_1_1euni.tex @ 271

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

Next major revision

Line 
1\hypertarget{classbdm_1_1euni}{
2\section{bdm::euni Class Reference}
3\label{classbdm_1_1euni}\index{bdm::euni@{bdm::euni}}
4}
5{\tt \#include $<$libEF.h$>$}
6
7Inheritance diagram for bdm::euni::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=3cm]{classbdm_1_1euni}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Uniform distributed density on a rectangular support. \subsection*{Public Member Functions}
17\begin{CompactItemize}
18\item 
19\hypertarget{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}{
20double \textbf{eval} (const vec \&val) const }
21\label{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}
22
23\item 
24\hypertarget{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{
25double \hyperlink{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{evallog} (const vec \&val) const }
26\label{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}
27
28\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{
30vec \hyperlink{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{sample} () const }
31\label{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}
32
33\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{
35vec \hyperlink{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{mean} () const }
36\label{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}
37
38\begin{CompactList}\small\item\em set values of {\tt low} and {\tt high} \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{
40vec \hyperlink{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{variance} () const }
41\label{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}
42
43\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\end{CompactItemize}
44\begin{Indent}{\bf Constructors}\par
45\begin{CompactItemize}
46\item 
47\hypertarget{classbdm_1_1euni_8887b088e3ab0b01e96b88237d707b97}{
48\textbf{euni} ()}
49\label{classbdm_1_1euni_8887b088e3ab0b01e96b88237d707b97}
50
51\item 
52\hypertarget{classbdm_1_1euni_f40f4e92c36d090fca8300c4e4ae2c4d}{
53\textbf{euni} (const vec \&low0, const vec \&high0)}
54\label{classbdm_1_1euni_f40f4e92c36d090fca8300c4e4ae2c4d}
55
56\item 
57\hypertarget{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}{
58void \textbf{set\_\-parameters} (const vec \&low0, const vec \&high0)}
59\label{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}
60
61\end{CompactItemize}
62\end{Indent}
63\begin{Indent}{\bf Constructors}\par
64{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize}
65\item empty constructor, \item copy constructor,\end{itemize}
66The following constructors should be supported for convenience: \begin{itemize}
67\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize}
68All 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}
69\item 
70\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{
71void \textbf{set\_\-parameters} (int dim0)}
72\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}
73
74\end{CompactItemize}
75\end{Indent}
76\begin{Indent}{\bf Matematical Operations}\par
77\begin{CompactItemize}
78\item 
79\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
80virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
81\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
82
83\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
85virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
86\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
87
88\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}{
90virtual \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 }
91\label{classbdm_1_1epdf_e584eac5579c1b6384947ecf66166c77}
92
93\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 
94\hypertarget{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}{
95virtual \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 }
96\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
97
98\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}
99\end{Indent}
100\begin{Indent}{\bf Connection to other classes}\par
101{\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}
102\item 
103\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
104void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
105\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}
106
107\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
108\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
109bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
110\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}
111
112\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
113\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
114const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
115\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
116
117\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
118\end{Indent}
119\begin{Indent}{\bf Access to attributes}\par
120\begin{CompactItemize}
121\item 
122\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{
123int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const }
124\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}
125
126\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
127\end{Indent}
128\subsection*{Protected Attributes}
129\begin{CompactItemize}
130\item 
131\hypertarget{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{
132vec \hyperlink{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{low}}
133\label{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}
134
135\begin{CompactList}\small\item\em lower bound on support \item\end{CompactList}\item 
136\hypertarget{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{
137vec \hyperlink{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{high}}
138\label{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}
139
140\begin{CompactList}\small\item\em upper bound on support \item\end{CompactList}\item 
141\hypertarget{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{
142vec \hyperlink{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{distance}}
143\label{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}
144
145\begin{CompactList}\small\item\em internal \item\end{CompactList}\item 
146\hypertarget{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{
147double \hyperlink{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{nk}}
148\label{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}
149
150\begin{CompactList}\small\item\em normalizing coefficients \item\end{CompactList}\item 
151\hypertarget{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{
152double \hyperlink{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{lnk}}
153\label{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}
154
155\begin{CompactList}\small\item\em cache of log( {\tt nk} ) \item\end{CompactList}\item 
156\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
157int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
158\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}
159
160\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
161\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
162\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
163\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
164
165\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
166
167
168The documentation for this class was generated from the following file:\begin{CompactItemize}
169\item 
170\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.