root/doc/latex/classemix.tex @ 198

Revision 181, 7.0 kB (checked in by smidl, 16 years ago)

Regenerated doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classemix}{
2\section{emix Class Reference}
3\label{classemix}\index{emix@{emix}}
4}
5Mixture of epdfs. 
6
7
8{\tt \#include $<$emix.h$>$}
9
10Inheritance diagram for emix:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=40pt]{classemix__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for emix:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=40pt]{classemix__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classemix_62194619791d5f1da88cad01cfc9339d}{
28\hyperlink{classemix_62194619791d5f1da88cad01cfc9339d}{emix} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
29\label{classemix_62194619791d5f1da88cad01cfc9339d}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classemix_d3789d50a3327a6de552db077af5e4c5}{
33void \hyperlink{classemix_d3789d50a3327a6de552db077af5e4c5}{set\_\-parameters} (const vec \&\hyperlink{classemix_cdc8f4e2a5e43595ac5450d8a7f9d1ab}{w}, const Array$<$ \hyperlink{classepdf}{epdf} $\ast$ $>$ \&\hyperlink{classemix_7155d827417b53fb6aa5cff1459e6eb4}{Coms}, bool copy=true)}
34\label{classemix_d3789d50a3327a6de552db077af5e4c5}
35
36\begin{CompactList}\small\item\em Set weights {\tt w} and components {\tt Coms} , Coms are not copied! \item\end{CompactList}\item 
37\hypertarget{classemix_0650601f24e633e0ab09aa1e46c14483}{
38vec \hyperlink{classemix_0650601f24e633e0ab09aa1e46c14483}{sample} () const }
39\label{classemix_0650601f24e633e0ab09aa1e46c14483}
40
41\begin{CompactList}\small\item\em Returns a sample, $x$ from density $epdf(rv)$. \item\end{CompactList}\item 
42\hypertarget{classemix_b662a51d042b062020460e64bff4e9e8}{
43vec \hyperlink{classemix_b662a51d042b062020460e64bff4e9e8}{mean} () const }
44\label{classemix_b662a51d042b062020460e64bff4e9e8}
45
46\begin{CompactList}\small\item\em return expected value \item\end{CompactList}\item 
47\hypertarget{classemix_469e910479b3402589104ef3bb1b5741}{
48double \hyperlink{classemix_469e910479b3402589104ef3bb1b5741}{evalpdflog} (const vec \&val) const }
49\label{classemix_469e910479b3402589104ef3bb1b5741}
50
51\begin{CompactList}\small\item\em Compute log-probability of argument {\tt val}. \item\end{CompactList}\item 
52\hypertarget{classemix_35baf0f62307455cebfbf462144b4dd8}{
53vec \& \hyperlink{classemix_35baf0f62307455cebfbf462144b4dd8}{\_\-w} ()}
54\label{classemix_35baf0f62307455cebfbf462144b4dd8}
55
56\begin{CompactList}\small\item\em returns a pointer to the internal mean value. Use with Care! \item\end{CompactList}\item 
57\hypertarget{classemix_4d7baeb2a9e3fca1d8fd32a107df291d}{
58void \hyperlink{classemix_4d7baeb2a9e3fca1d8fd32a107df291d}{ownComs} ()}
59\label{classemix_4d7baeb2a9e3fca1d8fd32a107df291d}
60
61\begin{CompactList}\small\item\em Auxiliary function for taking ownership of the \hyperlink{classemix_7155d827417b53fb6aa5cff1459e6eb4}{Coms()}. \item\end{CompactList}\item 
62\hypertarget{classepdf_54d7dd53a641b618771cd9bee135181f}{
63virtual mat \hyperlink{classepdf_54d7dd53a641b618771cd9bee135181f}{sampleN} (int N) const }
64\label{classepdf_54d7dd53a641b618771cd9bee135181f}
65
66\begin{CompactList}\small\item\em Returns N samples from density $epdf(rv)$. \item\end{CompactList}\item 
67\hypertarget{classepdf_3ea597362e11a0040fe7c990269d072c}{
68virtual double \hyperlink{classepdf_3ea597362e11a0040fe7c990269d072c}{eval} (const vec \&val) const }
69\label{classepdf_3ea597362e11a0040fe7c990269d072c}
70
71\begin{CompactList}\small\item\em Compute probability of argument {\tt val}. \item\end{CompactList}\item 
72\hypertarget{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{
73virtual vec \hyperlink{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}{evalpdflog\_\-m} (const mat \&Val) const }
74\label{classepdf_cebbdd7a85e6328f7358fc0ba8eee06c}
75
76\begin{CompactList}\small\item\em Compute log-probability of multiple values argument {\tt val}. \item\end{CompactList}\item 
77\hypertarget{classepdf_3ba08c0e788deff22134c049b9269666}{
78\hyperlink{classmpdf}{mpdf} $\ast$ \hyperlink{classepdf_3ba08c0e788deff22134c049b9269666}{condition} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
79\label{classepdf_3ba08c0e788deff22134c049b9269666}
80
81\begin{CompactList}\small\item\em Return conditional density on the given \hyperlink{classRV}{RV}, the remaining rvs will be in conditioning. \item\end{CompactList}\item 
82\hypertarget{classepdf_bc0c171b6dafacd78d26263913b1d0c0}{
83\hyperlink{classepdf}{epdf} $\ast$ \hyperlink{classepdf_bc0c171b6dafacd78d26263913b1d0c0}{marginal} (const \hyperlink{classRV}{RV} \&\hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv})}
84\label{classepdf_bc0c171b6dafacd78d26263913b1d0c0}
85
86\begin{CompactList}\small\item\em Return marginal density on the given \hyperlink{classRV}{RV}, the remainig rvs are intergrated out. \item\end{CompactList}\item 
87\hypertarget{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{
88const \hyperlink{classRV}{RV} \& \hyperlink{classepdf_ca0d32aabb4cbba347e0c37fe8607562}{\_\-rv} () const }
89\label{classepdf_ca0d32aabb4cbba347e0c37fe8607562}
90
91\begin{CompactList}\small\item\em access function, possibly dangerous! \item\end{CompactList}\item 
92\hypertarget{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{
93void \hyperlink{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}{\_\-renewrv} (const \hyperlink{classRV}{RV} \&in\_\-rv)}
94\label{classepdf_7fb94ce90d1ac7077d29f7d6a6c3e0a5}
95
96\begin{CompactList}\small\item\em modifier function - useful when copying epdfs \item\end{CompactList}\end{CompactItemize}
97\subsection*{Protected Attributes}
98\begin{CompactItemize}
99\item 
100\hypertarget{classemix_cdc8f4e2a5e43595ac5450d8a7f9d1ab}{
101vec \hyperlink{classemix_cdc8f4e2a5e43595ac5450d8a7f9d1ab}{w}}
102\label{classemix_cdc8f4e2a5e43595ac5450d8a7f9d1ab}
103
104\begin{CompactList}\small\item\em weights of the components \item\end{CompactList}\item 
105\hypertarget{classemix_7155d827417b53fb6aa5cff1459e6eb4}{
106Array$<$ \hyperlink{classepdf}{epdf} $\ast$ $>$ \hyperlink{classemix_7155d827417b53fb6aa5cff1459e6eb4}{Coms}}
107\label{classemix_7155d827417b53fb6aa5cff1459e6eb4}
108
109\begin{CompactList}\small\item\em Component (epdfs). \item\end{CompactList}\item 
110\hypertarget{classemix_7d0d863e6066ee02947914ff06ac34e8}{
111bool \hyperlink{classemix_7d0d863e6066ee02947914ff06ac34e8}{destroyComs}}
112\label{classemix_7d0d863e6066ee02947914ff06ac34e8}
113
114\begin{CompactList}\small\item\em Flag if owning Coms. \item\end{CompactList}\item 
115\hypertarget{classepdf_74da992e3f5d598da8850b646b79b9d9}{
116\hyperlink{classRV}{RV} \hyperlink{classepdf_74da992e3f5d598da8850b646b79b9d9}{rv}}
117\label{classepdf_74da992e3f5d598da8850b646b79b9d9}
118
119\begin{CompactList}\small\item\em Identified of the random variable. \item\end{CompactList}\end{CompactItemize}
120
121
122\subsection{Detailed Description}
123Mixture of epdfs.
124
125Density function: \[ f(x) = \sum_{i=1}^{n} w_{i} f_i(x), \quad \sum_{i=1}^n w_i = 1. \] where $f_i(x)$ is any density on random variable $x$, called {\em component\/},
126
127The documentation for this class was generated from the following files:\begin{CompactItemize}
128\item 
129work/git/mixpp/bdm/stat/\hyperlink{emix_8h}{emix.h}\item 
130work/git/mixpp/bdm/stat/emix.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.