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

Revision 651, 13.6 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::datalink_buffered 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_1datalink__buffered.html">datalink_buffered</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::datalink_buffered Class Reference</h1><!-- doxytag: class="bdm::datalink_buffered" --><!-- doxytag: inherits="bdm::datalink_part" -->Datalink that buffers delayed values - do not forget to call <a class="el" href="classbdm_1_1datalink__buffered.html#f137706c55891ba8a8aecc52ea96865f" title="push current data to history">step()</a>. 
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_1datalink__buffered-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"><a class="anchor" name="f137706c55891ba8a8aecc52ea96865f"></a><!-- doxytag: member="bdm::datalink_buffered::step" ref="f137706c55891ba8a8aecc52ea96865f" args="(const vec &amp;val_up)" -->
81void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#f137706c55891ba8a8aecc52ea96865f">step</a> (const vec &amp;val_up)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">push current data to history <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e665d66cb42862c1181645c438110a96"></a><!-- doxytag: member="bdm::datalink_buffered::pushdown" ref="e665d66cb42862c1181645c438110a96" args="(const vec &amp;val_up)" -->
85vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#e665d66cb42862c1181645c438110a96">pushdown</a> (const vec &amp;val_up)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for myself from val of "Up". <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="681745a319728a416486df38aacd579f"></a><!-- doxytag: member="bdm::datalink_buffered::filldown" ref="681745a319728a416486df38aacd579f" args="(const vec &amp;val_up, vec &amp;val_down)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#681745a319728a416486df38aacd579f">filldown</a> (const vec &amp;val_up, vec &amp;val_down)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for vector val_down from val of "Up". <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adefa427312905425ebab8531da1846a"></a><!-- doxytag: member="bdm::datalink_buffered::set_connection" ref="adefa427312905425ebab8531da1846a" args="(const RV &amp;rv, const RV &amp;rv_up)" -->
93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#adefa427312905425ebab8531da1846a">set_connection</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv_up)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection, rv must be fully present in rv_up <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c95435dc0781d14529cddde9b2894b6d"></a><!-- doxytag: member="bdm::datalink_buffered::set_history" ref="c95435dc0781d14529cddde9b2894b6d" args="(const RV &amp;rv1, const vec &amp;hist0)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#c95435dc0781d14529cddde9b2894b6d">set_history</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv1, const vec &amp;hist0)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set history of variable given by <code>rv1</code> to values of <code>hist</code>. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="724486a37002e7a3a73366c3af9b82ad"></a><!-- doxytag: member="bdm::datalink_buffered::set_connection" ref="724486a37002e7a3a73366c3af9b82ad" args="(int ds, int us, const ivec &amp;upind)" -->
101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#724486a37002e7a3a73366c3af9b82ad">set_connection</a> (int ds, int us, const ivec &amp;upind)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection using indices <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="736ec57cb8efce5f58b8f776a2d30d30"></a><!-- doxytag: member="bdm::datalink_buffered::pushup" ref="736ec57cb8efce5f58b8f776a2d30d30" args="(vec &amp;val_up, const vec &amp;val)" -->
105virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#736ec57cb8efce5f58b8f776a2d30d30">pushup</a> (vec &amp;val_up, const vec &amp;val)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill val of "Up" by my pieces. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="340c5a253544a1dc2fd87932a5341c32"></a><!-- doxytag: member="bdm::datalink_buffered::_upsize" ref="340c5a253544a1dc2fd87932a5341c32" args="()" -->
109int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#340c5a253544a1dc2fd87932a5341c32">_upsize</a> ()</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f0cce4477e906f3090bb803e06d8698"></a><!-- doxytag: member="bdm::datalink_buffered::_downsize" ref="8f0cce4477e906f3090bb803e06d8698" args="()" -->
113int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#8f0cce4477e906f3090bb803e06d8698">_downsize</a> ()</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br></td></tr>
116<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7cb8a47b88b95fde0255a041d076988"></a><!-- doxytag: member="bdm::datalink_buffered::history" ref="a7cb8a47b88b95fde0255a041d076988" args="" -->
118vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#a7cb8a47b88b95fde0255a041d076988">history</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">History, ordered as <img class="formulaInl" alt="$[Up_{t-1},Up_{t-2}, \ldots]$" src="form_17.png">. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="211c56b68be3864d535a8b75d735ebdc"></a><!-- doxytag: member="bdm::datalink_buffered::Hrv" ref="211c56b68be3864d535a8b75d735ebdc" args="" -->
122<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#211c56b68be3864d535a8b75d735ebdc">Hrv</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">rv of the history <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1ce2032fe5c86fa87d80baccb9aacd7"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_down" ref="a1ce2032fe5c86fa87d80baccb9aacd7" args="" -->
126ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#a1ce2032fe5c86fa87d80baccb9aacd7">h2v_down</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in down <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da58df16761169992059b8cd91d070c5"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_hist" ref="da58df16761169992059b8cd91d070c5" args="" -->
130ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#da58df16761169992059b8cd91d070c5">h2v_hist</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in history <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b09e10e42212497170ed5642bce7dbc"></a><!-- doxytag: member="bdm::datalink_buffered::v2h_up" ref="0b09e10e42212497170ed5642bce7dbc" args="" -->
134ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#0b09e10e42212497170ed5642bce7dbc">v2h_up</a></td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">v2h: indeces of up too be pushed to h <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64f64e7e6357419240bc2b1b0749c943"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_down" ref="64f64e7e6357419240bc2b1b0749c943" args="" -->
138ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__part.html#64f64e7e6357419240bc2b1b0749c943">v2v_down</a></td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of values in vector downsize <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc8ff50395fc1066a1e486dea18d987c"></a><!-- doxytag: member="bdm::datalink_buffered::downsize" ref="bc8ff50395fc1066a1e486dea18d987c" args="" -->
142int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#bc8ff50395fc1066a1e486dea18d987c">downsize</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val should be. <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f0d0af6848114d96108d3a6af25a045"></a><!-- doxytag: member="bdm::datalink_buffered::upsize" ref="0f0d0af6848114d96108d3a6af25a045" args="" -->
146int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#0f0d0af6848114d96108d3a6af25a045">upsize</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val of "Up" should be. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="240b37d793c6bdc32824ed0a0541b1eb"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_up" ref="240b37d793c6bdc32824ed0a0541b1eb" args="" -->
150ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#240b37d793c6bdc32824ed0a0541b1eb">v2v_up</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">val-to-val link, indices of the upper val <br></td></tr>
153</table>
154<hr><a name="_details"></a><h2>Detailed Description</h2>
155Datalink that buffers delayed values - do not forget to call <a class="el" href="classbdm_1_1datalink__buffered.html#f137706c55891ba8a8aecc52ea96865f" title="push current data to history">step()</a>.
156<p>
157Up is current data, Down is their subset with possibly delayed values <hr>The documentation for this class was generated from the following file:<ul>
158<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a></ul>
159</div>
160<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:45 2009 for mixpp by&nbsp;
161<a href="http://www.doxygen.org/index.html">
162<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
163</body>
164</html>
Note: See TracBrowser for help on using the browser.