Changeset 270 for doc/latex/classbdm_1_1migamma.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_1migamma.tex (modified) (8 diffs)

doc/latex/classbdm_1_1migamma.tex

@@ -3 +3 @@
 \label{classbdm_1_1migamma}\index{bdm::migamma@{bdm::migamma}}
 }
-Inverse-Gamma random walk.  
-
-
 {\tt \#include $<$libEF.h$>$}
 
@@ -15 +12 @@
 \end{center}
 \end{figure}
-Collaboration diagram for bdm::migamma:\nopagebreak
-\begin{figure}[H]
-\begin{center}
-\leavevmode
-\includegraphics[height=400pt]{classbdm_1_1migamma__coll__graph}
-\end{center}
-\end{figure}
-\subsection*{Public Member Functions}
+
+
+\subsection{Detailed Description}
+Inverse-Gamma random walk. 
+
+Mean value, $ \mu $, of this density is given by {\tt rvc} . Standard deviation of the random walk is proportional to one $ k $-th the mean. This is achieved by setting $ \alpha=\mu/k^2+2 $ and $ \beta=\mu(\alpha-1)$.
+
+The standard deviation of the walk is then: $ \mu/\sqrt(k)$. \subsection*{Public Member Functions}
 \begin{CompactItemize}
 \item 
-\hypertarget{classbdm_1_1migamma_07c5970da0e578ce8a428f1ebf46a459}{
-\hyperlink{classbdm_1_1migamma_07c5970da0e578ce8a428f1ebf46a459}{migamma} (const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{rv}, const \hyperlink{classbdm_1_1RV}{RV} \&\hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc})}
-\label{classbdm_1_1migamma_07c5970da0e578ce8a428f1ebf46a459}
-
-\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1migamma_1d7023b1565551d0260eb1ba832bebaf}{
-void \hyperlink{classbdm_1_1migamma_1d7023b1565551d0260eb1ba832bebaf}{set\_\-parameters} (double k0)}
-\label{classbdm_1_1migamma_1d7023b1565551d0260eb1ba832bebaf}
+\hypertarget{classbdm_1_1migamma_8b10ab922e2a7bae2fb6bb3efc7b6151}{
+void \hyperlink{classbdm_1_1migamma_8b10ab922e2a7bae2fb6bb3efc7b6151}{set\_\-parameters} (int len, double k0)}
+\label{classbdm_1_1migamma_8b10ab922e2a7bae2fb6bb3efc7b6151}
 
 \begin{CompactList}\small\item\em Set value of {\tt k}. \item\end{CompactList}\item 
@@ -39 +31 @@
 \label{classbdm_1_1migamma_7a34b1e2e3aa2250d7c0ed7df1665b8c}
 
-\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classbdm_1_1mpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\item 
+\begin{CompactList}\small\item\em Update {\tt ep} so that it represents this \hyperlink{classbdm_1_1mpdf}{mpdf} conditioned on {\tt rvc} = cond. \item\end{CompactList}\end{CompactItemize}
+\begin{Indent}{\bf Constructors}\par
+\begin{CompactItemize}
+\item 
+\hypertarget{classbdm_1_1migamma_b109fa502a9ab521dfb48412fd45fca7}{
+\textbf{migamma} ()}
+\label{classbdm_1_1migamma_b109fa502a9ab521dfb48412fd45fca7}
+
+\item 
+\hypertarget{classbdm_1_1migamma_a0126f741c6d2b6016df95a2410071e3}{
+\textbf{migamma} (const \hyperlink{classbdm_1_1migamma}{migamma} \&m)}
+\label{classbdm_1_1migamma_a0126f741c6d2b6016df95a2410071e3}
+
+\end{CompactItemize}
+\end{Indent}
+\begin{Indent}{\bf Matematical operations}\par
+\begin{CompactItemize}
+\item 
 virtual vec \hyperlink{classbdm_1_1mpdf_f0c1db6fcbb3aae2dd6123884457a367}{samplecond} (const vec \&cond)
 \begin{CompactList}\small\item\em Returns a sample from the density conditioned on {\tt cond}, $x \sim epdf(rv|cond)$. \item\end{CompactList}\item 
-virtual mat \hyperlink{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}{samplecond\_\-m} (const vec \&cond, vec \&ll, int N)
+virtual mat \hyperlink{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{samplecond\_\-m} (const vec \&cond, int N)
 \begin{CompactList}\small\item\em Returns. \item\end{CompactList}\item 
 \hypertarget{classbdm_1_1mpdf_6336a8a72462e2a56a3989a220f18b1b}{
@@ -53 +62 @@
 \label{classbdm_1_1mpdf_0b0ed1ed663071bb7cf4a1349eb94fcb}
 
-\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}{
-\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}{\_\-rvc} () const }
-\label{classbdm_1_1mpdf_b3aba7311038bf990d706a64cab60cf8}
+\begin{CompactList}\small\item\em Matrix version of evallogcond. \item\end{CompactList}\end{CompactItemize}
+\end{Indent}
+\begin{Indent}{\bf Access to attributes}\par
+\begin{CompactItemize}
+\item 
+\hypertarget{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}{
+\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rv} ()}
+\label{classbdm_1_1mpdf_5571482d150fbcb72cc36f6694ce1a10}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}{
-\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}{\_\-rv} () const }
-\label{classbdm_1_1mpdf_222d5280e309c5a053ba73841e98c151}
+\item 
+\hypertarget{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}{
+\hyperlink{classbdm_1_1RV}{RV} \textbf{\_\-rvc} ()}
+\label{classbdm_1_1mpdf_26001264236846897bd11e4baad47245}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
+\item 
+\hypertarget{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}{
+int \textbf{dimension} ()}
+\label{classbdm_1_1mpdf_1c2bae3e1e90874e72941863974ec0ed}
+
+\item 
+\hypertarget{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}{
+int \textbf{dimensionc} ()}
+\label{classbdm_1_1mpdf_35e135910aed187b7290742f50e61bc8}
+
+\item 
 \hypertarget{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{
-\hyperlink{classbdm_1_1epdf}{epdf} \& \hyperlink{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}{\_\-epdf} ()}
+\hyperlink{classbdm_1_1epdf}{epdf} \& \textbf{\_\-epdf} ()}
 \label{classbdm_1_1mpdf_1892fe3933488942253679f068e9e7f6}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
+\item 
 \hypertarget{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{
-\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}{\_\-e} ()}
+\hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \textbf{\_\-e} ()}
 \label{classbdm_1_1mpdf_05e843fd11c410a99dad2b88c55aca80}
 
-\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
+\end{CompactItemize}
+\end{Indent}
+\begin{Indent}{\bf Connection to other objects}\par
+\begin{CompactItemize}
+\item 
+\hypertarget{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}{
+void \textbf{set\_\-rvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rvc0)}
+\label{classbdm_1_1mpdf_7631a5570e4ade1420065e8df78f4401}
+
+\item 
+\hypertarget{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}{
+void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv0)}
+\label{classbdm_1_1mpdf_18ac26bc2f96ae01ef4eb06178abbd75}
+
+\item 
+\hypertarget{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}{
+bool \textbf{isnamed} ()}
+\label{classbdm_1_1mpdf_f8e3798150b42fd1f3e16ddbbe0e7045}
+
+\end{CompactItemize}
+\end{Indent}
 \subsection*{Protected Attributes}
 \begin{CompactItemize}
@@ -87 +130 @@
 
 \begin{CompactList}\small\item\em Constant $k$. \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1migamma_4825c0ef11a148bad9b802a496f56f96}{
-vec $\ast$ \hyperlink{classbdm_1_1migamma_4825c0ef11a148bad9b802a496f56f96}{\_\-beta}}
-\label{classbdm_1_1migamma_4825c0ef11a148bad9b802a496f56f96}
+\hypertarget{classbdm_1_1migamma_c9847093da59a9ba0ebb68d2c592f5dc}{
+vec \& \hyperlink{classbdm_1_1migamma_c9847093da59a9ba0ebb68d2c592f5dc}{\_\-alpha}}
+\label{classbdm_1_1migamma_c9847093da59a9ba0ebb68d2c592f5dc}
+
+\begin{CompactList}\small\item\em cache of epdf.alpha \item\end{CompactList}\item 
+\hypertarget{classbdm_1_1migamma_0d854c047001b5465cf1ba21f52904b5}{
+vec \& \hyperlink{classbdm_1_1migamma_0d854c047001b5465cf1ba21f52904b5}{\_\-beta}}
+\label{classbdm_1_1migamma_0d854c047001b5465cf1ba21f52904b5}
 
 \begin{CompactList}\small\item\em cache of epdf.beta \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1migamma_b6c265b132ff79963bf51dff4c3ef252}{
-vec $\ast$ \hyperlink{classbdm_1_1migamma_b6c265b132ff79963bf51dff4c3ef252}{\_\-alpha}}
-\label{classbdm_1_1migamma_b6c265b132ff79963bf51dff4c3ef252}
+\hypertarget{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{
+int \hyperlink{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}{dimc}}
+\label{classbdm_1_1mpdf_7c1900976ff13dbc09c9729b3bbff9e6}
 
-\begin{CompactList}\small\item\em chaceh of epdf.alpha \item\end{CompactList}\item 
-\hypertarget{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{
-\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}{rv}}
-\label{classbdm_1_1mpdf_9bcfb45435d30983f436d41c298cbb51}
-
-\begin{CompactList}\small\item\em modeled random variable \item\end{CompactList}\item 
+\begin{CompactList}\small\item\em dimension of the condition \item\end{CompactList}\item 
 \hypertarget{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{
 \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1mpdf_5a5f08950daa08b85b01ddf4e1c36288}{rvc}}
@@ -113 +156 @@
 \begin{CompactList}\small\item\em pointer to internal \hyperlink{classbdm_1_1epdf}{epdf} \item\end{CompactList}\end{CompactItemize}
 
-
-\subsection{Detailed Description}
-Inverse-Gamma random walk. 
-
-Mean value, $\mu$, of this density is given by {\tt rvc} . Standard deviation of the random walk is proportional to one $k$-th the mean. This is achieved by setting $\alpha=\mu/k+2$ and $\beta=\mu(\alpha-1)$.
-
-The standard deviation of the walk is then: $\mu/\sqrt(k)$. 
 
 \subsection{Member Function Documentation}
@@ -140 +176 @@
 References bdm::mpdf::condition(), bdm::mpdf::ep, and bdm::epdf::sample().
 
-Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}{
+Referenced by bdm::MPF$<$ BM\_\-T $>$::bayes(), bdm::PF::bayes(), and bdm::ArxDS::step().\hypertarget{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}{
 \index{bdm::migamma@{bdm::migamma}!samplecond\_\-m@{samplecond\_\-m}}
 \index{samplecond\_\-m@{samplecond\_\-m}!bdm::migamma@{bdm::migamma}}
-\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat bdm::mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  vec \& {\em ll}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
-\label{classbdm_1_1mpdf_ee26963a637b2ea1fb1933652981e652}
+\subsubsection[samplecond\_\-m]{\setlength{\rightskip}{0pt plus 5cm}virtual mat bdm::mpdf::samplecond\_\-m (const vec \& {\em cond}, \/  int {\em N})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
+\label{classbdm_1_1mpdf_afe4185b26baeb03688202e254d3b005}
 
 
@@ -156 +192 @@
 
 
-References bdm::mpdf::condition(), bdm::RV::count(), bdm::mpdf::ep, bdm::epdf::evallog(), bdm::mpdf::rv, and bdm::epdf::sample().
+References bdm::mpdf::condition(), bdm::epdf::dimension(), bdm::mpdf::ep, and bdm::epdf::sample().
 
 The documentation for this class was generated from the following file:\begin{CompactItemize}