Show
Ignore:
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:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classbdm_1_1eDirich.tex

    r261 r270  
    33\label{classbdm_1_1eDirich}\index{bdm::eDirich@{bdm::eDirich}} 
    44} 
    5 Dirichlet posterior density.   
    6  
    7  
    85{\tt \#include $<$libEF.h$>$} 
    96 
    … …  
    1512\end{center} 
    1613\end{figure} 
    17 Collaboration diagram for bdm::eDirich:\nopagebreak 
    18 \begin{figure}[H] 
    19 \begin{center} 
    20 \leavevmode 
    21 \includegraphics[width=75pt]{classbdm_1_1eDirich__coll__graph} 
    22 \end{center} 
    23 \end{figure} 
    24 \subsection*{Public Member Functions} 
     14 
     15 
     16\subsection{Detailed Description} 
     17Dirichlet posterior density.  
     18 
     19Continuous Dirichlet density of $n$-dimensional variable $x$ \[ f(x|\beta) = \frac{\Gamma[\gamma]}{\prod_{i=1}^{n}\Gamma(\beta_i)} \prod_{i=1}^{n}x_i^{\beta_i-1} \] where $\gamma=\sum_i \beta_i$. \subsection*{Public Member Functions} 
    2520\begin{CompactItemize} 
    2621\item  
    27 \hypertarget{classbdm_1_1eDirich_2ae893fe9167f67bca09bc159acbf957}{ 
    28 \hyperlink{classbdm_1_1eDirich_2ae893fe9167f67bca09bc159acbf957}{eDirich} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}, const vec \&beta0)} 
    29 \label{classbdm_1_1eDirich_2ae893fe9167f67bca09bc159acbf957} 
     22\hypertarget{classbdm_1_1eDirich_d5137485050ca8d67549b514896f602d}{ 
     23\hyperlink{classbdm_1_1eDirich_d5137485050ca8d67549b514896f602d}{eDirich} ()} 
     24\label{classbdm_1_1eDirich_d5137485050ca8d67549b514896f602d} 
    3025 
    3126\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item  
    … …  
    3934\label{classbdm_1_1eDirich_3290613d31d58daa8a45a54b003871fc} 
    4035 
    41 \begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item  
     36\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item  
    4237\hypertarget{classbdm_1_1eDirich_cb343355ec791298bb5a3404cd482fb6}{ 
    4338vec \hyperlink{classbdm_1_1eDirich_cb343355ec791298bb5a3404cd482fb6}{mean} () const } 
    … …  
    8984\label{classbdm_1_1eEF_cf38af29e8e3d650c640509a52396053} 
    9085 
    91 \begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\item  
     86\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\end{CompactItemize} 
     87\begin{Indent}{\bf Matematical Operations}\par 
     88\begin{CompactItemize} 
     89\item  
    9290\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{ 
    9391virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const } 
    9492\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058} 
    9593 
    96 \begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item  
     94\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item  
    9795\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{ 
    9896virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const } 
    … …  
    109107\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1} 
    110108 
    111 \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  
     109\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} 
     110\end{Indent} 
     111\begin{Indent}{\bf Connection to other classes}\par 
     112{\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} 
     113\item  
     114\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{ 
     115void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)} 
     116\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff} 
     117 
     118\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item  
     119\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{ 
     120bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const } 
     121\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9} 
     122 
     123\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item  
    112124\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{ 
    113125const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const } 
    114126\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21} 
    115127 
    116 \begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item  
    117 \hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{ 
    118 void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)} 
    119 \label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f} 
     128\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize} 
     129\end{Indent} 
     130\begin{Indent}{\bf Access to attributes}\par 
     131\begin{CompactItemize} 
     132\item  
     133\hypertarget{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{ 
     134bool \hyperlink{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{dimension} () const } 
     135\label{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b} 
    120136 
    121 \begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize} 
     137\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize} 
     138\end{Indent} 
    122139\subsection*{Protected Attributes} 
    123140\begin{CompactItemize} 
    … …  
    133150 
    134151\begin{CompactList}\small\item\em speedup variable \item\end{CompactList}\item  
     152\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{ 
     153int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}} 
     154\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce} 
     155 
     156\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item  
    135157\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{ 
    136158\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}} 
    137159\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8} 
    138160 
    139 \begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize} 
     161\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize} 
    140162 
    141  
    142 \subsection{Detailed Description} 
    143 Dirichlet posterior density.  
    144  
    145 Continuous Dirichlet density of $n$-dimensional variable $x$ \[ f(x|\beta) = \frac{\Gamma[\gamma]}{\prod_{i=1}^{n}\Gamma(\beta_i)} \prod_{i=1}^{n}x_i^{\beta_i-1} \] where $\gamma=\sum_i \beta_i$.  
    146163 
    147164The documentation for this class was generated from the following file:\begin{CompactItemize}