Changeset 162 for doc/latex/classRV.tex

Show
Ignore:
Timestamp:
09/04/08 20:27:01 (16 years ago)
Author:
smidl
Message:

opravy a dokumentace

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classRV.tex

    r145 r162  
    99\begin{CompactItemize} 
    1010\item  
    11 {\bf RV} (ivec in\_\-ids, Array$<$ std::string $>$ in\_\-names, ivec in\_\-sizes, ivec in\_\-times)\label{classRV_e032d2e90e5b6e156d15f137caca940f} 
     11{\bf RV} (Array$<$ std::string $>$ in\_\-names, ivec in\_\-sizes, ivec in\_\-times)\label{classRV_bedfd8d197f0a7ac28a4d412dfc5b8af} 
    1212 
    13 \begin{CompactList}\small\item\em Full constructor which is called by the others. \item\end{CompactList}\item  
    14 {\bf RV} (ivec {\bf ids})\label{classRV_cf911c3900214460ade1366b04058462} 
     13\begin{CompactList}\small\item\em Full constructor. \item\end{CompactList}\item  
     14{\bf RV} (Array$<$ std::string $>$ in\_\-names, ivec in\_\-sizes)\label{classRV_7b88a74204fdf044e02f2807769839b7} 
    1515 
    16 \begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item  
     16\begin{CompactList}\small\item\em Constructor with times=0. \item\end{CompactList}\item  
     17{\bf RV} (Array$<$ std::string $>$ in\_\-names)\label{classRV_261702f85831392d7d67e2bcf0b69960} 
     18 
     19\begin{CompactList}\small\item\em Constructor with sizes=1, times=0. \item\end{CompactList}\item  
    1720{\bf RV} ()\label{classRV_6a22f5c06d6403870d4e414b1993bf9e} 
    1821 
    19 \begin{CompactList}\small\item\em Empty constructor will be set later. \item\end{CompactList}\item  
     22\begin{CompactList}\small\item\em Constructor of empty \doxyref{RV}{p.}{classRV}. \item\end{CompactList}\item  
    2023int {\bf count} () const \label{classRV_f5c7b8bd589eef09ccdf3329a0addea0} 
    2124 
    … …  
    2427 
    2528\begin{CompactList}\small\item\em Return length (number of entries) of the \doxyref{RV}{p.}{classRV}. \item\end{CompactList}\item  
    26 ivec {\bf find} ({\bf RV} rv2)\label{classRV_6b078b1086224aca3a9e5a203e647fb6} 
    27  
    28 \begin{CompactList}\small\item\em Find indexes of another rv in self. \item\end{CompactList}\item  
    29 bool {\bf equal} ({\bf RV} rv2) const \label{classRV_c4f547370d67eba414caafe91c64b12a} 
     29ivec {\bf findself} (const {\bf RV} \&rv2) const  
     30\begin{CompactList}\small\item\em Find indexes of self in another rv,. \item\end{CompactList}\item  
     31bool {\bf equal} (const {\bf RV} \&rv2) const \label{classRV_82cc7fa22ce91cf461a522ad62014c65} 
    3032 
    3133\begin{CompactList}\small\item\em Compare if {\tt rv2} is identical to this {\tt \doxyref{RV}{p.}{classRV}}. \item\end{CompactList}\item  
    32 void {\bf add} (const {\bf RV} \&rv2)\label{classRV_4fc941a5ebc9f82aa372f54f2e02dab2} 
    33  
    34 \begin{CompactList}\small\item\em Add (concat) another variable to the current one. \item\end{CompactList}\item  
    35 {\bf RV} {\bf subt} ({\bf RV} rv2)\label{classRV_4c5ec5e913fc598e242cb930ae8bdf4a} 
     34bool {\bf add} (const {\bf RV} \&rv2) 
     35\begin{CompactList}\small\item\em Add (concat) another variable to the current one,. \item\end{CompactList}\item  
     36{\bf RV} {\bf subt} (const {\bf RV} rv2) const \label{classRV_a85c47bd838ebbdcb6798d7843e87db2} 
    3637 
    3738\begin{CompactList}\small\item\em Subtract another variable from the current one. \item\end{CompactList}\item  
    38 {\bf RV} {\bf subselect} (ivec ind)\label{classRV_2bf35b18a32aad419f0516273939628e} 
     39{\bf RV} {\bf subselect} (ivec ind) const \label{classRV_0a9ea7bc6fad270cc54a455a9f8f387d} 
    3940 
    4041\begin{CompactList}\small\item\em Select only variables at indeces ind. \item\end{CompactList}\item  
    41 {\bf RV} {\bf operator()} (ivec ind)\label{classRV_28bbcb8873bafdac317bafb7b481cc45} 
     42{\bf RV} {\bf operator()} (ivec ind) const \label{classRV_65e5b820e482caff7f284d11898ef64f} 
    4243 
    4344\begin{CompactList}\small\item\em Select only variables at indeces ind. \item\end{CompactList}\item  
    4445void {\bf t} (int delta)\label{classRV_e0a158d53ab9430627241f844f4c9a60} 
    4546 
    46 \begin{CompactList}\small\item\em Generate new {\tt \doxyref{RV}{p.}{classRV}} with {\tt time} shifted by delta. \item\end{CompactList}\item  
    47 ivec {\bf indexlist} ()\label{classRV_8470cf53be6e7bdba78ad0efbd203ee7} 
     47\begin{CompactList}\small\item\em Shift {\tt time} shifted by delta. \item\end{CompactList}\item  
     48{\bf str} {\bf tostr} () const \label{classRV_52f3ade796814da627ff5a44d00986be} 
    4849 
    49 \begin{CompactList}\small\item\em generate a list of indeces, i.e. which \item\end{CompactList}\item  
     50\begin{CompactList}\small\item\em generate {\tt \doxyref{str}{p.}{classstr}} from rv, by expanding sizes \item\end{CompactList}\item  
     51ivec {\bf dataind} ({\bf RV} crv) const  
     52\begin{CompactList}\small\item\em generate indeces into \item\end{CompactList}\item  
    5053Array$<$ std::string $>$ \& {\bf \_\-names} ()\label{classRV_b88ef5124713c9e30fd9446846b3f044} 
    5154 
    … …  
    8992std::ostream \& {\bf operator$<$$<$} (std::ostream \&os, const {\bf RV} \&rv)\label{classRV_cad6f15535d10437f6690cb4492176a8} 
    9093 
    91 \begin{CompactList}\small\item\em Printing output e.g. for debugging. \item\end{CompactList}\item  
    92 {\bf RV} {\bf concat} (const {\bf RV} \&rv1, const {\bf RV} \&rv2)\label{classRV_33c114e83980d883c5b211c47d5322a4} 
    93  
    94 \begin{CompactList}\small\item\em Add (concat) another variable to the current one. \item\end{CompactList}\end{CompactItemize} 
     94\begin{CompactList}\small\item\em Printing output e.g. for debugging. \item\end{CompactList}\end{CompactItemize} 
    9595 
    9696 
    … …  
    100100More?...  
    101101 
     102\subsection{Member Function Documentation} 
     103\index{RV@{RV}!findself@{findself}} 
     104\index{findself@{findself}!RV@{RV}} 
     105\subsubsection[findself]{\setlength{\rightskip}{0pt plus 5cm}ivec RV::findself (const {\bf RV} \& {\em rv2}) const}\label{classRV_0c493a7a897f4d75682f4264e40779a1} 
     106 
     107 
     108Find indexes of self in another rv,.  
     109 
     110\begin{Desc} 
     111\item[Returns:]ivec of the same size as self. \end{Desc} 
     112 
     113 
     114References ids, len, length(), and times. 
     115 
     116Referenced by add(), and subt().\index{RV@{RV}!add@{add}} 
     117\index{add@{add}!RV@{RV}} 
     118\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}bool RV::add (const {\bf RV} \& {\em rv2})}\label{classRV_935790526b630dec4ffefa9ec0c2b6fb} 
     119 
     120 
     121Add (concat) another variable to the current one,.  
     122 
     123\begin{Desc} 
     124\item[Returns:]0 if all rv2 were added, 1 if rv2 is in conflict \end{Desc} 
     125 
     126 
     127References findself(), ids, len, names, sizes, times, and tsize. 
     128 
     129Referenced by concat(), MPF$<$ BM\_\-T $>$::MPF(), and mprod::mprod().\index{RV@{RV}!dataind@{dataind}} 
     130\index{dataind@{dataind}!RV@{RV}} 
     131\subsubsection[dataind]{\setlength{\rightskip}{0pt plus 5cm}ivec RV::dataind ({\bf RV} {\em crv}) const}\label{classRV_1844ea0d9c10428f5e0ee1d4d569ef0a} 
     132 
     133 
     134generate indeces into  
     135 
     136\begin{Desc} 
     137\item[Parameters:] 
     138\begin{description} 
     139\item[{\em crv}]data vector that form data vector of self. \end{description} 
     140\end{Desc} 
     141 
     142 
     143References ids, str::ids, len, times, str::times, and tostr(). 
     144 
    102145The documentation for this class was generated from the following files:\begin{CompactItemize} 
    103146\item