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

Revision 632, 13.6 kB (checked in by smidl, 15 years ago)

doc + updated tutorial

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"/>
[608]5<title>mixpp: bdm::datalink_buffered 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>
[608]69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1datalink__buffered.html">datalink_buffered</a>
[259]70  </div>
71</div>
72<div class="contents">
[608]73<h1>bdm::datalink_buffered Class Reference</h1><!-- doxytag: class="bdm::datalink_buffered" --><!-- doxytag: inherits="bdm::datalink_part" -->
74<p>Datalink that buffers delayed values - do not forget to call <a class="el" href="classbdm_1_1datalink__buffered.html#af137706c55891ba8a8aecc52ea96865f" title="push current data to history">step()</a>. 
[591]75<a href="#_details">More...</a></p>
[616]76<hr/><a name="_details"></a><h2>Detailed Description</h2>
77<p>Datalink that buffers delayed values - do not forget to call <a class="el" href="classbdm_1_1datalink__buffered.html#af137706c55891ba8a8aecc52ea96865f" title="push current data to history">step()</a>. </p>
78<p>Up is current data, Down is their subset with possibly delayed values </p>
[259]79
[591]80<p><code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code></p>
[472]81
[608]82<p><a href="classbdm_1_1datalink__buffered-members.html">List of all members.</a></p>
[591]83<table border="0" cellpadding="0" cellspacing="0">
84<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
[608]85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af137706c55891ba8a8aecc52ea96865f"></a><!-- doxytag: member="bdm::datalink_buffered::step" ref="af137706c55891ba8a8aecc52ea96865f" args="(const vec &amp;val_up)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#af137706c55891ba8a8aecc52ea96865f">step</a> (const vec &amp;val_up)</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">push current data to history <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae665d66cb42862c1181645c438110a96"></a><!-- doxytag: member="bdm::datalink_buffered::pushdown" ref="ae665d66cb42862c1181645c438110a96" args="(const vec &amp;val_up)" -->
89vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#ae665d66cb42862c1181645c438110a96">pushdown</a> (const vec &amp;val_up)</td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for myself from val of "Up". <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681745a319728a416486df38aacd579f"></a><!-- doxytag: member="bdm::datalink_buffered::filldown" ref="a681745a319728a416486df38aacd579f" args="(const vec &amp;val_up, vec &amp;val_down)" -->
92void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#a681745a319728a416486df38aacd579f">filldown</a> (const vec &amp;val_up, vec &amp;val_down)</td></tr>
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for vector val_down from val of "Up". <br/></td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadefa427312905425ebab8531da1846a"></a><!-- doxytag: member="bdm::datalink_buffered::set_connection" ref="aadefa427312905425ebab8531da1846a" args="(const RV &amp;rv, const RV &amp;rv_up)" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#aadefa427312905425ebab8531da1846a">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>
[591]96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection, rv must be fully present in rv_up <br/></td></tr>
[614]97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac95435dc0781d14529cddde9b2894b6d"></a><!-- doxytag: member="bdm::datalink_buffered::set_history" ref="ac95435dc0781d14529cddde9b2894b6d" args="(const RV &amp;rv1, const vec &amp;hist0)" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#ac95435dc0781d14529cddde9b2894b6d">set_history</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv1, const vec &amp;hist0)</td></tr>
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>
[608]100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a724486a37002e7a3a73366c3af9b82ad"></a><!-- doxytag: member="bdm::datalink_buffered::set_connection" ref="a724486a37002e7a3a73366c3af9b82ad" args="(int ds, int us, const ivec &amp;upind)" -->
[632]101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a724486a37002e7a3a73366c3af9b82ad">set_connection</a> (int ds, int us, const ivec &amp;upind)</td></tr>
[591]102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection using indices <br/></td></tr>
[632]103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a736ec57cb8efce5f58b8f776a2d30d30"></a><!-- doxytag: member="bdm::datalink_buffered::pushup" ref="a736ec57cb8efce5f58b8f776a2d30d30" args="(vec &amp;val_up, const vec &amp;val)" -->
104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a736ec57cb8efce5f58b8f776a2d30d30">pushup</a> (vec &amp;val_up, const vec &amp;val)</td></tr>
[591]105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill val of "Up" by my pieces. <br/></td></tr>
[608]106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a340c5a253544a1dc2fd87932a5341c32"></a><!-- doxytag: member="bdm::datalink_buffered::_upsize" ref="a340c5a253544a1dc2fd87932a5341c32" args="()" -->
107int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a340c5a253544a1dc2fd87932a5341c32">_upsize</a> ()</td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br/></td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f0cce4477e906f3090bb803e06d8698"></a><!-- doxytag: member="bdm::datalink_buffered::_downsize" ref="a8f0cce4477e906f3090bb803e06d8698" args="()" -->
110int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a8f0cce4477e906f3090bb803e06d8698">_downsize</a> ()</td></tr>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br/></td></tr>
[591]112<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
[608]113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7cb8a47b88b95fde0255a041d076988"></a><!-- doxytag: member="bdm::datalink_buffered::history" ref="aa7cb8a47b88b95fde0255a041d076988" args="" -->
114vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#aa7cb8a47b88b95fde0255a041d076988">history</a></td></tr>
115<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>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a211c56b68be3864d535a8b75d735ebdc"></a><!-- doxytag: member="bdm::datalink_buffered::Hrv" ref="a211c56b68be3864d535a8b75d735ebdc" args="" -->
117<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#a211c56b68be3864d535a8b75d735ebdc">Hrv</a></td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">rv of the history <br/></td></tr>
119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1ce2032fe5c86fa87d80baccb9aacd7"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_down" ref="aa1ce2032fe5c86fa87d80baccb9aacd7" args="" -->
120ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#aa1ce2032fe5c86fa87d80baccb9aacd7">h2v_down</a></td></tr>
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in down <br/></td></tr>
122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada58df16761169992059b8cd91d070c5"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_hist" ref="ada58df16761169992059b8cd91d070c5" args="" -->
123ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#ada58df16761169992059b8cd91d070c5">h2v_hist</a></td></tr>
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in history <br/></td></tr>
125<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b09e10e42212497170ed5642bce7dbc"></a><!-- doxytag: member="bdm::datalink_buffered::v2h_up" ref="a0b09e10e42212497170ed5642bce7dbc" args="" -->
126ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#a0b09e10e42212497170ed5642bce7dbc">v2h_up</a></td></tr>
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">v2h: indeces of up too be pushed to h <br/></td></tr>
128<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64f64e7e6357419240bc2b1b0749c943"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_down" ref="a64f64e7e6357419240bc2b1b0749c943" args="" -->
129ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__part.html#a64f64e7e6357419240bc2b1b0749c943">v2v_down</a></td></tr>
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of values in vector downsize <br/></td></tr>
131<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc8ff50395fc1066a1e486dea18d987c"></a><!-- doxytag: member="bdm::datalink_buffered::downsize" ref="abc8ff50395fc1066a1e486dea18d987c" args="" -->
[591]132int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#abc8ff50395fc1066a1e486dea18d987c">downsize</a></td></tr>
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val should be. <br/></td></tr>
[608]134<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f0d0af6848114d96108d3a6af25a045"></a><!-- doxytag: member="bdm::datalink_buffered::upsize" ref="a0f0d0af6848114d96108d3a6af25a045" args="" -->
[591]135int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a0f0d0af6848114d96108d3a6af25a045">upsize</a></td></tr>
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val of "Up" should be. <br/></td></tr>
[608]137<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a240b37d793c6bdc32824ed0a0541b1eb"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_up" ref="a240b37d793c6bdc32824ed0a0541b1eb" args="" -->
[591]138ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a240b37d793c6bdc32824ed0a0541b1eb">v2v_up</a></td></tr>
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">val-to-val link, indices of the upper val <br/></td></tr>
[259]140</table>
[608]141<hr/>The documentation for this class was generated from the following file:<ul>
[591]142<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a></li>
143</ul>
[397]144</div>
[632]145<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Sep 18 00:12:04 2009 for mixpp by&nbsp;
[259]146<a href="http://www.doxygen.org/index.html">
[591]147<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[259]148</body>
149</html>
Note: See TracBrowser for help on using the browser.