Show
Ignore:
Timestamp:
09/24/08 13:31:03 (16 years ago)
Author:
smidl
Message:

Latex doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/latex/classmgamma.tex

    r162 r172  
     1\hypertarget{classmgamma}{ 
    12\section{mgamma Class Reference} 
    23\label{classmgamma}\index{mgamma@{mgamma}} 
     4} 
    35Gamma random walk.   
    46 
     
    2325\begin{CompactItemize} 
    2426\item  
    25 {\bf mgamma} (const {\bf RV} \&{\bf rv}, const {\bf RV} \&{\bf rvc})\label{classmgamma_af43e61b86900c0398d5c0ffc83b94e6} 
     27\hypertarget{classmgamma_af43e61b86900c0398d5c0ffc83b94e6}{ 
     28\hyperlink{classmgamma_af43e61b86900c0398d5c0ffc83b94e6}{mgamma} (const \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}, const \hyperlink{classRV}{RV} \&\hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc})} 
     29\label{classmgamma_af43e61b86900c0398d5c0ffc83b94e6} 
    2630 
    2731\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  
    28 void {\bf set\_\-parameters} (double {\bf k})\label{classmgamma_a9d646cf758a70126dde7c48790b6e94} 
     32\hypertarget{classmgamma_a9d646cf758a70126dde7c48790b6e94}{ 
     33void \hyperlink{classmgamma_a9d646cf758a70126dde7c48790b6e94}{set\_\-parameters} (double \hyperlink{classmgamma_43f733cce0245a52363d566099add687}{k})} 
     34\label{classmgamma_a9d646cf758a70126dde7c48790b6e94} 
    2935 
    3036\begin{CompactList}\small\item\em Set value of {\tt k}. \item\end{CompactList}\item  
    31 void {\bf condition} (const vec \&val)\label{classmgamma_a61094c9f7a2d64ea77b130cbc031f97} 
     37\hypertarget{classmgamma_a61094c9f7a2d64ea77b130cbc031f97}{ 
     38void \hyperlink{classmgamma_a61094c9f7a2d64ea77b130cbc031f97}{condition} (const vec \&val)} 
     39\label{classmgamma_a61094c9f7a2d64ea77b130cbc031f97} 
    3240 
    33 \begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \doxyref{mpdf}{p.}{classmpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item  
    34 virtual vec {\bf samplecond} (const vec \&cond, double \&ll) 
    35 \begin{CompactList}\small\item\em Returns the required moment of the \doxyref{epdf}{p.}{classepdf}. \item\end{CompactList}\item  
    36 virtual mat {\bf samplecond} (const vec \&cond, vec \&ll, int N) 
     41\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classmpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item  
     42virtual vec \hyperlink{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{samplecond} (const vec \&cond, double \&ll) 
     43\begin{CompactList}\small\item\em Returns the required moment of the \hyperlink{classepdf}{epdf}. \item\end{CompactList}\item  
     44virtual mat \hyperlink{classmpdf_0e37163660f93df2a4d723cedb1da89c}{samplecond} (const vec \&cond, vec \&ll, int N) 
    3745\begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item  
    38 virtual double {\bf evalcond} (const vec \&dt, const vec \&cond)\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91} 
     46\hypertarget{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{ 
     47virtual double \hyperlink{classmpdf_80b738ece5bd4f8c4edaee4b38906f91}{evalcond} (const vec \&dt, const vec \&cond)} 
     48\label{classmpdf_80b738ece5bd4f8c4edaee4b38906f91} 
    3949 
    40 \begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \doxyref{epdf}{p.}{classepdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item  
    41 {\bf RV} {\bf \_\-rvc} ()\label{classmpdf_ec9c850305984582548e8deb64f0ffe8} 
     50\begin{CompactList}\small\item\em Shortcut for conditioning and evaluation of the internal \hyperlink{classepdf}{epdf}. In some cases, this operation can be implemented efficiently. \item\end{CompactList}\item  
     51\hypertarget{classmpdf_ec9c850305984582548e8deb64f0ffe8}{ 
     52\hyperlink{classRV}{RV} \hyperlink{classmpdf_ec9c850305984582548e8deb64f0ffe8}{\_\-rvc} ()} 
     53\label{classmpdf_ec9c850305984582548e8deb64f0ffe8} 
    4254 
    4355\begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    44 {\bf RV} {\bf \_\-rv} ()\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32} 
     56\hypertarget{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{ 
     57\hyperlink{classRV}{RV} \hyperlink{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32}{\_\-rv} ()} 
     58\label{classmpdf_1e71ad4c66d5884c82d4a3b06b42fe32} 
    4559 
    4660\begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    47 {\bf epdf} \& {\bf \_\-epdf} ()\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8} 
     61\hypertarget{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{ 
     62\hyperlink{classepdf}{epdf} \& \hyperlink{classmpdf_e17780ee5b2cfe05922a6c56af1462f8}{\_\-epdf} ()} 
     63\label{classmpdf_e17780ee5b2cfe05922a6c56af1462f8} 
    4864 
    4965\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize} 
     
    5167\begin{CompactItemize} 
    5268\item  
    53 {\bf egamma} {\bf epdf}\label{classmgamma_612dbf35c770a780027619aaac2c443e} 
     69\hypertarget{classmgamma_612dbf35c770a780027619aaac2c443e}{ 
     70\hyperlink{classegamma}{egamma} \hyperlink{classmgamma_612dbf35c770a780027619aaac2c443e}{epdf}} 
     71\label{classmgamma_612dbf35c770a780027619aaac2c443e} 
    5472 
    55 \begin{CompactList}\small\item\em Internal \doxyref{epdf}{p.}{classepdf} that arise by conditioning on {\tt rvc}. \item\end{CompactList}\item  
    56 double {\bf k}\label{classmgamma_43f733cce0245a52363d566099add687} 
     73\begin{CompactList}\small\item\em Internal \hyperlink{classepdf}{epdf} that arise by conditioning on {\tt rvc}. \item\end{CompactList}\item  
     74\hypertarget{classmgamma_43f733cce0245a52363d566099add687}{ 
     75double \hyperlink{classmgamma_43f733cce0245a52363d566099add687}{k}} 
     76\label{classmgamma_43f733cce0245a52363d566099add687} 
    5777 
    5878\begin{CompactList}\small\item\em Constant $k$. \item\end{CompactList}\item  
    59 vec $\ast$ {\bf \_\-beta}\label{classmgamma_5e90652837448bcc29707e7412f99691} 
     79\hypertarget{classmgamma_5e90652837448bcc29707e7412f99691}{ 
     80vec $\ast$ \hyperlink{classmgamma_5e90652837448bcc29707e7412f99691}{\_\-beta}} 
     81\label{classmgamma_5e90652837448bcc29707e7412f99691} 
    6082 
    6183\begin{CompactList}\small\item\em cache of epdf.beta \item\end{CompactList}\item  
    62 {\bf RV} {\bf rv}\label{classmpdf_f6687c07ff07d47812dd565368ca59eb} 
     84\hypertarget{classmpdf_f6687c07ff07d47812dd565368ca59eb}{ 
     85\hyperlink{classRV}{RV} \hyperlink{classmpdf_f6687c07ff07d47812dd565368ca59eb}{rv}} 
     86\label{classmpdf_f6687c07ff07d47812dd565368ca59eb} 
    6387 
    6488\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item  
    65 {\bf RV} {\bf rvc}\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab} 
     89\hypertarget{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{ 
     90\hyperlink{classRV}{RV} \hyperlink{classmpdf_acb7dda792b3cd5576f39fa3129abbab}{rvc}} 
     91\label{classmpdf_acb7dda792b3cd5576f39fa3129abbab} 
    6692 
    6793\begin{CompactList}\small\item\em random variable in condition \item\end{CompactList}\item  
    68 {\bf epdf} $\ast$ {\bf ep}\label{classmpdf_7aa894208a32f3487827df6d5054424c} 
     94\hypertarget{classmpdf_7aa894208a32f3487827df6d5054424c}{ 
     95\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classmpdf_7aa894208a32f3487827df6d5054424c}{ep}} 
     96\label{classmpdf_7aa894208a32f3487827df6d5054424c} 
    6997 
    70 \begin{CompactList}\small\item\em pointer to internal \doxyref{epdf}{p.}{classepdf} \item\end{CompactList}\end{CompactItemize} 
     98\begin{CompactList}\small\item\em pointer to internal \hyperlink{classepdf}{epdf} \item\end{CompactList}\end{CompactItemize} 
    7199 
    72100 
     
    79107 
    80108\subsection{Member Function Documentation} 
     109\hypertarget{classmpdf_3f172b79ec4a5ebc87898a5381141f1b}{ 
    81110\index{mgamma@{mgamma}!samplecond@{samplecond}} 
    82111\index{samplecond@{samplecond}!mgamma@{mgamma}} 
    83 \subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  [inline, virtual, inherited]}}\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b} 
     112\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual vec mpdf::samplecond (const vec \& {\em cond}, \/  double \& {\em ll})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}} 
     113\label{classmpdf_3f172b79ec4a5ebc87898a5381141f1b} 
    84114 
    85115 
    86 Returns the required moment of the \doxyref{epdf}{p.}{classepdf}.  
     116Returns the required moment of the \hyperlink{classepdf}{epdf}.  
    87117 
    88118Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \begin{Desc} 
     
    93123 
    94124 
     125Reimplemented in \hyperlink{classmprod_a48887eb8738a9e5550bfc38eb8e9d68}{mprod}. 
     126 
    95127References mpdf::condition(), mpdf::ep, epdf::evalpdflog(), and epdf::sample(). 
    96128 
    97 Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\index{mgamma@{mgamma}!samplecond@{samplecond}} 
     129Referenced by MPF$<$ BM\_\-T $>$::bayes(), and PF::bayes().\hypertarget{classmpdf_0e37163660f93df2a4d723cedb1da89c}{ 
     130\index{mgamma@{mgamma}!samplecond@{samplecond}} 
    98131\index{samplecond@{samplecond}!mgamma@{mgamma}} 
    99 \subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  [inline, virtual, inherited]}}\label{classmpdf_0e37163660f93df2a4d723cedb1da89c} 
     132\subsubsection[samplecond]{\setlength{\rightskip}{0pt plus 5cm}virtual mat mpdf::samplecond (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}} 
     133\label{classmpdf_0e37163660f93df2a4d723cedb1da89c} 
    100134 
    101135 
     
    109143 
    110144 
     145Reimplemented in \hyperlink{classmprod_e171c40e210539c2af01d6237785620b}{mprod}. 
     146 
    111147References mpdf::condition(), RV::count(), mpdf::ep, epdf::evalpdflog(), mpdf::rv, and epdf::sample(). 
    112148 
    113149The documentation for this class was generated from the following files:\begin{CompactItemize} 
    114150\item  
    115 work/git/mixpp/bdm/stat/{\bf libEF.h}\item  
     151work/git/mixpp/bdm/stat/\hyperlink{libEF_8h}{libEF.h}\item  
    116152work/git/mixpp/bdm/stat/libEF.cpp\end{CompactItemize}