root/doc/latex/classbdm_1_1enorm.tex @ 271

\hypertarget{classbdm_1_1enorm}{
\section{bdm::enorm$<$ sq\_\-T $>$ Class Template Reference}
\label{classbdm_1_1enorm}\index{bdm::enorm@{bdm::enorm}}
}
{\tt \#include $<$libEF.h$>$}

Inheritance diagram for bdm::enorm$<$ sq\_\-T $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classbdm_1_1enorm}
\end{center}
\end{figure}


\subsection{Detailed Description}
\subsubsection*{template$<$class sq\_\-T$>$ class bdm::enorm$<$ sq\_\-T $>$}

Gaussian density with positive definite (decomposed) covariance matrix. 

More?... \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{
virtual void \hyperlink{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}{dupdate} (mat \&v)}
\label{classbdm_1_1eEF_deef7d6273ba4d5a5cf0bbd91ec7277a}

\begin{CompactList}\small\item\em TODO decide if it is really needed. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{
virtual double \hyperlink{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}{evallog} (const vec \&val) const }
\label{classbdm_1_1eEF_a36d06ecdd6f4c79dc122510eaccc692}

\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{
virtual vec \hyperlink{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}{evallog} (const mat \&Val) const }
\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41}

\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{
virtual void \hyperlink{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}{pow} (double p)}
\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053}

\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\end{CompactItemize}
\begin{Indent}{\bf Constructors}\par
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1enorm_ccc42fd86d4532de03e0d2a0075e066c}{
\textbf{enorm} ()}
\label{classbdm_1_1enorm_ccc42fd86d4532de03e0d2a0075e066c}

\item 
\hypertarget{classbdm_1_1enorm_4c9db749e205a0605ad9c93470f6dcaa}{
\textbf{enorm} (const vec \&\hyperlink{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{mu}, const sq\_\-T \&\hyperlink{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{R})}
\label{classbdm_1_1enorm_4c9db749e205a0605ad9c93470f6dcaa}

\item 
\hypertarget{classbdm_1_1enorm_b8322f2c11560871dd922c660f4771bb}{
void \textbf{set\_\-parameters} (const vec \&\hyperlink{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{mu}, const sq\_\-T \&\hyperlink{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{R})}
\label{classbdm_1_1enorm_b8322f2c11560871dd922c660f4771bb}

\end{CompactItemize}
\end{Indent}
\begin{Indent}{\bf Mathematical operations}\par
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}{
void \hyperlink{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}{dupdate} (mat \&v, double nu=1.0)}
\label{classbdm_1_1enorm_d2e0d3a1e30ab3ab04df2d0c43ae74a2}

\begin{CompactList}\small\item\em dupdate in exponential form (not really handy) \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}{
vec \hyperlink{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}{sample} () const }
\label{classbdm_1_1enorm_e1a48f52351ec3a349bd443b713b1766}

\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_ebd96125aed74f9504033bb3605849db}{
mat \textbf{sample} (int N) const }
\label{classbdm_1_1enorm_ebd96125aed74f9504033bb3605849db}

\item 
\hypertarget{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}{
double \hyperlink{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}{evallog\_\-nn} (const vec \&val) const }
\label{classbdm_1_1enorm_e13aeed5b543b2179bacdc4fa2ae47a3}

\begin{CompactList}\small\item\em Evaluate normalized log-probability. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}{
double \hyperlink{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}{lognc} () const }
\label{classbdm_1_1enorm_25785343aff102cc5df1cab08ba16d32}

\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}{
vec \hyperlink{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}{mean} () const }
\label{classbdm_1_1enorm_b2fa2915c35366392fe9bb022ca1a600}

\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}{
vec \hyperlink{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}{variance} () const }
\label{classbdm_1_1enorm_729c75ef0fa8abae03d58ad1f81e6773}

\begin{CompactList}\small\item\em return expected variance (not covariance!) \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}{
\hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}{condition} (const \hyperlink{classbdm_1_1RV}{RV} \&rvn) const }
\label{classbdm_1_1enorm_baea4d49c657342b58297d68cda16d26}

\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 
\hypertarget{classbdm_1_1enorm_cd02d76e9d4f96bdd3fa6b604e273039}{
\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 }
\label{classbdm_1_1enorm_cd02d76e9d4f96bdd3fa6b604e273039}

\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}
\end{Indent}
\begin{Indent}{\bf Access to attributes}\par
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1enorm_766127847e9482aea9226ea157295ea2}{
vec \& \textbf{\_\-mu} ()}
\label{classbdm_1_1enorm_766127847e9482aea9226ea157295ea2}

\item 
\hypertarget{classbdm_1_1enorm_8915d68ae76ad185c8c314f960a63f0c}{
void \textbf{set\_\-mu} (const vec mu0)}
\label{classbdm_1_1enorm_8915d68ae76ad185c8c314f960a63f0c}

\item 
\hypertarget{classbdm_1_1enorm_81d81e35e57c9f194bde248e3affcf1f}{
sq\_\-T \& \textbf{\_\-R} ()}
\label{classbdm_1_1enorm_81d81e35e57c9f194bde248e3affcf1f}

\item 
\hypertarget{classbdm_1_1enorm_8c664b024e79f18ca3f8e8cc81af2103}{
const sq\_\-T \& \textbf{\_\-R} () const }
\label{classbdm_1_1enorm_8c664b024e79f18ca3f8e8cc81af2103}

\end{CompactItemize}
\end{Indent}
\begin{Indent}{\bf Constructors}\par
{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize}
\item empty constructor, \item copy constructor,\end{itemize}
The following constructors should be supported for convenience: \begin{itemize}
\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize}
All 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}
\item 
\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{
void \textbf{set\_\-parameters} (int dim0)}
\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}

\end{CompactItemize}
\end{Indent}
\begin{Indent}{\bf Matematical Operations}\par
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{
virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const }
\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}

\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{
virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const }
\label{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}

\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\end{CompactItemize}
\end{Indent}
\begin{Indent}{\bf Connection to other classes}\par
{\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}
\item 
\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{
void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}

\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{
bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const }
\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}

\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{
const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const }
\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}

\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize}
\end{Indent}
\begin{Indent}{\bf Access to attributes}\par
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{
int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const }
\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}

\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
\end{Indent}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{
vec \hyperlink{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}{mu}}
\label{classbdm_1_1enorm_c702a194720853570d08b65482f842c7}

\begin{CompactList}\small\item\em mean value \item\end{CompactList}\item 
\hypertarget{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{
sq\_\-T \hyperlink{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}{R}}
\label{classbdm_1_1enorm_2d92dde696b2a7a5b10ddef5d22ba2c2}

\begin{CompactList}\small\item\em Covariance matrix in decomposed form. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{
int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}}
\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}

\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item 
\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{
\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}}
\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}

\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{libEF_8h}{libEF.h}\end{CompactItemize}