Changeset 270 for doc/latex/classbdm_1_1merger.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_1merger.tex (modified) (5 diffs)

doc/latex/classbdm_1_1merger.tex

@@ -3 +3 @@
 \label{classbdm_1_1merger}\index{bdm::merger@{bdm::merger}}
 }
-Function for general combination of pdfs.  
-
-
 {\tt \#include $<$merger.h$>$}
 
@@ -15 +12 @@
 \end{center}
 \end{figure}
-Collaboration diagram for bdm::merger:\nopagebreak
-\begin{figure}[H]
-\begin{center}
-\leavevmode
-\includegraphics[width=400pt]{classbdm_1_1merger__coll__graph}
-\end{center}
-\end{figure}
-\subsection*{Public Member Functions}
+
+
+\subsection{Detailed Description}
+Function for general combination of pdfs. 
+
+Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial. \subsection*{Public Member Functions}
 \begin{CompactItemize}
 \item 
@@ -98 +93 @@
 \label{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}
 
-\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\item 
+\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\end{CompactItemize}
+\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 from density $epdf(rv)$. \item\end{CompactList}\item 
+\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 }
@@ -118 +116 @@
 \label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1}
 
-\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 
+\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 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 access function, possibly dangerous! \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{
-void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)}
-\label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}
-
-\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
+\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_46dfe100cd621716ee5c7ee25a20f24b}{
+bool \hyperlink{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{dimension} () const }
+\label{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}
+
+\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}
+\end{Indent}
 \subsection*{Protected Attributes}
 \begin{CompactItemize}
@@ -182 +199 @@
 
 \begin{CompactList}\small\item\em Elements of composition. \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 Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
-
-
-\subsection{Detailed Description}
-Function for general combination of pdfs. 
-
-Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial. 
+\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize}
+
 
 \subsection{Member Function Documentation}