root/doc/latex/classRV.tex @ 170

\section{RV Class Reference}
\label{classRV}\index{RV@{RV}}
Class representing variables, most often random variables.  


{\tt \#include $<$libBM.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf RV} (Array$<$ std::string $>$ in\_\-names, ivec in\_\-sizes, ivec in\_\-times)\label{classRV_bedfd8d197f0a7ac28a4d412dfc5b8af}

\begin{CompactList}\small\item\em Full constructor. \item\end{CompactList}\item 
{\bf RV} (Array$<$ std::string $>$ in\_\-names, ivec in\_\-sizes)\label{classRV_7b88a74204fdf044e02f2807769839b7}

\begin{CompactList}\small\item\em Constructor with times=0. \item\end{CompactList}\item 
{\bf RV} (Array$<$ std::string $>$ in\_\-names)\label{classRV_261702f85831392d7d67e2bcf0b69960}

\begin{CompactList}\small\item\em Constructor with sizes=1, times=0. \item\end{CompactList}\item 
{\bf RV} ()\label{classRV_6a22f5c06d6403870d4e414b1993bf9e}

\begin{CompactList}\small\item\em Constructor of empty \doxyref{RV}{p.}{classRV}. \item\end{CompactList}\item 
int {\bf count} () const \label{classRV_f5c7b8bd589eef09ccdf3329a0addea0}

\begin{CompactList}\small\item\em Return number of scalars in the \doxyref{RV}{p.}{classRV}. \item\end{CompactList}\item 
int {\bf length} () const \label{classRV_c114a6f3ff06796cc2f4dacba74291eb}

\begin{CompactList}\small\item\em Return length (number of entries) of the \doxyref{RV}{p.}{classRV}. \item\end{CompactList}\item 
ivec {\bf findself} (const {\bf RV} \&rv2) const 
\begin{CompactList}\small\item\em Find indexes of self in another rv,. \item\end{CompactList}\item 
bool {\bf equal} (const {\bf RV} \&rv2) const \label{classRV_82cc7fa22ce91cf461a522ad62014c65}

\begin{CompactList}\small\item\em Compare if {\tt rv2} is identical to this {\tt \doxyref{RV}{p.}{classRV}}. \item\end{CompactList}\item 
bool {\bf add} (const {\bf RV} \&rv2)
\begin{CompactList}\small\item\em Add (concat) another variable to the current one,. \item\end{CompactList}\item 
{\bf RV} {\bf subt} (const {\bf RV} rv2) const \label{classRV_a85c47bd838ebbdcb6798d7843e87db2}

\begin{CompactList}\small\item\em Subtract another variable from the current one. \item\end{CompactList}\item 
{\bf RV} {\bf subselect} (ivec ind) const \label{classRV_0a9ea7bc6fad270cc54a455a9f8f387d}

\begin{CompactList}\small\item\em Select only variables at indeces ind. \item\end{CompactList}\item 
{\bf RV} {\bf operator()} (ivec ind) const \label{classRV_65e5b820e482caff7f284d11898ef64f}

\begin{CompactList}\small\item\em Select only variables at indeces ind. \item\end{CompactList}\item 
void {\bf t} (int delta)\label{classRV_e0a158d53ab9430627241f844f4c9a60}

\begin{CompactList}\small\item\em Shift {\tt time} shifted by delta. \item\end{CompactList}\item 
{\bf str} {\bf tostr} () const \label{classRV_52f3ade796814da627ff5a44d00986be}

\begin{CompactList}\small\item\em generate {\tt \doxyref{str}{p.}{classstr}} from rv, by expanding sizes \item\end{CompactList}\item 
ivec {\bf dataind} ({\bf RV} crv) const 
\begin{CompactList}\small\item\em generate indeces into \item\end{CompactList}\item 
Array$<$ std::string $>$ \& {\bf \_\-names} ()\label{classRV_b88ef5124713c9e30fd9446846b3f044}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
int {\bf id} (int at)\label{classRV_4a0069bc69f5a98d7ce9ed59077f2e6c}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
int {\bf size} (int at)\label{classRV_20db23a5585d64a6e24404cc8379bc28}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
int {\bf time} (int at)\label{classRV_af068cf478864fe1a4fbfc6b4693b088}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
std::string {\bf name} (int at)\label{classRV_3ae4dd6e368f814a02710636ac8e1721}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
int {\bf tsize}\label{classRV_f2396efe2e6d656ebe9e6f06018cbe25}

\begin{CompactList}\small\item\em size = sum of sizes \item\end{CompactList}\item 
int {\bf len}\label{classRV_0d7b36e2bbccf880c8fcf1e8cc43c1a9}

\begin{CompactList}\small\item\em len = number of individual rvs \item\end{CompactList}\item 
ivec {\bf ids}\label{classRV_1bd7165140f4b880a7f344bbb1c433f9}

\begin{CompactList}\small\item\em Vector of unique IDs. \item\end{CompactList}\item 
ivec {\bf sizes}\label{classRV_c878aab13f34b420e1eb5b485563682b}

\begin{CompactList}\small\item\em Vector of sizes. \item\end{CompactList}\item 
ivec {\bf times}\label{classRV_646e530c47a2dd38254b778d9f11ac89}

\begin{CompactList}\small\item\em Vector of shifts from current time. \item\end{CompactList}\item 
Array$<$ std::string $>$ {\bf names}\label{classRV_df5d0030b277a1db2f1fd5fb79152acb}

\begin{CompactList}\small\item\em Array of names. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
std::ostream \& {\bf operator$<$$<$} (std::ostream \&os, const {\bf RV} \&rv)\label{classRV_cad6f15535d10437f6690cb4492176a8}

\begin{CompactList}\small\item\em Printing output e.g. for debugging. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Class representing variables, most often random variables. 

More?... 

\subsection{Member Function Documentation}
\index{RV@{RV}!findself@{findself}}
\index{findself@{findself}!RV@{RV}}
\subsubsection[findself]{\setlength{\rightskip}{0pt plus 5cm}ivec RV::findself (const {\bf RV} \& {\em rv2}) const}\label{classRV_0c493a7a897f4d75682f4264e40779a1}


Find indexes of self in another rv,. 

\begin{Desc}
\item[Returns:]ivec of the same size as self. \end{Desc}


References ids, len, length(), and times.

Referenced by add(), and subt().\index{RV@{RV}!add@{add}}
\index{add@{add}!RV@{RV}}
\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}bool RV::add (const {\bf RV} \& {\em rv2})}\label{classRV_935790526b630dec4ffefa9ec0c2b6fb}


Add (concat) another variable to the current one,. 

\begin{Desc}
\item[Returns:]0 if all rv2 were added, 1 if rv2 is in conflict \end{Desc}


References findself(), ids, len, names, sizes, times, and tsize.

Referenced by concat(), MPF$<$ BM\_\-T $>$::MPF(), and mprod::mprod().\index{RV@{RV}!dataind@{dataind}}
\index{dataind@{dataind}!RV@{RV}}
\subsubsection[dataind]{\setlength{\rightskip}{0pt plus 5cm}ivec RV::dataind ({\bf RV} {\em crv}) const}\label{classRV_1844ea0d9c10428f5e0ee1d4d569ef0a}


generate indeces into 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em crv}]data vector that form data vector of self. \end{description}
\end{Desc}


References ids, str::ids, len, times, str::times, and tostr().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
work/git/mixpp/bdm/stat/{\bf libBM.h}\item 
work/git/mixpp/bdm/stat/libBM.cpp\end{CompactItemize}