root/doc/latex/classbdm_1_1euni.tex @ 270

Revision 270, 8.3 kB (checked in by smidl, 17 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

RevLine 
[261]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:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=64pt]{classbdm_1_1euni__inherit__graph}
12\end{center}
13\end{figure}
[270]14
15
16\subsection{Detailed Description}
17Uniform distributed density on a rectangular support. \subsection*{Public Member Functions}
[261]18\begin{CompactItemize}
19\item 
[270]20\hypertarget{classbdm_1_1euni_8887b088e3ab0b01e96b88237d707b97}{
21\hyperlink{classbdm_1_1euni_8887b088e3ab0b01e96b88237d707b97}{euni} ()}
22\label{classbdm_1_1euni_8887b088e3ab0b01e96b88237d707b97}
[261]23
24\begin{CompactList}\small\item\em Defualt constructor. \item\end{CompactList}\item 
25\hypertarget{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}{
26double \textbf{eval} (const vec \&val) const }
27\label{classbdm_1_1euni_c282673b9d33928001e945443f636a1d}
28
29\item 
30\hypertarget{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{
31double \hyperlink{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}{evallog} (const vec \&val) const }
32\label{classbdm_1_1euni_caa07b8307bd793d5339d6583e0aba81}
33
34\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
35\hypertarget{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{
36vec \hyperlink{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}{sample} () const }
37\label{classbdm_1_1euni_fc5df80359ead2918384b2004ce67194}
38
[270]39\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
[261]40\hypertarget{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}{
41void \hyperlink{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}{set\_\-parameters} (const vec \&low0, const vec \&high0)}
42\label{classbdm_1_1euni_8e130b323c62b42f1699537f99af6f09}
43
44\begin{CompactList}\small\item\em set values of {\tt low} and {\tt high} \item\end{CompactList}\item 
45\hypertarget{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{
46vec \hyperlink{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}{mean} () const }
47\label{classbdm_1_1euni_46caa8c13aba2e6228f964208918b226}
48
49\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
50\hypertarget{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{
51vec \hyperlink{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}{variance} () const }
52\label{classbdm_1_1euni_951f932155111f6053c980f672b4c22c}
53
[270]54\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\end{CompactItemize}
55\begin{Indent}{\bf Matematical Operations}\par
56\begin{CompactItemize}
57\item 
[261]58\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
59virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
60\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
61
[270]62\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
[261]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
[270]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}\end{CompactItemize}
78\end{Indent}
79\begin{Indent}{\bf Connection to other classes}\par
80{\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}
81\item 
82\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
83void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
84\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}
85
86\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
87\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
88bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
89\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}
90
91\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
[261]92\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
93const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
94\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
95
[270]96\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
97\end{Indent}
98\begin{Indent}{\bf Access to attributes}\par
99\begin{CompactItemize}
100\item 
101\hypertarget{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{
102bool \hyperlink{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{dimension} () const }
103\label{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}
[261]104
[270]105\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
106\end{Indent}
[261]107\subsection*{Protected Attributes}
108\begin{CompactItemize}
109\item 
110\hypertarget{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{
111vec \hyperlink{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}{low}}
112\label{classbdm_1_1euni_ff7ce6a2ef5ef0015bbd1398bed12f32}
113
114\begin{CompactList}\small\item\em lower bound on support \item\end{CompactList}\item 
115\hypertarget{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{
116vec \hyperlink{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}{high}}
117\label{classbdm_1_1euni_cfad2dea4a62db6872bda8abd75f0de1}
118
119\begin{CompactList}\small\item\em upper bound on support \item\end{CompactList}\item 
120\hypertarget{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{
121vec \hyperlink{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}{distance}}
122\label{classbdm_1_1euni_d3c27e331f90c754d80228108de8ed4c}
123
124\begin{CompactList}\small\item\em internal \item\end{CompactList}\item 
125\hypertarget{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{
126double \hyperlink{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}{nk}}
127\label{classbdm_1_1euni_31bb13e8449a8eff35246d46dae35c20}
128
129\begin{CompactList}\small\item\em normalizing coefficients \item\end{CompactList}\item 
130\hypertarget{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{
131double \hyperlink{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}{lnk}}
132\label{classbdm_1_1euni_3e63be48dd58659663ca60cd18700476}
133
134\begin{CompactList}\small\item\em cache of log( {\tt nk} ) \item\end{CompactList}\item 
[270]135\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
136int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
137\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}
138
139\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
[261]140\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
141\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
142\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
143
[270]144\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
[261]145
146
147The documentation for this class was generated from the following file:\begin{CompactItemize}
148\item 
149\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.