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_1egiw.tex

    r261 r270  
    33\label{classbdm_1_1egiw}\index{bdm::egiw@{bdm::egiw}} 
    44} 
    5 Gauss-inverse-Wishart density stored in LD form.   
    6  
    7  
    85{\tt \#include $<$libEF.h$>$} 
    96 
    … …  
    1512\end{center} 
    1613\end{figure} 
    17 Collaboration diagram for bdm::egiw:\nopagebreak 
    18 \begin{figure}[H] 
    19 \begin{center} 
    20 \leavevmode 
    21 \includegraphics[width=89pt]{classbdm_1_1egiw__coll__graph} 
    22 \end{center} 
    23 \end{figure} 
    24 \subsection*{Public Member Functions} 
    25 \begin{CompactItemize} 
    26 \item  
    27 \hypertarget{classbdm_1_1egiw_a60e072c191acf65ab480deeb11c5b88}{ 
    28 \hyperlink{classbdm_1_1egiw_a60e072c191acf65ab480deeb11c5b88}{egiw} (\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}, mat V0, double nu0=-1.0)} 
    29 \label{classbdm_1_1egiw_a60e072c191acf65ab480deeb11c5b88} 
    30  
    31 \begin{CompactList}\small\item\em Default constructor, if nu0$<$0 a minimal nu0 will be computed. \item\end{CompactList}\item  
    32 \hypertarget{classbdm_1_1egiw_bc3db93cb60dd29187eb3c6cfd557f97}{ 
    33 \hyperlink{classbdm_1_1egiw_bc3db93cb60dd29187eb3c6cfd557f97}{egiw} (\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}, \hyperlink{classldmat}{ldmat} V0, double nu0=-1.0)} 
    34 \label{classbdm_1_1egiw_bc3db93cb60dd29187eb3c6cfd557f97} 
    35  
    36 \begin{CompactList}\small\item\em Full constructor for V in \hyperlink{classldmat}{ldmat} form. \item\end{CompactList}\item  
     14 
     15 
     16\subsection{Detailed Description} 
     17Gauss-inverse-Wishart density stored in LD form.  
     18 
     19For $p$-variate densities, given rv.count() should be $p\times$ V.rows(). \subsection*{Public Member Functions} 
     20\begin{CompactItemize} 
     21\item  
    3722\hypertarget{classbdm_1_1egiw_920f21548b7a3723923dd108fe514c61}{ 
    3823vec \hyperlink{classbdm_1_1egiw_920f21548b7a3723923dd108fe514c61}{sample} () const } 
    3924\label{classbdm_1_1egiw_920f21548b7a3723923dd108fe514c61} 
    4025 
    41 \begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item  
     26\begin{CompactList}\small\item\em Returns a sample, $ x $ from density $ f_x()$. \item\end{CompactList}\item  
    4227\hypertarget{classbdm_1_1egiw_df70c05f918c3a6f86d60f10c1fd6ba2}{ 
    4328vec \hyperlink{classbdm_1_1egiw_df70c05f918c3a6f86d60f10c1fd6ba2}{mean} () const } 
    … …  
    6550 
    6651\begin{CompactList}\small\item\em logarithm of the normalizing constant, $\mathcal{I}$ \item\end{CompactList}\item  
    67 \hypertarget{classbdm_1_1egiw_15792f3112e5cf67d572f491b09324c8}{ 
    68 \hyperlink{classldmat}{ldmat} \& \hyperlink{classbdm_1_1egiw_15792f3112e5cf67d572f491b09324c8}{\_\-V} ()} 
    69 \label{classbdm_1_1egiw_15792f3112e5cf67d572f491b09324c8} 
    70  
    71 \begin{CompactList}\small\item\em returns a pointer to the internal statistics. Use with Care! \item\end{CompactList}\item  
    72 \hypertarget{classbdm_1_1egiw_ad9c539a80a552e837245ddcebcbbba4}{ 
    73 const \hyperlink{classldmat}{ldmat} \& \hyperlink{classbdm_1_1egiw_ad9c539a80a552e837245ddcebcbbba4}{\_\-V} () const } 
    74 \label{classbdm_1_1egiw_ad9c539a80a552e837245ddcebcbbba4} 
    75  
    76 \begin{CompactList}\small\item\em returns a pointer to the internal statistics. Use with Care! \item\end{CompactList}\item  
    77 \hypertarget{classbdm_1_1egiw_a025ee710274ca142dd0ae978735ad4a}{ 
    78 double \& \hyperlink{classbdm_1_1egiw_a025ee710274ca142dd0ae978735ad4a}{\_\-nu} ()} 
    79 \label{classbdm_1_1egiw_a025ee710274ca142dd0ae978735ad4a} 
    80  
    81 \begin{CompactList}\small\item\em returns a pointer to the internal statistics. Use with Care! \item\end{CompactList}\item  
    82 \hypertarget{classbdm_1_1egiw_cf3b2bcb158c15c24788bba90e4154e4}{ 
    83 const double \& \textbf{\_\-nu} () const } 
    84 \label{classbdm_1_1egiw_cf3b2bcb158c15c24788bba90e4154e4} 
    85  
    86 \item  
    8752\hypertarget{classbdm_1_1egiw_8e610e95401a11baf34f65e16ecd87be}{ 
    8853void \hyperlink{classbdm_1_1egiw_8e610e95401a11baf34f65e16ecd87be}{pow} (double p)} 
    … …  
    10469\label{classbdm_1_1eEF_79a7c8ea8c02e45d410bd1d7ffd72b41} 
    10570 
    106 \begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\item  
     71\begin{CompactList}\small\item\em Evaluate normalized log-probability for many samples. \item\end{CompactList}\end{CompactItemize} 
     72\begin{Indent}{\bf Constructors}\par 
     73\begin{CompactItemize} 
     74\item  
     75\hypertarget{classbdm_1_1egiw_50149cf136c9120b4fff71c117f0bb2e}{ 
     76\textbf{egiw} ()} 
     77\label{classbdm_1_1egiw_50149cf136c9120b4fff71c117f0bb2e} 
     78 
     79\item  
     80\hypertarget{classbdm_1_1egiw_79037e048e717a076f342eb1d276870e}{ 
     81\textbf{egiw} (int dimx0, \hyperlink{classldmat}{ldmat} V0, double nu0=-1.0)} 
     82\label{classbdm_1_1egiw_79037e048e717a076f342eb1d276870e} 
     83 
     84\item  
     85\hypertarget{classbdm_1_1egiw_40b04f8ef133d089c4be2c7983e18b5c}{ 
     86void \textbf{set\_\-parameters} (int dimx0, \hyperlink{classldmat}{ldmat} V0, double nu0=-1.0)} 
     87\label{classbdm_1_1egiw_40b04f8ef133d089c4be2c7983e18b5c} 
     88 
     89\end{CompactItemize} 
     90\end{Indent} 
     91\begin{Indent}{\bf Access attributes}\par 
     92\begin{CompactItemize} 
     93\item  
     94\hypertarget{classbdm_1_1egiw_15792f3112e5cf67d572f491b09324c8}{ 
     95\hyperlink{classldmat}{ldmat} \& \textbf{\_\-V} ()} 
     96\label{classbdm_1_1egiw_15792f3112e5cf67d572f491b09324c8} 
     97 
     98\item  
     99\hypertarget{classbdm_1_1egiw_ad9c539a80a552e837245ddcebcbbba4}{ 
     100const \hyperlink{classldmat}{ldmat} \& \textbf{\_\-V} () const } 
     101\label{classbdm_1_1egiw_ad9c539a80a552e837245ddcebcbbba4} 
     102 
     103\item  
     104\hypertarget{classbdm_1_1egiw_a025ee710274ca142dd0ae978735ad4a}{ 
     105double \& \textbf{\_\-nu} ()} 
     106\label{classbdm_1_1egiw_a025ee710274ca142dd0ae978735ad4a} 
     107 
     108\item  
     109\hypertarget{classbdm_1_1egiw_cf3b2bcb158c15c24788bba90e4154e4}{ 
     110const double \& \textbf{\_\-nu} () const } 
     111\label{classbdm_1_1egiw_cf3b2bcb158c15c24788bba90e4154e4} 
     112 
     113\end{CompactItemize} 
     114\end{Indent} 
     115\begin{Indent}{\bf Matematical Operations}\par 
     116\begin{CompactItemize} 
     117\item  
    107118\hypertarget{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{ 
    108119virtual mat \hyperlink{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058}{sample\_\-m} (int N) const } 
    109120\label{classbdm_1_1epdf_b4cf45fd83cc7573ede9fe1215256058} 
    110121 
    111 \begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item  
     122\begin{CompactList}\small\item\em Returns N samples, $ [x_1 , x_2 , \ldots \ $ from density $ f_x(rv)$. \item\end{CompactList}\item  
    112123\hypertarget{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{ 
    113124virtual vec \hyperlink{classbdm_1_1epdf_34956d4dd3176eeb5937cf48a1546b62}{evallog\_\-m} (const mat \&Val) const } 
    … …  
    124135\label{classbdm_1_1epdf_3fb2ece54f720b62ad325e61214fa0a1} 
    125136 
    126 \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  
     137\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} 
     138\end{Indent} 
     139\begin{Indent}{\bf Connection to other classes}\par 
     140{\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} 
     141\item  
     142\hypertarget{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{ 
     143void \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)} 
     144\label{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff} 
     145 
     146\begin{CompactList}\small\item\em Name its rv. \item\end{CompactList}\item  
     147\hypertarget{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{ 
     148bool \hyperlink{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9}{isnamed} () const } 
     149\label{classbdm_1_1epdf_c4b863ff84c7a4882fb3ad18556027f9} 
     150 
     151\begin{CompactList}\small\item\em True if rv is assigned. \item\end{CompactList}\item  
    127152\hypertarget{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{ 
    128153const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21}{\_\-rv} () const } 
    129154\label{classbdm_1_1epdf_a4ab378d5e004c3ff3e2d4e64f7bba21} 
    130155 
    131 \begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item  
    132 \hypertarget{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{ 
    133 void \hyperlink{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f}{\_\-renewrv} (const \hyperlink{classbdm_1_1RV}{RV} \&in\_\-rv)} 
    134 \label{classbdm_1_1epdf_62e88cbce0ce77a8692f5e15d76e805f} 
    135  
    136 \begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize} 
     156\begin{CompactList}\small\item\em Return name (fails when isnamed is false). \item\end{CompactList}\end{CompactItemize} 
     157\end{Indent} 
     158\begin{Indent}{\bf Access to attributes}\par 
     159\begin{CompactItemize} 
     160\item  
     161\hypertarget{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{ 
     162bool \hyperlink{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{dimension} () const } 
     163\label{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b} 
     164 
     165\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize} 
     166\end{Indent} 
    137167\subsection*{Protected Attributes} 
    138168\begin{CompactItemize} 
    … …  
    148178 
    149179\begin{CompactList}\small\item\em Number of data records (degrees of freedom) of sufficient statistics. \item\end{CompactList}\item  
    150 \hypertarget{classbdm_1_1egiw_40b68a9c3b2120fba94cc4d2fcd291e1}{ 
    151 int \hyperlink{classbdm_1_1egiw_40b68a9c3b2120fba94cc4d2fcd291e1}{xdim}} 
    152 \label{classbdm_1_1egiw_40b68a9c3b2120fba94cc4d2fcd291e1} 
     180\hypertarget{classbdm_1_1egiw_23e4d78bea7e98840f3da30e76a2b57a}{ 
     181int \hyperlink{classbdm_1_1egiw_23e4d78bea7e98840f3da30e76a2b57a}{dimx}} 
     182\label{classbdm_1_1egiw_23e4d78bea7e98840f3da30e76a2b57a} 
    153183 
    154184\begin{CompactList}\small\item\em Dimension of the output. \item\end{CompactList}\item  
    … …  
    158188 
    159189\begin{CompactList}\small\item\em Dimension of the regressor. \item\end{CompactList}\item  
     190\hypertarget{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{ 
     191int \hyperlink{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce}{dim}} 
     192\label{classbdm_1_1epdf_16adac20ec7fe07e1ea0b27d917788ce} 
     193 
     194\begin{CompactList}\small\item\em dimension of the random variable \item\end{CompactList}\item  
    160195\hypertarget{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{ 
    161196\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8}{rv}} 
    162197\label{classbdm_1_1epdf_62c5b8ff71d9ebe6cd58d3c342eb1dc8} 
    163198 
    164 \begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize} 
    165  
    166  
    167 \subsection{Detailed Description} 
    168 Gauss-inverse-Wishart density stored in LD form.  
    169  
    170 For $p$-variate densities, given rv.count() should be $p\times$ V.rows().  
     199\begin{CompactList}\small\item\em Description of the random variable. \item\end{CompactList}\end{CompactItemize} 
     200 
    171201 
    172202The documentation for this class was generated from the following files:\begin{CompactItemize}