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

Revision 614, 34.3 kB (checked in by smidl, 15 years ago)

doc

RevLine 
[591]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
[259]5<title>mixpp: bdm::RV Class Reference</title>
[591]6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.1 -->
[271]11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
[259]52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
[271]55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[290]57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
[290]64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
[271]69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1RV.html">RV</a>
[259]70  </div>
71</div>
72<div class="contents">
[591]73<h1>bdm::RV Class Reference</h1><!-- doxytag: class="bdm::RV" --><!-- doxytag: inherits="bdm::root" -->
74<p>Class representing variables, most often random variables. 
75<a href="#_details">More...</a></p>
[259]76
[591]77<p><code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code></p>
[353]78
[591]79<p><a href="classbdm_1_1RV-members.html">List of all members.</a></p>
80<table border="0" cellpadding="0" cellspacing="0">
81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a6564bdd36b6845a51446a192d33e1194">from_setting</a> (const Setting &amp;set)</td></tr>
83<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="#a6564bdd36b6845a51446a192d33e1194"></a><br/></td></tr>
[608]84<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0743ab524c18d0c6553b29b043fd42bd"></a><!-- doxytag: member="bdm::RV::show_all" ref="a0743ab524c18d0c6553b29b043fd42bd" args="()" -->
85string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a0743ab524c18d0c6553b29b043fd42bd">show_all</a> ()</td></tr>
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>
[591]87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::RV::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
88virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::RV::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
91virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
[270]93<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
[591]94<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp559a25fdb98a7d1fd1c3771ac568d5e9"></a> </p>
95<br/><br/></div></td></tr>
96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fa35c2744e687c74f7742990e6aa264"></a><!-- doxytag: member="bdm::RV::RV" ref="a3fa35c2744e687c74f7742990e6aa264" 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#a3fa35c2744e687c74f7742990e6aa264">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes, const ivec &amp;in_times)</td></tr>
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a381f5d963bb54efd4e76815dc93d50ce"></a><!-- doxytag: member="bdm::RV::RV" ref="a381f5d963bb54efd4e76815dc93d50ce" args="(const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)" -->
100&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a381f5d963bb54efd4e76815dc93d50ce">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)</td></tr>
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with times=0. <br/></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb47d71d82639ec7ddf2635b21aafd00"></a><!-- doxytag: member="bdm::RV::RV" ref="acb47d71d82639ec7ddf2635b21aafd00" args="(const Array&lt; std::string &gt; &amp;in_names)" -->
103&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#acb47d71d82639ec7ddf2635b21aafd00">RV</a> (const Array&lt; std::string &gt; &amp;in_names)</td></tr>
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with sizes=1, times=0. <br/></td></tr>
105<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae319ca900261a5005a9b4b353ec16412"></a><!-- doxytag: member="bdm::RV::RV" ref="ae319ca900261a5005a9b4b353ec16412" args="()" -->
106&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ae319ca900261a5005a9b4b353ec16412">RV</a> ()</td></tr>
107<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>
108<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa990e0f30c0e34f04c14260ab8ba5b5f"></a><!-- doxytag: member="bdm::RV::RV" ref="aa990e0f30c0e34f04c14260ab8ba5b5f" args="(string name, int sz, int tm=0)" -->
109&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#aa990e0f30c0e34f04c14260ab8ba5b5f">RV</a> (string name, int sz, int tm=0)</td></tr>
110<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>
[270]111<tr><td colspan="2"><div class="groupHeader">Algebra on Random Variables</div></td></tr>
[591]112<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp64cb0288e151258189b025c20f50b7e1"></a> </p>
113<br/><br/></div></td></tr>
114<tr><td class="memItemLeft" align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a1367055b2608ad9d50d01a2da6cec869">findself</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indices of self in another rv,.  <a href="#a1367055b2608ad9d50d01a2da6cec869"></a><br/></td></tr>
[608]116<tr><td class="memItemLeft" align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#aa858d36d0264e1f1c89500531162fdf1">findself_ids</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indices of self in another rv, ignore time,.  <a href="#aa858d36d0264e1f1c89500531162fdf1"></a><br/></td></tr>
[591]118<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bb011af88ae98f5c97955bb2c95cfee"></a><!-- doxytag: member="bdm::RV::equal" ref="a3bb011af88ae98f5c97955bb2c95cfee" args="(const RV &amp;rv2) const " -->
119bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a3bb011af88ae98f5c97955bb2c95cfee">equal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
120<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>
121<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a87841b5ee43997b79789c0c22047e224">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2)</td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (concat) another variable to the current one,.  <a href="#a87841b5ee43997b79789c0c22047e224"></a><br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaec44dabdf0a6d90fbae95e1356eda39"></a><!-- doxytag: member="bdm::RV::subt" ref="aaec44dabdf0a6d90fbae95e1356eda39" args="(const RV &amp;rv2) const " -->
124<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#aaec44dabdf0a6d90fbae95e1356eda39">subt</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2) const </td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subtract another variable from the current one. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0c04ab99ded62e1e05bcefb151ebeb9"></a><!-- doxytag: member="bdm::RV::subselect" ref="ac0c04ab99ded62e1e05bcefb151ebeb9" args="(const ivec &amp;ind) const " -->
127<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#ac0c04ab99ded62e1e05bcefb151ebeb9">subselect</a> (const ivec &amp;ind) const </td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br/></td></tr>
129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f3daf0f857fff53a1c0a445fe160966"></a><!-- doxytag: member="bdm::RV::operator()" ref="a6f3daf0f857fff53a1c0a445fe160966" args="(const ivec &amp;ind) const " -->
130<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#a6f3daf0f857fff53a1c0a445fe160966">operator()</a> (const ivec &amp;ind) const </td></tr>
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br/></td></tr>
132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a452fb5f7ab1eafe17932bf9f458d0415"></a><!-- doxytag: member="bdm::RV::operator()" ref="a452fb5f7ab1eafe17932bf9f458d0415" args="(int di1, int di2) const " -->
133<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#a452fb5f7ab1eafe17932bf9f458d0415">operator()</a> (int di1, int di2) const </td></tr>
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select from data vector starting at di1 to di2. <br/></td></tr>
[608]135<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a449c2b692957528976c189d27236e1ba"></a><!-- doxytag: member="bdm::RV::t_plus" ref="a449c2b692957528976c189d27236e1ba" args="(int delta)" -->
136void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a449c2b692957528976c189d27236e1ba">t_plus</a> (int delta)</td></tr>
[591]137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift <code>time</code> by delta. <br/></td></tr>
[608]138<tr><td colspan="2"><div class="groupHeader">Time manipulation functions</div></td></tr>
139<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpae06cb9901d7bdd0e1d9dc742effec16"></a> returns rvs with time set to 0 and removed duplicates </p>
140<br/><br/></div></td></tr>
141<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9e1787523f4d5f636e4f738c319d3e3"></a><!-- doxytag: member="bdm::RV::remove_time" ref="ae9e1787523f4d5f636e4f738c319d3e3" args="() const " -->
142<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>remove_time</b> () const </td></tr>
143<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a627222f49abc5d07e5e8aecac7708ee2"></a><!-- doxytag: member="bdm::RV::copy_t" ref="a627222f49abc5d07e5e8aecac7708ee2" args="(int dt) const " -->
144<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#a627222f49abc5d07e5e8aecac7708ee2">copy_t</a> (int dt) const </td></tr>
145<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>
146<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5819f71d774649412c10b8e1716be1e"></a><!-- doxytag: member="bdm::RV::expand_delayes" ref="ac5819f71d774649412c10b8e1716be1e" args="() const " -->
147<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#ac5819f71d774649412c10b8e1716be1e">expand_delayes</a> () const </td></tr>
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return rvs with expanded delayes and sorted in the order of: <br/></td></tr>
[270]149<tr><td colspan="2"><div class="groupHeader">Relation to vectors</div></td></tr>
[591]150<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpbf7d6716e6a2259c0d28e2e7477a0b81"></a> </p>
151<br/><br/></div></td></tr>
152<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bdd7f4072749c7cc864b78a418ca388"></a><!-- doxytag: member="bdm::RV::tostr" ref="a8bdd7f4072749c7cc864b78a418ca388" args="() const " -->
153<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#a8bdd7f4072749c7cc864b78a418ca388">tostr</a> () const </td></tr>
154<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>
[608]155<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbebdb5e0d30101a6eb63550ef701c55"></a><!-- doxytag: member="bdm::RV::dataind" ref="acbebdb5e0d30101a6eb63550ef701c55" args="(const RV &amp;crv) const " -->
156ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#acbebdb5e0d30101a6eb63550ef701c55">dataind</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;crv) const </td></tr>
157<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>
158<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c6e3a1c54a612d2ea390c841aa5eb6f"></a><!-- doxytag: member="bdm::RV::dataind_part" ref="a0c6e3a1c54a612d2ea390c841aa5eb6f" args="(const RV &amp;crv) const " -->
159ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a0c6e3a1c54a612d2ea390c841aa5eb6f">dataind_part</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;crv) const </td></tr>
160<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>
161<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac92b92ecfd95c89be13ab3e6cb6855c1"></a><!-- doxytag: member="bdm::RV::dataind" ref="ac92b92ecfd95c89be13ab3e6cb6855c1" args="(const RV &amp;rv2, ivec &amp;selfi, ivec &amp;rv2i) const " -->
162void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ac92b92ecfd95c89be13ab3e6cb6855c1">dataind</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv2, ivec &amp;selfi, ivec &amp;rv2i) const </td></tr>
163<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>
[591]164<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a5c5aeeaf39299d07763377b05a8241"></a><!-- doxytag: member="bdm::RV::mint" ref="a9a5c5aeeaf39299d07763377b05a8241" args="() const " -->
165int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a9a5c5aeeaf39299d07763377b05a8241">mint</a> () const </td></tr>
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum time-offset. <br/></td></tr>
167<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
168<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab92b361335a644df654cf7cf7e5ffc0"></a><!-- doxytag: member="bdm::RV::clear_all" ref="aab92b361335a644df654cf7cf7e5ffc0" args="()" -->
169static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#aab92b361335a644df654cf7cf7e5ffc0">clear_all</a> ()</td></tr>
170<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>
171<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
172<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cfe477965243a89eb87a06b024e2fcb"></a><!-- doxytag: member="bdm::RV::dsize" ref="a0cfe477965243a89eb87a06b024e2fcb" args="" -->
173int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a0cfe477965243a89eb87a06b024e2fcb">dsize</a></td></tr>
174<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of the data vector <br/></td></tr>
175<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab11bfdceb831ed30d33b852dd4a6b385"></a><!-- doxytag: member="bdm::RV::len" ref="ab11bfdceb831ed30d33b852dd4a6b385" args="" -->
176int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ab11bfdceb831ed30d33b852dd4a6b385">len</a></td></tr>
177<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">number of individual rvs <br/></td></tr>
178<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a9a4769ab5a322495bea0cd8091500b"></a><!-- doxytag: member="bdm::RV::ids" ref="a0a9a4769ab5a322495bea0cd8091500b" args="" -->
179ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a0a9a4769ab5a322495bea0cd8091500b">ids</a></td></tr>
180<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of unique IDs. <br/></td></tr>
181<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef6703854820bbf61736738f1bac6896"></a><!-- doxytag: member="bdm::RV::times" ref="aef6703854820bbf61736738f1bac6896" args="" -->
182ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#aef6703854820bbf61736738f1bac6896">times</a></td></tr>
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of shifts from current time. <br/></td></tr>
184<tr><td colspan="2"><h2>Access functions</h2></td></tr>
185<tr><td colspan="2"><p><a class="anchor" id="amgrp994eaf979fea144f0b347248094bff32"></a> </p>
186<br/><br/></td></tr>
[608]187<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab361a9044e6a43102c4f873b9f566a0f"></a><!-- doxytag: member="bdm::RV::to_string" ref="ab361a9044e6a43102c4f873b9f566a0f" args="()" -->
188string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ab361a9044e6a43102c4f873b9f566a0f">to_string</a> ()</td></tr>
189<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
[591]190<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade30156104f61d86c94f758861418089"></a><!-- doxytag: member="bdm::RV::_dsize" ref="ade30156104f61d86c94f758861418089" args="() const " -->
[608]191int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ade30156104f61d86c94f758861418089">_dsize</a> () const </td></tr>
192<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total size of a random variable <br/></td></tr>
[591]193<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26318eb90cb172ea86d1f45de9131c4e"></a><!-- doxytag: member="bdm::RV::_ids" ref="a26318eb90cb172ea86d1f45de9131c4e" args="() const " -->
194const ivec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a26318eb90cb172ea86d1f45de9131c4e">_ids</a> () const </td></tr>
195<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
196<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39f9b44752376f07e346579b5ff8cbbd"></a><!-- doxytag: member="bdm::RV::countsize" ref="a39f9b44752376f07e346579b5ff8cbbd" args="() const " -->
197int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a39f9b44752376f07e346579b5ff8cbbd">countsize</a> () const </td></tr>
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Recount size of the corresponding data vector. <br/></td></tr>
199<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a412d43294bac38fa1804829e38fa4eaf"></a><!-- doxytag: member="bdm::RV::cumsizes" ref="a412d43294bac38fa1804829e38fa4eaf" args="() const " -->
[608]200ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a412d43294bac38fa1804829e38fa4eaf">cumsizes</a> () const </td></tr>
201<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>
[591]202<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9ec8c3e756651ff352ab5e3d3acda4b"></a><!-- doxytag: member="bdm::RV::length" ref="ae9ec8c3e756651ff352ab5e3d3acda4b" args="() const " -->
[608]203int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ae9ec8c3e756651ff352ab5e3d3acda4b">length</a> () const </td></tr>
204<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of named parts. <br/></td></tr>
[591]205<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5900b42f778129a9e56008a1e8e489c8"></a><!-- doxytag: member="bdm::RV::id" ref="a5900b42f778129a9e56008a1e8e489c8" args="(int at) const " -->
[290]206int&nbsp;</td><td class="memItemRight" valign="bottom"><b>id</b> (int at) const </td></tr>
[591]207<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abde62551a3fc8f3f83c569860b73f705"></a><!-- doxytag: member="bdm::RV::size" ref="abde62551a3fc8f3f83c569860b73f705" args="(int at) const " -->
[290]208int&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> (int at) const </td></tr>
[591]209<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac94373d3a760919b4b3eee58b42e3a45"></a><!-- doxytag: member="bdm::RV::time" ref="ac94373d3a760919b4b3eee58b42e3a45" args="(int at) const " -->
[290]210int&nbsp;</td><td class="memItemRight" valign="bottom"><b>time</b> (int at) const </td></tr>
[591]211<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74c6ec8eb9c1dd69ad1d986eaee16dc2"></a><!-- doxytag: member="bdm::RV::name" ref="a74c6ec8eb9c1dd69ad1d986eaee16dc2" args="(int at) const " -->
[290]212std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>name</b> (int at) const </td></tr>
[614]213<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bae3443ded87dc9941d763e4c48cee0"></a><!-- doxytag: member="bdm::RV::scalarname" ref="a9bae3443ded87dc9941d763e4c48cee0" args="(int scalat) const " -->
214std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a9bae3443ded87dc9941d763e4c48cee0">scalarname</a> (int scalat) const </td></tr>
215<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>
[591]216<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb2892d12dc978549e9491aed327dfd4"></a><!-- doxytag: member="bdm::RV::set_time" ref="afb2892d12dc978549e9491aed327dfd4" args="(int at, int time0)" -->
[290]217void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_time</b> (int at, int time0)</td></tr>
[591]218<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acad6f15535d10437f6690cb4492176a8"></a><!-- doxytag: member="bdm::RV::operator&lt;&lt;" ref="acad6f15535d10437f6690cb4492176a8" args="(std::ostream &amp;os, const RV &amp;rv)" -->
219std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#acad6f15535d10437f6690cb4492176a8">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
220<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">State output, e.g. for debugging. <br/></td></tr>
[259]221</table>
[591]222<hr/><a name="_details"></a><h2>Detailed Description</h2>
223<p>Class representing variables, most often random variables. </p>
224<p>The 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>
225<p>The class is implemented using global variables to assure uniqueness of description:</p>
226<p>In is a vector </p>
227<div align="center">
[396]228<img src="inline_dotgraph_1.dot.png" alt="inline_dotgraph_1.dot" border="0" usemap="#inline_dotgraph_1.dot.map">
[591]229<map name="inline_dotgraph_1.dot.map" id="inline_dotgraph_1.dot.map"></map>
[290]230</div>
[591]231 <hr/><h2>Member Function Documentation</h2>
232<a class="anchor" id="a87841b5ee43997b79789c0c22047e224"></a><!-- doxytag: member="bdm::RV::add" ref="a87841b5ee43997b79789c0c22047e224" args="(const RV &amp;rv2)" -->
[259]233<div class="memitem">
234<div class="memproto">
235      <table class="memname">
236        <tr>
[591]237          <td class="memname">bool bdm::RV::add </td>
[259]238          <td>(</td>
239          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
[591]240          <td class="paramname"> <em>rv2</em></td>
[259]241          <td>&nbsp;)&nbsp;</td>
[290]242          <td></td>
[259]243        </tr>
244      </table>
245</div>
246<div class="memdoc">
247
[591]248<p>Add (concat) another variable to the current one,. </p>
249<dl class="return"><dt><b>Returns:</b></dt><dd>true if all rv2 were added, false if rv2 is in conflict </dd></dl>
[259]250
[608]251<p>References <a class="el" href="bdmbase_8cpp_source.html#l00058">countsize()</a>, <a class="el" href="bdmbase_8h_source.html#l00098">dsize</a>, <a class="el" href="bdmbase_8cpp_source.html#l00322">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>
[259]252
[614]253<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="datasources_8h_source.html#l00350">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>
[397]254
[259]255</div>
[591]256</div>
[608]257<a class="anchor" id="a1367055b2608ad9d50d01a2da6cec869"></a><!-- doxytag: member="bdm::RV::findself" ref="a1367055b2608ad9d50d01a2da6cec869" args="(const RV &amp;rv2) const " -->
[259]258<div class="memitem">
259<div class="memproto">
260      <table class="memname">
261        <tr>
[608]262          <td class="memname">ivec bdm::RV::findself </td>
[259]263          <td>(</td>
264          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
[608]265          <td class="paramname"> <em>rv2</em></td>
[259]266          <td>&nbsp;)&nbsp;</td>
267          <td> const</td>
268        </tr>
269      </table>
270</div>
271<div class="memdoc">
272
[608]273<p>Find indices of self in another rv,. </p>
274<dl class="return"><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl>
[259]275
[608]276<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>
[397]277
[608]278<p>Referenced by <a class="el" href="bdmbase_8cpp_source.html#l00098">add()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00280">dataind()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00313">subt()</a>.</p>
279
[259]280</div>
[591]281</div>
[608]282<a class="anchor" id="aa858d36d0264e1f1c89500531162fdf1"></a><!-- doxytag: member="bdm::RV::findself_ids" ref="aa858d36d0264e1f1c89500531162fdf1" args="(const RV &amp;rv2) const " -->
[259]283<div class="memitem">
284<div class="memproto">
285      <table class="memname">
286        <tr>
[608]287          <td class="memname">ivec bdm::RV::findself_ids </td>
[259]288          <td>(</td>
289          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
[591]290          <td class="paramname"> <em>rv2</em></td>
[290]291          <td>&nbsp;)&nbsp;</td>
292          <td> const</td>
[259]293        </tr>
294      </table>
295</div>
296<div class="memdoc">
297
[608]298<p>Find indices of self in another rv, ignore time,. </p>
[591]299<dl class="return"><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl>
[259]300
[608]301<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>
[290]302
[614]303<p>Referenced by <a class="el" href="bdmbase_8h_source.html#l00731">bdm::datalink_buffered::set_connection()</a>.</p>
[397]304
[259]305</div>
[591]306</div>
307<a class="anchor" id="a6564bdd36b6845a51446a192d33e1194"></a><!-- doxytag: member="bdm::RV::from_setting" ref="a6564bdd36b6845a51446a192d33e1194" args="(const Setting &amp;set)" -->
[368]308<div class="memitem">
309<div class="memproto">
310      <table class="memname">
311        <tr>
[591]312          <td class="memname">void bdm::RV::from_setting </td>
[368]313          <td>(</td>
314          <td class="paramtype">const Setting &amp;&nbsp;</td>
[591]315          <td class="paramname"> <em>set</em></td>
[368]316          <td>&nbsp;)&nbsp;</td>
317          <td><code> [virtual]</code></td>
318        </tr>
319      </table>
320</div>
321<div class="memdoc">
322
[591]323<p><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). </p>
[608]324<div class="fragment"><pre class="fragment">        rv = {
325            <span class="keyword">class </span>= &quot;<a class="code" href="classbdm_1_1RV.html#ae319ca900261a5005a9b4b353ec16412" title="Constructor of empty RV.">RV</a>&quot;; <span class="comment">// class name</span>
326          <span class="comment">// UNIQUE IDENTIFIER same names = same variable</span>
327          names = ( <span class="stringliteral">&quot;a&quot;</span>, <span class="stringliteral">&quot;b&quot;</span>, <span class="stringliteral">&quot;c&quot;</span>, ...);   <span class="comment">// which will be used e.g. in loggers</span>
[368]328
[608]329          <span class="comment">//optional arguments</span>
330          sizes = [1, 2, 3, ...];         <span class="comment">// (optional) default = ones()</span>
331          <a class="code" href="classbdm_1_1RV.html#aef6703854820bbf61736738f1bac6896" title="Vector of shifts from current time.">times</a> = [-1, -2, 0, ...];       <span class="comment">// time shifts with respect to current time (optional) default = zeros()</span>
332        }
[368]333</pre></div> 
[591]334<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
[368]335
[591]336<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>.</p>
[368]337
338</div>
[397]339</div>
[591]340<hr/>The documentation for this class was generated from the following files:<ul>
341<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a></li>
342<li>bdmbase.cpp</li>
343</ul>
344</div>
[614]345<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:41 2009 for mixpp by&nbsp;
[259]346<a href="http://www.doxygen.org/index.html">
[591]347<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[259]348</body>
349</html>
Note: See TracBrowser for help on using the browser.