Show
Ignore:
Timestamp:
02/16/09 10:02:08 (17 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:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classbdm_1_1RV.tex

    r269 r270  
    33\label{classbdm_1_1RV}\index{bdm::RV@{bdm::RV}} 
    44} 
    5 Class representing variables, most often random variables.   
    6  
    7  
    85{\tt \#include $<$libBM.h$>$} 
    96 
    … …  
    1512\end{center} 
    1613\end{figure} 
    17 Collaboration diagram for bdm::RV:\nopagebreak 
    18 \begin{figure}[H] 
    19 \begin{center} 
    20 \leavevmode 
    21 \includegraphics[width=64pt]{classbdm_1_1RV__coll__graph} 
     14 
     15 
     16\subsection{Detailed Description} 
     17Class representing variables, most often random variables.  
     18 
     19The purpose of this class is to decribe a vector of data. Such description is used for connecting various vectors between each other, see class \hyperlink{classbdm_1_1datalink}{datalink}. 
     20 
     21The class is implemented using global variables to assure uniqueness of description: 
     22 
     23In is a vector \begin{center} 
     24\begin{ImageNoCaption}\mbox{\includegraphics{inline_dotgraph_1}} 
     25\end{ImageNoCaption} 
    2226\end{center} 
    23 \end{figure} 
     27 \subsection*{Access functions} 
     28\begin{CompactItemize} 
     29\item  
     30\hypertarget{classbdm_1_1RV_de30156104f61d86c94f758861418089}{ 
     31int \textbf{\_\-dsize} () const } 
     32\label{classbdm_1_1RV_de30156104f61d86c94f758861418089} 
     33 
     34\item  
     35\hypertarget{classbdm_1_1RV_39f9b44752376f07e346579b5ff8cbbd}{ 
     36int \hyperlink{classbdm_1_1RV_39f9b44752376f07e346579b5ff8cbbd}{countsize} () const } 
     37\label{classbdm_1_1RV_39f9b44752376f07e346579b5ff8cbbd} 
     38 
     39\begin{CompactList}\small\item\em Recount size of the corresponding data vector. \item\end{CompactList}\item  
     40\hypertarget{classbdm_1_1RV_e9ec8c3e756651ff352ab5e3d3acda4b}{ 
     41int \textbf{length} () const } 
     42\label{classbdm_1_1RV_e9ec8c3e756651ff352ab5e3d3acda4b} 
     43 
     44\item  
     45\hypertarget{classbdm_1_1RV_5900b42f778129a9e56008a1e8e489c8}{ 
     46int \textbf{id} (int at) const } 
     47\label{classbdm_1_1RV_5900b42f778129a9e56008a1e8e489c8} 
     48 
     49\item  
     50\hypertarget{classbdm_1_1RV_bde62551a3fc8f3f83c569860b73f705}{ 
     51int \textbf{size} (int at) const } 
     52\label{classbdm_1_1RV_bde62551a3fc8f3f83c569860b73f705} 
     53 
     54\item  
     55\hypertarget{classbdm_1_1RV_c94373d3a760919b4b3eee58b42e3a45}{ 
     56int \textbf{time} (int at) const } 
     57\label{classbdm_1_1RV_c94373d3a760919b4b3eee58b42e3a45} 
     58 
     59\item  
     60\hypertarget{classbdm_1_1RV_74c6ec8eb9c1dd69ad1d986eaee16dc2}{ 
     61std::string \textbf{name} (int at) const } 
     62\label{classbdm_1_1RV_74c6ec8eb9c1dd69ad1d986eaee16dc2} 
     63 
     64\item  
     65\hypertarget{classbdm_1_1RV_fb2892d12dc978549e9491aed327dfd4}{ 
     66void \textbf{set\_\-time} (int at, int time0)} 
     67\label{classbdm_1_1RV_fb2892d12dc978549e9491aed327dfd4} 
     68 
     69\item  
     70\hypertarget{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8}{ 
     71std::ostream \& \hyperlink{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8}{operator$<$$<$} (std::ostream \&os, const \hyperlink{classbdm_1_1RV}{RV} \&rv)} 
     72\label{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8} 
     73 
     74\begin{CompactList}\small\item\em Printing output e.g. for debugging. \item\end{CompactList}\end{CompactItemize} 
    2475\subsection*{Public Member Functions} 
     76\begin{Indent}{\bf Constructors}\par 
    2577\begin{CompactItemize} 
    2678\item  
    … …  
    4597 
    4698\begin{CompactList}\small\item\em Constructor of empty \hyperlink{classbdm_1_1RV}{RV}. \item\end{CompactList}\item  
    47 \hypertarget{classbdm_1_1RV_53b30f0c148b18e0aa20cc83548ed0c4}{ 
    48 \hyperlink{classbdm_1_1RV_53b30f0c148b18e0aa20cc83548ed0c4}{RV} (string name, int id, int sz=1, int tm=0)} 
    49 \label{classbdm_1_1RV_53b30f0c148b18e0aa20cc83548ed0c4} 
    50  
    51 \begin{CompactList}\small\item\em Constructor of a single \hyperlink{classbdm_1_1RV}{RV} with given id. \item\end{CompactList}\item  
    52 \hypertarget{classbdm_1_1RV_2174751a00ce19f941edd2c1a861be67}{ 
    53 int \hyperlink{classbdm_1_1RV_2174751a00ce19f941edd2c1a861be67}{count} () const } 
    54 \label{classbdm_1_1RV_2174751a00ce19f941edd2c1a861be67} 
    55  
    56 \begin{CompactList}\small\item\em Return number of scalars in the \hyperlink{classbdm_1_1RV}{RV}. \item\end{CompactList}\item  
    57 \hypertarget{classbdm_1_1RV_e9ec8c3e756651ff352ab5e3d3acda4b}{ 
    58 int \hyperlink{classbdm_1_1RV_e9ec8c3e756651ff352ab5e3d3acda4b}{length} () const } 
    59 \label{classbdm_1_1RV_e9ec8c3e756651ff352ab5e3d3acda4b} 
    60  
    61 \begin{CompactList}\small\item\em Return length (number of entries) of the \hyperlink{classbdm_1_1RV}{RV}. \item\end{CompactList}\item  
     99\hypertarget{classbdm_1_1RV_a990e0f30c0e34f04c14260ab8ba5b5f}{ 
     100\hyperlink{classbdm_1_1RV_a990e0f30c0e34f04c14260ab8ba5b5f}{RV} (string name, int sz, int tm=0)} 
     101\label{classbdm_1_1RV_a990e0f30c0e34f04c14260ab8ba5b5f} 
     102 
     103\begin{CompactList}\small\item\em Constructor of a single \hyperlink{classbdm_1_1RV}{RV} with given id. \item\end{CompactList}\end{CompactItemize} 
     104\end{Indent} 
     105\begin{Indent}{\bf Algebra on Random Variables}\par 
     106\begin{CompactItemize} 
     107\item  
    62108ivec \hyperlink{classbdm_1_1RV_1367055b2608ad9d50d01a2da6cec869}{findself} (const \hyperlink{classbdm_1_1RV}{RV} \&rv2) const  
    63109\begin{CompactList}\small\item\em Find indexes of self in another rv,. \item\end{CompactList}\item  
    … …  
    88134\label{classbdm_1_1RV_bd77cb0899f7fba1d0e34396137b7f1f} 
    89135 
    90 \begin{CompactList}\small\item\em Shift {\tt time} shifted by delta. \item\end{CompactList}\item  
     136\begin{CompactList}\small\item\em Shift {\tt time} shifted by delta. \item\end{CompactList}\end{CompactItemize} 
     137\end{Indent} 
     138\begin{Indent}{\bf Relation to vectors}\par 
     139\begin{CompactItemize} 
     140\item  
    91141\hypertarget{classbdm_1_1RV_8bdd7f4072749c7cc864b78a418ca388}{ 
    92142\hyperlink{classbdm_1_1str}{str} \hyperlink{classbdm_1_1RV_8bdd7f4072749c7cc864b78a418ca388}{tostr} () const } 
    … …  
    102152\label{classbdm_1_1RV_9a5c5aeeaf39299d07763377b05a8241} 
    103153 
    104 \begin{CompactList}\small\item\em Minimum time-offset. \item\end{CompactList}\item  
    105 \hypertarget{classbdm_1_1RV_ae0c6e729851a43c82a5b1c199474ef2}{ 
    106 Array$<$ std::string $>$ \& \hyperlink{classbdm_1_1RV_ae0c6e729851a43c82a5b1c199474ef2}{\_\-names} ()} 
    107 \label{classbdm_1_1RV_ae0c6e729851a43c82a5b1c199474ef2} 
    108  
    109 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    110 \hypertarget{classbdm_1_1RV_172390b8525ef5aac684228241fff7b5}{ 
    111 int \hyperlink{classbdm_1_1RV_172390b8525ef5aac684228241fff7b5}{id} (int at)} 
    112 \label{classbdm_1_1RV_172390b8525ef5aac684228241fff7b5} 
    113  
    114 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    115 \hypertarget{classbdm_1_1RV_8e64d02005a02aef72f214286977d8de}{ 
    116 int \hyperlink{classbdm_1_1RV_8e64d02005a02aef72f214286977d8de}{size} (int at)} 
    117 \label{classbdm_1_1RV_8e64d02005a02aef72f214286977d8de} 
    118  
    119 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    120 \hypertarget{classbdm_1_1RV_aff4de8185750b506492623847520518}{ 
    121 int \hyperlink{classbdm_1_1RV_aff4de8185750b506492623847520518}{time} (int at)} 
    122 \label{classbdm_1_1RV_aff4de8185750b506492623847520518} 
    123  
    124 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    125 \hypertarget{classbdm_1_1RV_d05af87595cfb7fa2e0fadeae5597fa8}{ 
    126 std::string \hyperlink{classbdm_1_1RV_d05af87595cfb7fa2e0fadeae5597fa8}{name} (int at)} 
    127 \label{classbdm_1_1RV_d05af87595cfb7fa2e0fadeae5597fa8} 
    128  
    129 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    130 \hypertarget{classbdm_1_1RV_602cea0aecebc5146d81657df5127543}{ 
    131 void \hyperlink{classbdm_1_1RV_602cea0aecebc5146d81657df5127543}{set\_\-id} (int at, int id0)} 
    132 \label{classbdm_1_1RV_602cea0aecebc5146d81657df5127543} 
    133  
    134 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    135 \hypertarget{classbdm_1_1RV_0b2c9e73ff66847c3644ebc3eb559a03}{ 
    136 void \hyperlink{classbdm_1_1RV_0b2c9e73ff66847c3644ebc3eb559a03}{set\_\-size} (int at, int size0)} 
    137 \label{classbdm_1_1RV_0b2c9e73ff66847c3644ebc3eb559a03} 
    138  
    139 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    140 \hypertarget{classbdm_1_1RV_fb2892d12dc978549e9491aed327dfd4}{ 
    141 void \hyperlink{classbdm_1_1RV_fb2892d12dc978549e9491aed327dfd4}{set\_\-time} (int at, int time0)} 
    142 \label{classbdm_1_1RV_fb2892d12dc978549e9491aed327dfd4} 
    143  
    144 \begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    145 \hypertarget{classbdm_1_1RV_176e9c0c35b51fee0ad8813a39883a63}{ 
    146 void \hyperlink{classbdm_1_1RV_176e9c0c35b51fee0ad8813a39883a63}{newids} ()} 
    147 \label{classbdm_1_1RV_176e9c0c35b51fee0ad8813a39883a63} 
    148  
    149 \begin{CompactList}\small\item\em Assign unused ids to this rv. \item\end{CompactList}\end{CompactItemize} 
     154\begin{CompactList}\small\item\em Minimum time-offset. \item\end{CompactList}\end{CompactItemize} 
     155\end{Indent} 
    150156\subsection*{Protected Attributes} 
    151157\begin{CompactItemize} 
    152158\item  
    153 \hypertarget{classbdm_1_1RV_38203096d950671def44de8cf1c6bb2e}{ 
    154 int \hyperlink{classbdm_1_1RV_38203096d950671def44de8cf1c6bb2e}{tsize}} 
    155 \label{classbdm_1_1RV_38203096d950671def44de8cf1c6bb2e} 
    156  
    157 \begin{CompactList}\small\item\em size = sum of sizes \item\end{CompactList}\item  
     159\hypertarget{classbdm_1_1RV_0cfe477965243a89eb87a06b024e2fcb}{ 
     160int \hyperlink{classbdm_1_1RV_0cfe477965243a89eb87a06b024e2fcb}{dsize}} 
     161\label{classbdm_1_1RV_0cfe477965243a89eb87a06b024e2fcb} 
     162 
     163\begin{CompactList}\small\item\em size of the data vector \item\end{CompactList}\item  
    158164\hypertarget{classbdm_1_1RV_b11bfdceb831ed30d33b852dd4a6b385}{ 
    159165int \hyperlink{classbdm_1_1RV_b11bfdceb831ed30d33b852dd4a6b385}{len}} 
    160166\label{classbdm_1_1RV_b11bfdceb831ed30d33b852dd4a6b385} 
    161167 
    162 \begin{CompactList}\small\item\em len = number of individual rvs \item\end{CompactList}\item  
     168\begin{CompactList}\small\item\em number of individual rvs \item\end{CompactList}\item  
    163169\hypertarget{classbdm_1_1RV_0a9a4769ab5a322495bea0cd8091500b}{ 
    164170ivec \hyperlink{classbdm_1_1RV_0a9a4769ab5a322495bea0cd8091500b}{ids}} 
    … …  
    166172 
    167173\begin{CompactList}\small\item\em Vector of unique IDs. \item\end{CompactList}\item  
    168 \hypertarget{classbdm_1_1RV_0112d25045f6f8fabdc9e821029928ee}{ 
    169 ivec \hyperlink{classbdm_1_1RV_0112d25045f6f8fabdc9e821029928ee}{sizes}} 
    170 \label{classbdm_1_1RV_0112d25045f6f8fabdc9e821029928ee} 
    171  
    172 \begin{CompactList}\small\item\em Vector of sizes. \item\end{CompactList}\item  
    173174\hypertarget{classbdm_1_1RV_ef6703854820bbf61736738f1bac6896}{ 
    174175ivec \hyperlink{classbdm_1_1RV_ef6703854820bbf61736738f1bac6896}{times}} 
    175176\label{classbdm_1_1RV_ef6703854820bbf61736738f1bac6896} 
    176177 
    177 \begin{CompactList}\small\item\em Vector of shifts from current time. \item\end{CompactList}\item  
    178 \hypertarget{classbdm_1_1RV_9a87c46918c3c0db0bdca854a48a44aa}{ 
    179 Array$<$ std::string $>$ \hyperlink{classbdm_1_1RV_9a87c46918c3c0db0bdca854a48a44aa}{names}} 
    180 \label{classbdm_1_1RV_9a87c46918c3c0db0bdca854a48a44aa} 
    181  
    182 \begin{CompactList}\small\item\em Array of names. \item\end{CompactList}\end{CompactItemize} 
    183 \subsection*{Friends} 
    184 \begin{CompactItemize} 
    185 \item  
    186 \hypertarget{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8}{ 
    187 std::ostream \& \hyperlink{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8}{operator$<$$<$} (std::ostream \&os, const \hyperlink{classbdm_1_1RV}{RV} \&rv)} 
    188 \label{classbdm_1_1RV_cad6f15535d10437f6690cb4492176a8} 
    189  
    190 \begin{CompactList}\small\item\em Printing output e.g. for debugging. \item\end{CompactList}\end{CompactItemize} 
    191  
    192  
    193 \subsection{Detailed Description} 
    194 Class representing variables, most often random variables.  
    195  
    196 More?...  
     178\begin{CompactList}\small\item\em Vector of shifts from current time. \item\end{CompactList}\end{CompactItemize} 
     179 
    197180 
    198181\subsection{Member Function Documentation} 
    … …  
    210193 
    211194 
    212 References ids, len, length(), and times. 
     195References ids, length(), and times. 
    213196 
    214197Referenced by add(), dataind(), and subt().\hypertarget{classbdm_1_1RV_87841b5ee43997b79789c0c22047e224}{ 
    … …  
    225208 
    226209 
    227 References bdm::concat(), findself(), ids, len, names, sizes, times, and tsize. 
    228  
    229 Referenced by UIArxDS::build(), UIARX::build(), bdm::concat(), bdm::compositepdf::getrv(), bdm::merger::merger(), bdm::MPF$<$ BM\_\-T $>$::MPF(), and bdm::compositepdf::setrvc().\hypertarget{classbdm_1_1RV_cbebdb5e0d30101a6eb63550ef701c55}{ 
     210References bdm::concat(), countsize(), dsize, findself(), ids, len, and times. 
     211 
     212Referenced by UIArxDS::build(), UIARX::build(), bdm::concat(), bdm::compositepdf::getrv(), bdm::merger::merger(), and bdm::compositepdf::setrvc().\hypertarget{classbdm_1_1RV_cbebdb5e0d30101a6eb63550ef701c55}{ 
    230213\index{bdm::RV@{bdm::RV}!dataind@{dataind}} 
    231214\index{dataind@{dataind}!bdm::RV@{bdm::RV}} 
    … …  
    236219when this rv is a part of bigger rv, this function returns indeces of self in the data vector of the bigger crv. Then, data can be copied via: data\_\-of\_\-this = cdata(ind);  
    237220 
    238 References bdm::concat(), count(), ids, bdm::str::ids, len, times, bdm::str::times, tostr(), and tsize. 
     221References \_\-dsize(), bdm::concat(), ids, bdm::str::ids, times, bdm::str::times, and tostr(). 
    239222 
    240223Referenced by bdm::enorm$<$ sq\_\-T $>$::condition(), bdm::datalink\_\-m2e::datalink\_\-m2e(), bdm::datalink\_\-m2m::datalink\_\-m2m(), and bdm::enorm$<$ sq\_\-T $>$::marginal().\hypertarget{classbdm_1_1RV_c92b92ecfd95c89be13ab3e6cb6855c1}{ 
    … …  
    247230generate mutual indeces when copying data betwenn self and crv. Data are copied via: data\_\-of\_\-this(selfi) = data\_\-of\_\-rv2(rv2i)  
    248231 
    249 References bdm::concat(), findself(), ids, bdm::str::ids, len, length(), times, bdm::str::times, and tostr(). 
     232References bdm::concat(), findself(), ids, bdm::str::ids, length(), times, bdm::str::times, and tostr(). 
    250233 
    251234The documentation for this class was generated from the following files:\begin{CompactItemize}