root/library/doc/html/classbdm_1_1RV.html @ 651

Revision 651, 34.2 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: bdm::RV Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1RV.html">RV</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::RV Class Reference</h1><!-- doxytag: class="bdm::RV" --><!-- doxytag: inherits="bdm::root" -->Class representing variables, most often random variables. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1RV-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#6564bdd36b6845a51446a192d33e1194">from_setting</a> (const Setting &amp;set)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).  <a href="#6564bdd36b6845a51446a192d33e1194"></a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0743ab524c18d0c6553b29b043fd42bd"></a><!-- doxytag: member="bdm::RV::show_all" ref="0743ab524c18d0c6553b29b043fd42bd" args="()" -->
84string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#0743ab524c18d0c6553b29b043fd42bd">show_all</a> ()</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function for debugging <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> related stuff <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::RV::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
88virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::RV::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
92virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
95<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fa35c2744e687c74f7742990e6aa264"></a><!-- doxytag: member="bdm::RV::RV" ref="3fa35c2744e687c74f7742990e6aa264" args="(const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes, const ivec &amp;in_times)" -->
97&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#3fa35c2744e687c74f7742990e6aa264">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes, const ivec &amp;in_times)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="381f5d963bb54efd4e76815dc93d50ce"></a><!-- doxytag: member="bdm::RV::RV" ref="381f5d963bb54efd4e76815dc93d50ce" args="(const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)" -->
101&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#381f5d963bb54efd4e76815dc93d50ce">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with times=0. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb47d71d82639ec7ddf2635b21aafd00"></a><!-- doxytag: member="bdm::RV::RV" ref="cb47d71d82639ec7ddf2635b21aafd00" args="(const Array&lt; std::string &gt; &amp;in_names)" -->
105&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cb47d71d82639ec7ddf2635b21aafd00">RV</a> (const Array&lt; std::string &gt; &amp;in_names)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with sizes=1, times=0. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e319ca900261a5005a9b4b353ec16412"></a><!-- doxytag: member="bdm::RV::RV" ref="e319ca900261a5005a9b4b353ec16412" args="()" -->
109&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#e319ca900261a5005a9b4b353ec16412">RV</a> ()</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor of empty <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a990e0f30c0e34f04c14260ab8ba5b5f"></a><!-- doxytag: member="bdm::RV::RV" ref="a990e0f30c0e34f04c14260ab8ba5b5f" args="(string name, int sz, int tm=0)" -->
113&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a990e0f30c0e34f04c14260ab8ba5b5f">RV</a> (string name, int sz, int tm=0)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor of a single <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> with given id. <br></td></tr>
116<tr><td colspan="2"><div class="groupHeader">Algebra on Random Variables</div></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#1367055b2608ad9d50d01a2da6cec869">findself</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indices of self in another rv,.  <a href="#1367055b2608ad9d50d01a2da6cec869"></a><br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a858d36d0264e1f1c89500531162fdf1">findself_ids</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indices of self in another rv, ignore time,.  <a href="#a858d36d0264e1f1c89500531162fdf1"></a><br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bb011af88ae98f5c97955bb2c95cfee"></a><!-- doxytag: member="bdm::RV::equal" ref="3bb011af88ae98f5c97955bb2c95cfee" args="(const RV &amp;rv2) const " -->
124bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#3bb011af88ae98f5c97955bb2c95cfee">equal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare if <code>rv2</code> is identical to this <code><a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a></code>. <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#87841b5ee43997b79789c0c22047e224">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (concat) another variable to the current one,.  <a href="#87841b5ee43997b79789c0c22047e224"></a><br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aec44dabdf0a6d90fbae95e1356eda39"></a><!-- doxytag: member="bdm::RV::subt" ref="aec44dabdf0a6d90fbae95e1356eda39" args="(const RV &amp;rv2) const " -->
131<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#aec44dabdf0a6d90fbae95e1356eda39">subt</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subtract another variable from the current one. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0c04ab99ded62e1e05bcefb151ebeb9"></a><!-- doxytag: member="bdm::RV::subselect" ref="c0c04ab99ded62e1e05bcefb151ebeb9" args="(const ivec &amp;ind) const " -->
135<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#c0c04ab99ded62e1e05bcefb151ebeb9">subselect</a> (const ivec &amp;ind) const </td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f3daf0f857fff53a1c0a445fe160966"></a><!-- doxytag: member="bdm::RV::operator()" ref="6f3daf0f857fff53a1c0a445fe160966" args="(const ivec &amp;ind) const " -->
139<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#6f3daf0f857fff53a1c0a445fe160966">operator()</a> (const ivec &amp;ind) const </td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="452fb5f7ab1eafe17932bf9f458d0415"></a><!-- doxytag: member="bdm::RV::operator()" ref="452fb5f7ab1eafe17932bf9f458d0415" args="(int di1, int di2) const " -->
143<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#452fb5f7ab1eafe17932bf9f458d0415">operator()</a> (int di1, int di2) const </td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select from data vector starting at di1 to di2. <br></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="449c2b692957528976c189d27236e1ba"></a><!-- doxytag: member="bdm::RV::t_plus" ref="449c2b692957528976c189d27236e1ba" args="(int delta)" -->
147void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#449c2b692957528976c189d27236e1ba">t_plus</a> (int delta)</td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift <code>time</code> by delta. <br></td></tr>
150<tr><td colspan="2"><div class="groupHeader">Time manipulation functions</div></td></tr>
151<tr><td colspan="2"><div class="groupText">returns rvs with time set to 0 and removed duplicates <br><br></div></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9e1787523f4d5f636e4f738c319d3e3"></a><!-- doxytag: member="bdm::RV::remove_time" ref="e9e1787523f4d5f636e4f738c319d3e3" args="() const " -->
153<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>remove_time</b> () const </td></tr>
154
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="627222f49abc5d07e5e8aecac7708ee2"></a><!-- doxytag: member="bdm::RV::copy_t" ref="627222f49abc5d07e5e8aecac7708ee2" args="(int dt) const " -->
156<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#627222f49abc5d07e5e8aecac7708ee2">copy_t</a> (int dt) const </td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">create new <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> from the current one with time shifted by given value <br></td></tr>
159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5819f71d774649412c10b8e1716be1e"></a><!-- doxytag: member="bdm::RV::expand_delayes" ref="c5819f71d774649412c10b8e1716be1e" args="() const " -->
160<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#c5819f71d774649412c10b8e1716be1e">expand_delayes</a> () const </td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return rvs with expanded delayes and sorted in the order of: <br></td></tr>
163<tr><td colspan="2"><div class="groupHeader">Relation to vectors</div></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bdd7f4072749c7cc864b78a418ca388"></a><!-- doxytag: member="bdm::RV::tostr" ref="8bdd7f4072749c7cc864b78a418ca388" args="() const " -->
165<a class="el" href="classbdm_1_1str.html">str</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#8bdd7f4072749c7cc864b78a418ca388">tostr</a> () const </td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate <code><a class="el" href="classbdm_1_1str.html" title="Structure of RV, i.e. RVs expanded into a flat list of IDs, used for debugging.">str</a></code> from rv, by expanding sizes <br></td></tr>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbebdb5e0d30101a6eb63550ef701c55"></a><!-- doxytag: member="bdm::RV::dataind" ref="cbebdb5e0d30101a6eb63550ef701c55" args="(const RV &amp;crv) const " -->
169ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cbebdb5e0d30101a6eb63550ef701c55">dataind</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;crv) const </td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">when this rv is a part of bigger rv, this function returns indices of self in the data vector of the bigger crv. Then, data can be copied via: data_of_this = cdata(ind); <br></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c6e3a1c54a612d2ea390c841aa5eb6f"></a><!-- doxytag: member="bdm::RV::dataind_part" ref="0c6e3a1c54a612d2ea390c841aa5eb6f" args="(const RV &amp;crv) const " -->
173ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#0c6e3a1c54a612d2ea390c841aa5eb6f">dataind_part</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;crv) const </td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">same as dataind but this time crv should not be complete supperset of rv. <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c92b92ecfd95c89be13ab3e6cb6855c1"></a><!-- doxytag: member="bdm::RV::dataind" ref="c92b92ecfd95c89be13ab3e6cb6855c1" args="(const RV &amp;rv2, ivec &amp;selfi, ivec &amp;rv2i) const " -->
177void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#c92b92ecfd95c89be13ab3e6cb6855c1">dataind</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2, ivec &amp;selfi, ivec &amp;rv2i) const </td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate mutual indices when copying data between self and crv. Data are copied via: data_of_this(selfi) = data_of_rv2(rv2i) <br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a5c5aeeaf39299d07763377b05a8241"></a><!-- doxytag: member="bdm::RV::mint" ref="9a5c5aeeaf39299d07763377b05a8241" args="() const " -->
181int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#9a5c5aeeaf39299d07763377b05a8241">mint</a> () const </td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum time-offset. <br></td></tr>
184<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
185<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab92b361335a644df654cf7cf7e5ffc0"></a><!-- doxytag: member="bdm::RV::clear_all" ref="ab92b361335a644df654cf7cf7e5ffc0" args="()" -->
186static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ab92b361335a644df654cf7cf7e5ffc0">clear_all</a> ()</td></tr>
187
188<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invalidate all named RVs. Use before initializing any <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> instances, with care... <br></td></tr>
189<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
190<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0cfe477965243a89eb87a06b024e2fcb"></a><!-- doxytag: member="bdm::RV::dsize" ref="0cfe477965243a89eb87a06b024e2fcb" args="" -->
191int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#0cfe477965243a89eb87a06b024e2fcb">dsize</a></td></tr>
192
193<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of the data vector <br></td></tr>
194<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b11bfdceb831ed30d33b852dd4a6b385"></a><!-- doxytag: member="bdm::RV::len" ref="b11bfdceb831ed30d33b852dd4a6b385" args="" -->
195int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#b11bfdceb831ed30d33b852dd4a6b385">len</a></td></tr>
196
197<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">number of individual rvs <br></td></tr>
198<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a9a4769ab5a322495bea0cd8091500b"></a><!-- doxytag: member="bdm::RV::ids" ref="0a9a4769ab5a322495bea0cd8091500b" args="" -->
199ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#0a9a4769ab5a322495bea0cd8091500b">ids</a></td></tr>
200
201<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of unique IDs. <br></td></tr>
202<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef6703854820bbf61736738f1bac6896"></a><!-- doxytag: member="bdm::RV::times" ref="ef6703854820bbf61736738f1bac6896" args="" -->
203ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ef6703854820bbf61736738f1bac6896">times</a></td></tr>
204
205<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of shifts from current time. <br></td></tr>
206<tr><td colspan="2"><br><h2>Access functions</h2></td></tr>
207<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b361a9044e6a43102c4f873b9f566a0f"></a><!-- doxytag: member="bdm::RV::to_string" ref="b361a9044e6a43102c4f873b9f566a0f" args="()" -->
208string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#b361a9044e6a43102c4f873b9f566a0f">to_string</a> ()</td></tr>
209
210<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
211<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de30156104f61d86c94f758861418089"></a><!-- doxytag: member="bdm::RV::_dsize" ref="de30156104f61d86c94f758861418089" args="() const " -->
212int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#de30156104f61d86c94f758861418089">_dsize</a> () const </td></tr>
213
214<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total size of a random variable <br></td></tr>
215<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26318eb90cb172ea86d1f45de9131c4e"></a><!-- doxytag: member="bdm::RV::_ids" ref="26318eb90cb172ea86d1f45de9131c4e" args="() const " -->
216const ivec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#26318eb90cb172ea86d1f45de9131c4e">_ids</a> () const </td></tr>
217
218<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
219<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39f9b44752376f07e346579b5ff8cbbd"></a><!-- doxytag: member="bdm::RV::countsize" ref="39f9b44752376f07e346579b5ff8cbbd" args="() const " -->
220int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#39f9b44752376f07e346579b5ff8cbbd">countsize</a> () const </td></tr>
221
222<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Recount size of the corresponding data vector. <br></td></tr>
223<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="412d43294bac38fa1804829e38fa4eaf"></a><!-- doxytag: member="bdm::RV::cumsizes" ref="412d43294bac38fa1804829e38fa4eaf" args="() const " -->
224ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#412d43294bac38fa1804829e38fa4eaf">cumsizes</a> () const </td></tr>
225
226<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of cumulative sizes of <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>. <br></td></tr>
227<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9ec8c3e756651ff352ab5e3d3acda4b"></a><!-- doxytag: member="bdm::RV::length" ref="e9ec8c3e756651ff352ab5e3d3acda4b" args="() const " -->
228int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#e9ec8c3e756651ff352ab5e3d3acda4b">length</a> () const </td></tr>
229
230<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of named parts. <br></td></tr>
231<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5900b42f778129a9e56008a1e8e489c8"></a><!-- doxytag: member="bdm::RV::id" ref="5900b42f778129a9e56008a1e8e489c8" args="(int at) const " -->
232int&nbsp;</td><td class="memItemRight" valign="bottom"><b>id</b> (int at) const </td></tr>
233
234<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bde62551a3fc8f3f83c569860b73f705"></a><!-- doxytag: member="bdm::RV::size" ref="bde62551a3fc8f3f83c569860b73f705" args="(int at) const " -->
235int&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> (int at) const </td></tr>
236
237<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c94373d3a760919b4b3eee58b42e3a45"></a><!-- doxytag: member="bdm::RV::time" ref="c94373d3a760919b4b3eee58b42e3a45" args="(int at) const " -->
238int&nbsp;</td><td class="memItemRight" valign="bottom"><b>time</b> (int at) const </td></tr>
239
240<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74c6ec8eb9c1dd69ad1d986eaee16dc2"></a><!-- doxytag: member="bdm::RV::name" ref="74c6ec8eb9c1dd69ad1d986eaee16dc2" args="(int at) const " -->
241std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>name</b> (int at) const </td></tr>
242
243<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bae3443ded87dc9941d763e4c48cee0"></a><!-- doxytag: member="bdm::RV::scalarname" ref="9bae3443ded87dc9941d763e4c48cee0" args="(int scalat) const " -->
244std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#9bae3443ded87dc9941d763e4c48cee0">scalarname</a> (int scalat) const </td></tr>
245
246<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns name of a scalar at position scalat, i.e. it can be in the middle of vector name, in that case it adds "_%d" to it <br></td></tr>
247<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb2892d12dc978549e9491aed327dfd4"></a><!-- doxytag: member="bdm::RV::set_time" ref="fb2892d12dc978549e9491aed327dfd4" args="(int at, int time0)" -->
248void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_time</b> (int at, int time0)</td></tr>
249
250<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cad6f15535d10437f6690cb4492176a8"></a><!-- doxytag: member="bdm::RV::operator&lt;&lt;" ref="cad6f15535d10437f6690cb4492176a8" args="(std::ostream &amp;os, const RV &amp;rv)" -->
251std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cad6f15535d10437f6690cb4492176a8">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
252
253<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">State output, e.g. for debugging. <br></td></tr>
254</table>
255<hr><a name="_details"></a><h2>Detailed Description</h2>
256Class representing variables, most often random variables.
257<p>
258The purpose of this class is to decribe a vector of data. Such description is used for connecting various vectors between each other, see class <a class="el" href="classbdm_1_1datalink.html" title="DataLink is a connection between two data vectors Up and Down.">datalink</a>.<p>
259The class is implemented using global variables to assure uniqueness of description:<p>
260In is a vector <div align="center">
261<img src="inline_dotgraph_3.dot.png" alt="inline_dotgraph_3.dot" border="0" usemap="#inline_dotgraph_3.dot.map">
262<map name="inline_dotgraph_3.dot.map"></map>
263</div>
264 <hr><h2>Member Function Documentation</h2>
265<a class="anchor" name="87841b5ee43997b79789c0c22047e224"></a><!-- doxytag: member="bdm::RV::add" ref="87841b5ee43997b79789c0c22047e224" args="(const RV &amp;rv2)" -->
266<div class="memitem">
267<div class="memproto">
268      <table class="memname">
269        <tr>
270          <td class="memname">bool bdm::RV::add           </td>
271          <td>(</td>
272          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
273          <td class="paramname"> <em>rv2</em>          </td>
274          <td>&nbsp;)&nbsp;</td>
275          <td></td>
276        </tr>
277      </table>
278</div>
279<div class="memdoc">
280
281<p>
282Add (concat) another variable to the current one,.
283<p>
284<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if all rv2 were added, false if rv2 is in conflict </dd></dl>
285
286<p>References <a class="el" href="bdmbase_8cpp_source.html#l00061">countsize()</a>, <a class="el" href="bdmbase_8h_source.html#l00098">dsize</a>, <a class="el" href="bdmbase_8cpp_source.html#l00325">findself()</a>, <a class="el" href="bdmbase_8h_source.html#l00102">ids</a>, <a class="el" href="bdmbase_8h_source.html#l00100">len</a>, and <a class="el" href="bdmbase_8h_source.html#l00104">times</a>.</p>
287
288<p>Referenced by <a class="el" href="kalman_8h_source.html#l00380">bdm::StateCanonical::connect_mlnorm()</a>, <a class="el" href="bdmbase_8h_source.html#l00241">expand_delayes()</a>, <a class="el" href="particles_8h_source.html#l00124">bdm::PF::from_setting()</a>, <a class="el" href="datasources_8h_source.html#l00351">bdm::ArxDS::set_drv()</a>, <a class="el" href="emix_8cpp_source.html#l00205">bdm::mprod::set_elements()</a>, <a class="el" href="emix_8h_source.html#l00381">bdm::eprod::set_parameters()</a>, and <a class="el" href="merger_8h_source.html#l00095">bdm::merger_base::set_sources()</a>.</p>
289
290</div>
291</div><p>
292<a class="anchor" name="1367055b2608ad9d50d01a2da6cec869"></a><!-- doxytag: member="bdm::RV::findself" ref="1367055b2608ad9d50d01a2da6cec869" args="(const RV &amp;rv2) const " -->
293<div class="memitem">
294<div class="memproto">
295      <table class="memname">
296        <tr>
297          <td class="memname">ivec bdm::RV::findself           </td>
298          <td>(</td>
299          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
300          <td class="paramname"> <em>rv2</em>          </td>
301          <td>&nbsp;)&nbsp;</td>
302          <td> const</td>
303        </tr>
304      </table>
305</div>
306<div class="memdoc">
307
308<p>
309Find indices of self in another rv,.
310<p>
311<dl class="return" compact><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl>
312
313<p>References <a class="el" href="bdmbase_8h_source.html#l00102">ids</a>, <a class="el" href="bdmbase_8h_source.html#l00168">length()</a>, and <a class="el" href="bdmbase_8h_source.html#l00104">times</a>.</p>
314
315<p>Referenced by <a class="el" href="bdmbase_8cpp_source.html#l00101">add()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00283">dataind()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00316">subt()</a>.</p>
316
317</div>
318</div><p>
319<a class="anchor" name="a858d36d0264e1f1c89500531162fdf1"></a><!-- doxytag: member="bdm::RV::findself_ids" ref="a858d36d0264e1f1c89500531162fdf1" args="(const RV &amp;rv2) const " -->
320<div class="memitem">
321<div class="memproto">
322      <table class="memname">
323        <tr>
324          <td class="memname">ivec bdm::RV::findself_ids           </td>
325          <td>(</td>
326          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
327          <td class="paramname"> <em>rv2</em>          </td>
328          <td>&nbsp;)&nbsp;</td>
329          <td> const</td>
330        </tr>
331      </table>
332</div>
333<div class="memdoc">
334
335<p>
336Find indices of self in another rv, ignore time,.
337<p>
338<dl class="return" compact><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl>
339
340<p>References <a class="el" href="bdmbase_8h_source.html#l00102">ids</a>, and <a class="el" href="bdmbase_8h_source.html#l00168">length()</a>.</p>
341
342<p>Referenced by <a class="el" href="bdmbase_8h_source.html#l00729">bdm::datalink_buffered::set_connection()</a>.</p>
343
344</div>
345</div><p>
346<a class="anchor" name="6564bdd36b6845a51446a192d33e1194"></a><!-- doxytag: member="bdm::RV::from_setting" ref="6564bdd36b6845a51446a192d33e1194" args="(const Setting &amp;set)" -->
347<div class="memitem">
348<div class="memproto">
349      <table class="memname">
350        <tr>
351          <td class="memname">void bdm::RV::from_setting           </td>
352          <td>(</td>
353          <td class="paramtype">const Setting &amp;&nbsp;</td>
354          <td class="paramname"> <em>set</em>          </td>
355          <td>&nbsp;)&nbsp;</td>
356          <td><code> [virtual]</code></td>
357        </tr>
358      </table>
359</div>
360<div class="memdoc">
361
362<p>
363<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).
364<p>
365<div class="fragment"><pre class="fragment">        <span class="keyword">class </span>= '<a class="code" href="classbdm_1_1RV.html#e319ca900261a5005a9b4b353ec16412" title="Constructor of empty RV.">RV</a>';                   
366        names = {<span class="charliteral">'a'</span>, <span class="charliteral">'b'</span>, <span class="charliteral">'c'</span>, ...};   <span class="comment">// UNIQUE IDENTIFIER same names = same variable</span>
367                                                                        <span class="comment">// names are also used when storing results </span>
368        --- optional ---
369        sizes = [1, 2, 3, ...];         <span class="comment">// size of each name. default = ones()</span>
370                                                                        <span class="comment">// if size = -1, it is found out from previous instances of the same name</span>
371        <a class="code" href="classbdm_1_1RV.html#ef6703854820bbf61736738f1bac6896" title="Vector of shifts from current time.">times</a> = [-1, -2, 0, ...];       <span class="comment">// time shifts with respect to current time, default = zeros()</span>
372</pre></div> 
373<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
374
375<p>References <a class="el" href="user__info_8h_source.html#l00451">bdm::UI::get()</a>.</p>
376
377</div>
378</div><p>
379<hr>The documentation for this class was generated from the following files:<ul>
380<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a><li>bdmbase.cpp</ul>
381</div>
382<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:45 2009 for mixpp by&nbsp;
383<a href="http://www.doxygen.org/index.html">
384<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
385</body>
386</html>
Note: See TracBrowser for help on using the browser.