root/doc/latex/classbdm_1_1enorm.tex @ 261

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

doc

RevLine 
[261]1\hypertarget{classbdm_1_1enorm}{
2\section{bdm::enorm$<$ sq\_\-T $>$ Class Template Reference}
3\label{classbdm_1_1enorm}\index{bdm::enorm@{bdm::enorm}}
4}
5Gaussian density with positive definite (decomposed) covariance matrix. 
6
7
8{\tt \#include $<$libEF.h$>$}
9
10Inheritance diagram for bdm::enorm$<$ sq\_\-T $>$:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=400pt]{classbdm_1_1enorm__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::enorm$<$ sq\_\-T $>$:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=96pt]{classbdm_1_1enorm__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1enorm_7d433390d6bbad337986945b63d7fbe9}{
28\hyperlink{classbdm_1_1enorm_7d433390d6bbad337986945b63d7fbe9}{enorm} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv})}
29\label{classbdm_1_1enorm_7d433390d6bbad337986945b63d7fbe9}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1enorm_b8322f2c11560871dd922c660f4771bb}{
33void \hyperlink{classbdm_1_1enorm_b8322f2c11560871dd922c660f4771bb}{set\_\-parameters} (const vec \&\hyperlink{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{mu}, const sq\_\-T \&\hyperlink{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{R})}
34\label{classbdm_1_1enorm_b8322f2c11560871dd922c660f4771bb}
35
36\begin{CompactList}\small\item\em Set mean value {\tt mu} and covariance {\tt R}. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}{
38void \hyperlink{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}{dupdate} (mat \&v, double nu=1.0)}
39\label{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}
40
41\begin{CompactList}\small\item\em dupdate in exponential form (not really handy) \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}{
43vec \hyperlink{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}{sample} () const }
44\label{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}
45
46\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1enorm_ebd96125aed74f9504033bb3605849db}{
48mat \hyperlink{classbdm_1_1enorm_ebd96125aed74f9504033bb3605849db}{sample} (int N) const }
49\label{classbdm_1_1enorm_ebd96125aed74f9504033bb3605849db}
50
51\begin{CompactList}\small\item\em TODO is it used? \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}{
53double \hyperlink{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}{evallog\_\-nn} (const vec \&val) const }
54\label{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}
55
56\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
57\hypertarget{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}{
58double \hyperlink{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}{lognc} () const }
59\label{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}
60
61\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}{
63vec \hyperlink{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}{mean} () const }
64\label{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}
65
66\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}{
68vec \hyperlink{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}{variance} () const }
69\label{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}
70
71\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}{
73\hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}{condition} (const \hyperlink{classbdm_1_1RV}{RV} \&rvn) const }
74\label{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}
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_1enorm_cd02d76e9d4f96bdd3fa6b604e273039}{
78\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1enorm_cd02d76e9d4f96bdd3fa6b604e273039}{marginal} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}) const }
79\label{classbdm_1_1enorm_cd02d76e9d4f96bdd3fa6b604e273039}
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_1enorm_766127847e9482aea9226ea157295ea2}{
83vec \& \hyperlink{classbdm_1_1enorm_766127847e9482aea9226ea157295ea2}{\_\-mu} ()}
84\label{classbdm_1_1enorm_766127847e9482aea9226ea157295ea2}
85
86\begin{CompactList}\small\item\em returns a pointer to the internal mean value. Use with Care! \item\end{CompactList}\item 
87\hypertarget{classbdm_1_1enorm_8915d68ae76ad185c8c314f960a63f0c}{
88void \hyperlink{classbdm_1_1enorm_8915d68ae76ad185c8c314f960a63f0c}{set\_\-mu} (const vec mu0)}
89\label{classbdm_1_1enorm_8915d68ae76ad185c8c314f960a63f0c}
90
91\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
92\hypertarget{classbdm_1_1enorm_81d81e35e57c9f194bde248e3affcf1f}{
93sq\_\-T \& \hyperlink{classbdm_1_1enorm_81d81e35e57c9f194bde248e3affcf1f}{\_\-R} ()}
94\label{classbdm_1_1enorm_81d81e35e57c9f194bde248e3affcf1f}
95
96\begin{CompactList}\small\item\em returns pointers to the internal variance and its inverse. Use with Care! \item\end{CompactList}\item 
97\hypertarget{classbdm_1_1enorm_8c664b024e79f18ca3f8e8cc81af2103}{
98const sq\_\-T \& \textbf{\_\-R} () const }
99\label{classbdm_1_1enorm_8c664b024e79f18ca3f8e8cc81af2103}
100
101\item 
102\hypertarget{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{
103virtual void \hyperlink{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{dupdate} (mat \&v)}
104\label{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}
105
106\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
107\hypertarget{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{
108virtual double \hyperlink{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{evallog} (const vec \&val) const }
109\label{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}
110
111\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
112\hypertarget{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{
113virtual vec \hyperlink{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{evallog} (const mat \&Val) const }
114\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}
115
116\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
117\hypertarget{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{
118virtual void \hyperlink{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{pow} (double p)}
119\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}
120
121\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\item 
122\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
123virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
124\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}
125
126\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
127\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
128virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
129\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}
130
131\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
132\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
133const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
134\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}
135
136\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
137\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
138void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
139\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
140
141\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
142\subsection*{Protected Attributes}
143\begin{CompactItemize}
144\item 
145\hypertarget{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{
146vec \hyperlink{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{mu}}
147\label{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}
148
149\begin{CompactList}\small\item\em mean value \item\end{CompactList}\item 
150\hypertarget{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{
151sq\_\-T \hyperlink{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{R}}
152\label{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}
153
154\begin{CompactList}\small\item\em Covariance matrix in decomposed form. \item\end{CompactList}\item 
155\hypertarget{classbdm_1_1enorm_91a2d4a91364b0144e1523cad4d1135b}{
156int \hyperlink{classbdm_1_1enorm_91a2d4a91364b0144e1523cad4d1135b}{dim}}
157\label{classbdm_1_1enorm_91a2d4a91364b0144e1523cad4d1135b}
158
159\begin{CompactList}\small\item\em dimension (redundant from rv.count() for easier coding ) \item\end{CompactList}\item 
160\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
161\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
162\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}
163
164\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
165
166
167\subsection{Detailed Description}
168\subsubsection*{template$<$class sq\_\-T$>$ class bdm::enorm$<$ sq\_\-T $>$}
169
170Gaussian density with positive definite (decomposed) covariance matrix.
171
172More?...
173
174The documentation for this class was generated from the following file:\begin{CompactItemize}
175\item 
176\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.