Changeset 270 for doc/latex/classbdm_1_1BMEF.tex

Timestamp:

02/16/09 10:02:08 (16 years ago)

Author:

smidl

Message:

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

Files:

• doc/latex/classbdm_1_1BMEF.tex (modified) (8 diffs)

doc/latex/classbdm_1_1BMEF.tex

@@ -3 +3 @@
 \label{classbdm_1_1BMEF}\index{bdm::BMEF@{bdm::BMEF}}
 }
-Estimator for Exponential family.  
-
-
 {\tt \#include $<$libEF.h$>$}
 
@@ -15 +12 @@
 \end{center}
 \end{figure}
-Collaboration diagram for bdm::BMEF:\nopagebreak
-\begin{figure}[H]
-\begin{center}
-\leavevmode
-\includegraphics[width=75pt]{classbdm_1_1BMEF__coll__graph}
-\end{center}
-\end{figure}
-\subsection*{Public Member Functions}
-\begin{CompactItemize}
-\item 
-\hypertarget{classbdm_1_1BMEF_73bccd1d8142d4d330e35637ca30decc}{
-\hyperlink{classbdm_1_1BMEF_73bccd1d8142d4d330e35637ca30decc}{BMEF} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}{rv}, double frg0=1.0)}
-\label{classbdm_1_1BMEF_73bccd1d8142d4d330e35637ca30decc}
-
-\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
+
+
+\subsection{Detailed Description}
+Estimator for Exponential family. \subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+\hypertarget{classbdm_1_1BMEF_2def512872ed8a4fc3b702371ec0be55}{
+\hyperlink{classbdm_1_1BMEF_2def512872ed8a4fc3b702371ec0be55}{BMEF} (double frg0=1.0)}
+\label{classbdm_1_1BMEF_2def512872ed8a4fc3b702371ec0be55}
+
+\begin{CompactList}\small\item\em Default constructor (=empty constructor). \item\end{CompactList}\item 
 \hypertarget{classbdm_1_1BMEF_9662379513101405e159e76717104e62}{
 \hyperlink{classbdm_1_1BMEF_9662379513101405e159e76717104e62}{BMEF} (const \hyperlink{classbdm_1_1BMEF}{BMEF} \&B)}
@@ -56 +49 @@
 \label{classbdm_1_1BMEF_5912dbcf28ae711e30b08c2fa766a3e6}
 
-\begin{CompactList}\small\item\em Flatten the posterior as if to keep nu0 data. \item\end{CompactList}\item 
+\begin{CompactList}\small\item\em Flatten the posterior as if to keep nu0 data. \item\end{CompactList}\end{CompactItemize}
+\begin{Indent}{\bf Constructors}\par
+\begin{CompactItemize}
+\item 
+virtual \hyperlink{classbdm_1_1BM}{BM} $\ast$ \hyperlink{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff}{\_\-copy\_\-} ()
+\end{CompactItemize}
+\end{Indent}
+\begin{Indent}{\bf Mathematical operations}\par
+\begin{CompactItemize}
+\item 
 \hypertarget{classbdm_1_1BM_1dee3fddaf021e62d925289660a707dc}{
 virtual void \hyperlink{classbdm_1_1BM_1dee3fddaf021e62d925289660a707dc}{bayesB} (const mat \&Dt)}
@@ -62 +64 @@
 
 \begin{CompactList}\small\item\em Batch Bayes rule (columns of Dt are observations). \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1BM_963258c4c2dd05be001003b19aceefef}{
-virtual const \hyperlink{classbdm_1_1epdf}{epdf} \& \hyperlink{classbdm_1_1BM_963258c4c2dd05be001003b19aceefef}{\_\-epdf} () const =0}
-\label{classbdm_1_1BM_963258c4c2dd05be001003b19aceefef}
-
-\begin{CompactList}\small\item\em Returns a reference to the \hyperlink{classbdm_1_1epdf}{epdf} representing posterior density on parameters. \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1BM_4ed0f8b880e606316ae800f3a011c3a6}{
-virtual const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1BM_4ed0f8b880e606316ae800f3a011c3a6}{\_\-e} () const =0}
-\label{classbdm_1_1BM_4ed0f8b880e606316ae800f3a011c3a6}
-
-\begin{CompactList}\small\item\em Returns a pointer to the \hyperlink{classbdm_1_1epdf}{epdf} representing posterior density on parameters. Use with care! \item\end{CompactList}\item 
 virtual double \hyperlink{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0}{logpred} (const vec \&dt) const 
 \item 
@@ -79 +71 @@
 
 \begin{CompactList}\small\item\em Matrix version of logpred. \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1BM_710e7d69c0d8791fb41a7cd4683cca2c}{
-virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1BM_710e7d69c0d8791fb41a7cd4683cca2c}{predictor} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}{rv}) const }
-\label{classbdm_1_1BM_710e7d69c0d8791fb41a7cd4683cca2c}
-
-\begin{CompactList}\small\item\em Constructs a predictive density (marginal density on data). \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1BM_40a3c891996391e3135518053a917793}{
-const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1BM_40a3c891996391e3135518053a917793}{\_\-rv} () const }
-\label{classbdm_1_1BM_40a3c891996391e3135518053a917793}
-
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
+\hypertarget{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba}{
+virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba}{epredictor} () const }
+\label{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba}
+
+\begin{CompactList}\small\item\em Constructs a predictive density $ f(d_{t+1} |d_{t}, \ldots d_{0}) $. \item\end{CompactList}\item 
+\hypertarget{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912}{
+virtual \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912}{predictor} () const }
+\label{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912}
+
+\begin{CompactList}\small\item\em Constructs a conditional density 1-step ahead predictor. \item\end{CompactList}\end{CompactItemize}
+\end{Indent}
+\begin{Indent}{\bf Access to attributes}\par
+\begin{CompactItemize}
+\item 
 \hypertarget{classbdm_1_1BM_ff2d8755ba0b3def927d31305c03b09c}{
-const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1BM_ff2d8755ba0b3def927d31305c03b09c}{\_\-drv} () const }
+const \hyperlink{classbdm_1_1RV}{RV} \& \textbf{\_\-drv} () const }
 \label{classbdm_1_1BM_ff2d8755ba0b3def927d31305c03b09c}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
+\item 
 \hypertarget{classbdm_1_1BM_f135ae6dce7e9f30c9f88229c7930b96}{
-void \hyperlink{classbdm_1_1BM_f135ae6dce7e9f30c9f88229c7930b96}{set\_\-drv} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}{rv})}
+void \textbf{set\_\-drv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv)}
 \label{classbdm_1_1BM_f135ae6dce7e9f30c9f88229c7930b96}
 
-\begin{CompactList}\small\item\em set drv \item\end{CompactList}\item 
+\item 
 \hypertarget{classbdm_1_1BM_5be65d37dedfe33a3671e7065f523a70}{
-double \hyperlink{classbdm_1_1BM_5be65d37dedfe33a3671e7065f523a70}{\_\-ll} () const }
+double \textbf{\_\-ll} () const }
 \label{classbdm_1_1BM_5be65d37dedfe33a3671e7065f523a70}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
+\item 
 \hypertarget{classbdm_1_1BM_236b3abbcc93594fc97cd86d82c1a83f}{
-void \hyperlink{classbdm_1_1BM_236b3abbcc93594fc97cd86d82c1a83f}{set\_\-evalll} (bool evl0)}
+void \textbf{set\_\-evalll} (bool evl0)}
 \label{classbdm_1_1BM_236b3abbcc93594fc97cd86d82c1a83f}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
+\item 
+\hypertarget{classbdm_1_1BM_963258c4c2dd05be001003b19aceefef}{
+virtual const \hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} () const =0}
+\label{classbdm_1_1BM_963258c4c2dd05be001003b19aceefef}
+
+\item 
+\hypertarget{classbdm_1_1BM_4ed0f8b880e606316ae800f3a011c3a6}{
+virtual const \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} () const =0}
+\label{classbdm_1_1BM_4ed0f8b880e606316ae800f3a011c3a6}
+
+\end{CompactItemize}
+\end{Indent}
 \subsection*{Protected Attributes}
 \begin{CompactItemize}
@@ -122 +129 @@
 
 \begin{CompactList}\small\item\em cached value of lognc() in the previous step (used in evaluation of {\tt ll} ) \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}{
-\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}{rv}}
-\label{classbdm_1_1BM_18d6db4af8ee42077741d9e3618153ca}
-
-\begin{CompactList}\small\item\em Random variable of the posterior. \item\end{CompactList}\item 
 \hypertarget{classbdm_1_1BM_c400357e37d27a4834b2b1d9211009ed}{
 \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1BM_c400357e37d27a4834b2b1d9211009ed}{drv}}
@@ -143 +145 @@
 \begin{CompactList}\small\item\em If true, the filter will compute likelihood of the data record and store it in {\tt ll} . Set to false if you want to save computational time. \item\end{CompactList}\end{CompactItemize}
 
-
-\subsection{Detailed Description}
-Estimator for Exponential family. 
 
 \subsection{Member Function Documentation}
@@ -168 +167 @@
 Reimplemented in \hyperlink{classbdm_1_1ARX_8bdf2974052e8ce74eb0d4f3791c58a3}{bdm::ARX}, \hyperlink{classbdm_1_1MixEF_5bd7da667da183eed1577f11dff0c1f1}{bdm::MixEF}, and \hyperlink{classbdm_1_1multiBM_1e4bf41b61937fd80f34049742e23f95}{bdm::multiBM}.
 
-References bayes().\hypertarget{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0}{
+References bayes().\hypertarget{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff}{
+\index{bdm::BMEF@{bdm::BMEF}!\_\-copy\_\-@{\_\-copy\_\-}}
+\index{\_\-copy\_\-@{\_\-copy\_\-}!bdm::BMEF@{bdm::BMEF}}
+\subsubsection[\_\-copy\_\-]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf BM}$\ast$ bdm::BM::\_\-copy\_\- ()\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
+\label{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff}
+
+
+Copy function required in vectors, Arrays of \hyperlink{classbdm_1_1BM}{BM} etc. Have to be DELETED manually! Prototype: 
+
+\begin{Code}\begin{verbatim} BM* _copy_(){return new BM(*this);} 
+\end{verbatim}
+\end{Code}
+
+ 
+
+Reimplemented in \hyperlink{classbdm_1_1ARX_60c40b5c6abc4c7e464b4ccae64a5a61}{bdm::ARX}.\hypertarget{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0}{
 \index{bdm::BMEF@{bdm::BMEF}!logpred@{logpred}}
 \index{logpred@{logpred}!bdm::BMEF@{bdm::BMEF}}