Show
Ignore:
Timestamp:
09/12/09 11:41:43 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 copied

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1datalink__buffered.html

    r591 r608  
    33<head> 
    44<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
    5 <title>mixpp: bdm::datalink_m2e Class Reference</title> 
     5<title>mixpp: bdm::datalink_buffered Class Reference</title> 
    66<link href="tabs.css" rel="stylesheet" type="text/css"/> 
    77<link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    … …  
    6767    </ul> 
    6868  </div> 
    69   <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1datalink__m2e.html">datalink_m2e</a> 
     69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1datalink__buffered.html">datalink_buffered</a> 
    7070  </div> 
    7171</div> 
    7272<div class="contents"> 
    73 <h1>bdm::datalink_m2e Class Reference</h1><!-- doxytag: class="bdm::datalink_m2e" --><!-- doxytag: inherits="bdm::datalink" --> 
    74 <p>Data link with a condition.   
     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>.   
    7575<a href="#_details">More...</a></p> 
    7676 
    7777<p><code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code></p> 
    7878 
    79 <p><a href="classbdm_1_1datalink__m2e-members.html">List of all members.</a></p> 
     79<p><a href="classbdm_1_1datalink__buffered-members.html">List of all members.</a></p> 
    8080<table border="0" cellpadding="0" cellspacing="0"> 
    8181<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    82 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad951e9cf850c9bfe4e492e91a50af6"></a><!-- doxytag: member="bdm::datalink_m2e::datalink_m2e" ref="a5ad951e9cf850c9bfe4e492e91a50af6" args="()" --> 
    83 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#a5ad951e9cf850c9bfe4e492e91a50af6">datalink_m2e</a> ()</td></tr> 
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br/></td></tr> 
    85 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadd918bf877c48714cff51ee4ad989b0"></a><!-- doxytag: member="bdm::datalink_m2e::set_connection" ref="aadd918bf877c48714cff51ee4ad989b0" args="(const RV &amp;rv, const RV &amp;rvc, const RV &amp;rv_up)" --> 
    86 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#aadd918bf877c48714cff51ee4ad989b0">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;rvc, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv_up)</td></tr> 
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set connection between vectors. <br/></td></tr> 
    88 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ba850822e3cf9a4b079afc7e7c01703"></a><!-- doxytag: member="bdm::datalink_m2e::get_cond" ref="a7ba850822e3cf9a4b079afc7e7c01703" args="(const vec &amp;val_up)" --> 
    89 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#a7ba850822e3cf9a4b079afc7e7c01703">get_cond</a> (const vec &amp;val_up)</td></tr> 
    90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct condition. <br/></td></tr> 
    91 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab29bc3c7bf2a1d87e77ccaa793d097d5"></a><!-- doxytag: member="bdm::datalink_m2e::pushup_cond" ref="ab29bc3c7bf2a1d87e77ccaa793d097d5" args="(vec &amp;val_up, const vec &amp;val, const vec &amp;cond)" --> 
    92 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#ab29bc3c7bf2a1d87e77ccaa793d097d5">pushup_cond</a> (vec &amp;val_up, const vec &amp;val, const vec &amp;cond)</td></tr> 
    93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy corresponding values to Up.condition. <br/></td></tr> 
    94 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb8337aac8329eb0ca96bfb3ff73ec67"></a><!-- doxytag: member="bdm::datalink_m2e::set_connection" ref="afb8337aac8329eb0ca96bfb3ff73ec67" args="(const RV &amp;rv, const RV &amp;rv_up)" --> 
    95 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#afb8337aac8329eb0ca96bfb3ff73ec67">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> 
     82<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)" --> 
     83void&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> 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">push current data to history <br/></td></tr> 
     85<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)" --> 
     86vec&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> 
     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" 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)" --> 
     89void&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> 
     90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for vector val_down from val of "Up". <br/></td></tr> 
     91<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)" --> 
     92void&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> 
    9693<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection, rv must be fully present in rv_up <br/></td></tr> 
    97 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a724486a37002e7a3a73366c3af9b82ad"></a><!-- doxytag: member="bdm::datalink_m2e::set_connection" ref="a724486a37002e7a3a73366c3af9b82ad" args="(int ds, int us, const ivec &amp;upind)" --> 
     94<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)" --> 
    9895void&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> 
    9996<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set connection using indices <br/></td></tr> 
    100 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b5368c3899eed2f670d09142c2548e5"></a><!-- doxytag: member="bdm::datalink_m2e::pushdown" ref="a5b5368c3899eed2f670d09142c2548e5" args="(const vec &amp;val_up)" --> 
    101 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a5b5368c3899eed2f670d09142c2548e5">pushdown</a> (const vec &amp;val_up)</td></tr> 
    102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get val for myself from val of "Up". <br/></td></tr> 
    103 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a610e966f2edb1fcd6a5b28267c571793"></a><!-- doxytag: member="bdm::datalink_m2e::pushup" ref="a610e966f2edb1fcd6a5b28267c571793" args="(vec &amp;val_up, const vec &amp;val)" --> 
     97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a610e966f2edb1fcd6a5b28267c571793"></a><!-- doxytag: member="bdm::datalink_buffered::pushup" ref="a610e966f2edb1fcd6a5b28267c571793" args="(vec &amp;val_up, const vec &amp;val)" --> 
    10498void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a610e966f2edb1fcd6a5b28267c571793">pushup</a> (vec &amp;val_up, const vec &amp;val)</td></tr> 
    10599<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill val of "Up" by my pieces. <br/></td></tr> 
     100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a340c5a253544a1dc2fd87932a5341c32"></a><!-- doxytag: member="bdm::datalink_buffered::_upsize" ref="a340c5a253544a1dc2fd87932a5341c32" args="()" --> 
     101int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a340c5a253544a1dc2fd87932a5341c32">_upsize</a> ()</td></tr> 
     102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br/></td></tr> 
     103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f0cce4477e906f3090bb803e06d8698"></a><!-- doxytag: member="bdm::datalink_buffered::_downsize" ref="a8f0cce4477e906f3090bb803e06d8698" args="()" --> 
     104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a8f0cce4477e906f3090bb803e06d8698">_downsize</a> ()</td></tr> 
     105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access functions <br/></td></tr> 
    106106<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> 
    107 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fb26525e0bfa7932a37c5cd404801f9"></a><!-- doxytag: member="bdm::datalink_m2e::condsize" ref="a3fb26525e0bfa7932a37c5cd404801f9" args="" --> 
    108 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#a3fb26525e0bfa7932a37c5cd404801f9">condsize</a></td></tr> 
    109 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long cond should be. <br/></td></tr> 
    110 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43fe3e2d7aa04134053ec15793722783"></a><!-- doxytag: member="bdm::datalink_m2e::v2c_up" ref="a43fe3e2d7aa04134053ec15793722783" args="" --> 
    111 ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#a43fe3e2d7aa04134053ec15793722783">v2c_up</a></td></tr> 
    112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upper_val-to-local_cond link, indices of the upper val <br/></td></tr> 
    113 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e0048d87bda78e9b8d38761440c7abc"></a><!-- doxytag: member="bdm::datalink_m2e::v2c_lo" ref="a9e0048d87bda78e9b8d38761440c7abc" args="" --> 
    114 ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__m2e.html#a9e0048d87bda78e9b8d38761440c7abc">v2c_lo</a></td></tr> 
    115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upper_val-to-local_cond link, indices of the local cond <br/></td></tr> 
    116 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc8ff50395fc1066a1e486dea18d987c"></a><!-- doxytag: member="bdm::datalink_m2e::downsize" ref="abc8ff50395fc1066a1e486dea18d987c" args="" --> 
     107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7cb8a47b88b95fde0255a041d076988"></a><!-- doxytag: member="bdm::datalink_buffered::history" ref="aa7cb8a47b88b95fde0255a041d076988" args="" --> 
     108vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#aa7cb8a47b88b95fde0255a041d076988">history</a></td></tr> 
     109<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> 
     110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a211c56b68be3864d535a8b75d735ebdc"></a><!-- doxytag: member="bdm::datalink_buffered::Hrv" ref="a211c56b68be3864d535a8b75d735ebdc" args="" --> 
     111<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> 
     112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">rv of the history <br/></td></tr> 
     113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1ce2032fe5c86fa87d80baccb9aacd7"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_down" ref="aa1ce2032fe5c86fa87d80baccb9aacd7" args="" --> 
     114ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#aa1ce2032fe5c86fa87d80baccb9aacd7">h2v_down</a></td></tr> 
     115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in down <br/></td></tr> 
     116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada58df16761169992059b8cd91d070c5"></a><!-- doxytag: member="bdm::datalink_buffered::h2v_hist" ref="ada58df16761169992059b8cd91d070c5" args="" --> 
     117ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#ada58df16761169992059b8cd91d070c5">h2v_hist</a></td></tr> 
     118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">h2v : indeces in history <br/></td></tr> 
     119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b09e10e42212497170ed5642bce7dbc"></a><!-- doxytag: member="bdm::datalink_buffered::v2h_up" ref="a0b09e10e42212497170ed5642bce7dbc" args="" --> 
     120ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__buffered.html#a0b09e10e42212497170ed5642bce7dbc">v2h_up</a></td></tr> 
     121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">v2h: indeces of up too be pushed to h <br/></td></tr> 
     122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64f64e7e6357419240bc2b1b0749c943"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_down" ref="a64f64e7e6357419240bc2b1b0749c943" args="" --> 
     123ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink__part.html#a64f64e7e6357419240bc2b1b0749c943">v2v_down</a></td></tr> 
     124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of values in vector downsize <br/></td></tr> 
     125<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc8ff50395fc1066a1e486dea18d987c"></a><!-- doxytag: member="bdm::datalink_buffered::downsize" ref="abc8ff50395fc1066a1e486dea18d987c" args="" --> 
    117126int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#abc8ff50395fc1066a1e486dea18d987c">downsize</a></td></tr> 
    118127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val should be. <br/></td></tr> 
    119 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f0d0af6848114d96108d3a6af25a045"></a><!-- doxytag: member="bdm::datalink_m2e::upsize" ref="a0f0d0af6848114d96108d3a6af25a045" args="" --> 
     128<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f0d0af6848114d96108d3a6af25a045"></a><!-- doxytag: member="bdm::datalink_buffered::upsize" ref="a0f0d0af6848114d96108d3a6af25a045" args="" --> 
    120129int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a0f0d0af6848114d96108d3a6af25a045">upsize</a></td></tr> 
    121130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember how long val of "Up" should be. <br/></td></tr> 
    122 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a240b37d793c6bdc32824ed0a0541b1eb"></a><!-- doxytag: member="bdm::datalink_m2e::v2v_up" ref="a240b37d793c6bdc32824ed0a0541b1eb" args="" --> 
     131<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a240b37d793c6bdc32824ed0a0541b1eb"></a><!-- doxytag: member="bdm::datalink_buffered::v2v_up" ref="a240b37d793c6bdc32824ed0a0541b1eb" args="" --> 
    123132ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1datalink.html#a240b37d793c6bdc32824ed0a0541b1eb">v2v_up</a></td></tr> 
    124133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">val-to-val link, indices of the upper val <br/></td></tr> 
    125134</table> 
    126135<hr/><a name="_details"></a><h2>Detailed Description</h2> 
    127 <p>Data link with a condition. </p> 
    128 <hr/>The documentation for this class was generated from the following files:<ul> 
     136<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> 
     137<p>Up is current data, Down is their subset with possibly delayed values </p> 
     138<hr/>The documentation for this class was generated from the following file:<ul> 
    129139<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a></li> 
    130 <li>bdmbase.cpp</li> 
    131140</ul> 
    132141</div> 
    133 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp; 
     142<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp; 
    134143<a href="http://www.doxygen.org/index.html"> 
    135144<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>