Show
Ignore:
Timestamp:
02/16/09 10:03:13 (16 years ago)
Author:
smidl
Message:

Next major revision

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/latex/classbdm_1_1egamma.tex

    r270 r271  
    55{\tt \#include $<$libEF.h$>$} 
    66 
    7 Inheritance diagram for bdm::egamma:\nopagebreak 
    8 \begin{figure}[H] 
     7Inheritance diagram for bdm::egamma::\begin{figure}[H] 
    98\begin{center} 
    109\leavevmode 
    11 \includegraphics[width=65pt]{classbdm_1_1egamma__inherit__graph} 
     10\includegraphics[height=4cm]{classbdm_1_1egamma} 
    1211\end{center} 
    1312\end{figure} 
     
    2019\begin{CompactItemize} 
    2120\item  
    22 \hypertarget{classbdm_1_1egamma_131197f3dfad99355a01d30903279653}{ 
    23 \hyperlink{classbdm_1_1egamma_131197f3dfad99355a01d30903279653}{egamma} ()} 
    24 \label{classbdm_1_1egamma_131197f3dfad99355a01d30903279653} 
    25  
    26 \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item  
    27 \hypertarget{classbdm_1_1egamma_749f82293ff23a8319c1bf52489d2ed2}{ 
    28 void \hyperlink{classbdm_1_1egamma_749f82293ff23a8319c1bf52489d2ed2}{set\_\-parameters} (const vec \&a, const vec \&b)} 
    29 \label{classbdm_1_1egamma_749f82293ff23a8319c1bf52489d2ed2} 
    30  
    31 \begin{CompactList}\small\item\em Sets parameters. \item\end{CompactList}\item  
    3221\hypertarget{classbdm_1_1egamma_6ed82f0fd05f6002487256d8e75a0bbd}{ 
    3322vec \hyperlink{classbdm_1_1egamma_6ed82f0fd05f6002487256d8e75a0bbd}{sample} () const } 
     
    8574 
    8675\begin{CompactList}\small\item\em Power of the density, used e.g. to flatten the density. \item\end{CompactList}\end{CompactItemize} 
     76\begin{Indent}{\bf Constructors}\par 
     77\begin{CompactItemize} 
     78\item  
     79\hypertarget{classbdm_1_1egamma_131197f3dfad99355a01d30903279653}{ 
     80\textbf{egamma} ()} 
     81\label{classbdm_1_1egamma_131197f3dfad99355a01d30903279653} 
     82 
     83\item  
     84\hypertarget{classbdm_1_1egamma_d1a84564098230d31b9af762209400ae}{ 
     85\textbf{egamma} (const vec \&a, const vec \&b)} 
     86\label{classbdm_1_1egamma_d1a84564098230d31b9af762209400ae} 
     87 
     88\item  
     89\hypertarget{classbdm_1_1egamma_749f82293ff23a8319c1bf52489d2ed2}{ 
     90void \textbf{set\_\-parameters} (const vec \&a, const vec \&b)} 
     91\label{classbdm_1_1egamma_749f82293ff23a8319c1bf52489d2ed2} 
     92 
     93\end{CompactItemize} 
     94\end{Indent} 
     95\begin{Indent}{\bf Constructors}\par 
     96{\em Construction of each \hyperlink{classbdm_1_1epdf}{epdf} should support two types of constructors: \begin{itemize} 
     97\item empty constructor, \item copy constructor,\end{itemize} 
     98The following constructors should be supported for convenience: \begin{itemize} 
     99\item constructor followed by calling {\tt set\_\-parameters()} \item constructor accepting random variables calling {\tt \hyperlink{classbdm_1_1epdf_f423e28448dbb69ef4905295ec8de8ff}{set\_\-rv()}} \end{itemize} 
     100All internal data structures are constructed as empty. Their values (including sizes) will be set by method {\tt set\_\-parameters()}. This way references can be initialized in constructors. }\begin{CompactItemize} 
     101\item  
     102\hypertarget{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8}{ 
     103void \textbf{set\_\-parameters} (int dim0)} 
     104\label{classbdm_1_1epdf_840de94aa33cf4f2ebd2427f45a165d8} 
     105 
     106\end{CompactItemize} 
     107\end{Indent} 
    87108\begin{Indent}{\bf Matematical Operations}\par 
    88109\begin{CompactItemize} 
     
    131152\begin{CompactItemize} 
    132153\item  
    133 \hypertarget{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{ 
    134 bool \hyperlink{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b}{dimension} () const } 
    135 \label{classbdm_1_1epdf_46dfe100cd621716ee5c7ee25a20f24b} 
     154\hypertarget{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{ 
     155int \hyperlink{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c}{dimension} () const } 
     156\label{classbdm_1_1epdf_7083a65f7b7a0d0d13b2c516bd2ec29c} 
    136157 
    137158\begin{CompactList}\small\item\em Size of the random variable. \item\end{CompactList}\end{CompactItemize}