Changeset 661 for library/doc/html/classbdm_1_1stateDS.html

Timestamp:

10/15/09 00:10:19 (15 years ago)

Author:

smidl

Message:

doc

Files:

• library/doc/html/classbdm_1_1stateDS.html (modified) (7 diffs)

library/doc/html/classbdm_1_1stateDS.html

@@ -72 +72 @@
 <div class="contents">
 <h1>bdm::stateDS Class Reference</h1><!-- doxytag: class="bdm::stateDS" --><!-- doxytag: inherits="bdm::DS" -->
+<p>State-space data source simulating two densities.  
+<a href="#_details">More...</a></p>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>State-space data source simulating two densities. </p>
+
+<p><code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code></p>
+
 <p><a href="classbdm_1_1stateDS-members.html">List of all members.</a></p>
 <table border="0" cellpadding="0" cellspacing="0">
@@ -82 +89 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace1eec3f47d8d1b8ad9747482a4ca598"></a><!-- doxytag: member="bdm::stateDS::stateDS" ref="ace1eec3f47d8d1b8ad9747482a4ca598" args="(const shared_ptr&lt; mpdf &gt; &amp;IM0, const shared_ptr&lt; mpdf &gt; &amp;OM0, int usize)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><b>stateDS</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &gt; &amp;IM0, const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &gt; &amp;OM0, int usize)</td></tr>
+&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1stateDS.html#ace1eec3f47d8d1b8ad9747482a4ca598">stateDS</a> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &gt; &amp;IM0, const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &gt; &amp;OM0, int usize)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">convenience constructor <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e98f3e362e35245d565c2508527ae14"></a><!-- doxytag: member="bdm::stateDS::step" ref="a1e98f3e362e35245d565c2508527ae14" args="()" -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1stateDS.html#a1e98f3e362e35245d565c2508527ae14">step</a> ()</td></tr>
@@ -96 +104 @@
 virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a76d11928675f276f805655ae2a05d773">max_length</a> ()</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns maximum number of provided data, by default it is set to maximum allowed length, shorter <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> should overload this method! See, <a class="el" href="classbdm_1_1MemDS.html#a339a488b93f2fc37c80d9a9573fbd421" title="Returns maximum number of provided data, by default it is set to maximum allowed...">MemDS.max_length()</a>. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5baeee8528e5e4c5c7a344b2e3f192a"></a><!-- doxytag: member="bdm::stateDS::write" ref="af5baeee8528e5e4c5c7a344b2e3f192a" args="(vec &amp;ut)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a">write</a> (vec &amp;<a class="el" href="classbdm_1_1stateDS.html#aabbdb3dcf67a06f5a9003828819bafbf">ut</a>)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19ed7794819b195e9d9adbd29da999bd"></a><!-- doxytag: member="bdm::stateDS::write" ref="a19ed7794819b195e9d9adbd29da999bd" args="(const vec &amp;ut)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a19ed7794819b195e9d9adbd29da999bd">write</a> (const vec &amp;<a class="el" href="classbdm_1_1stateDS.html#aabbdb3dcf67a06f5a9003828819bafbf">ut</a>)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::stateDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;<a class="el" href="classbdm_1_1stateDS.html#aabbdb3dcf67a06f5a9003828819bafbf">ut</a>, const ivec &amp;indeces)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5a8d2a5125cda38fd191c246129ece6"></a><!-- doxytag: member="bdm::stateDS::write" ref="aa5a8d2a5125cda38fd191c246129ece6" args="(const vec &amp;ut, const ivec &amp;indeces)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aa5a8d2a5125cda38fd191c246129ece6">write</a> (const vec &amp;<a class="el" href="classbdm_1_1stateDS.html#aabbdb3dcf67a06f5a9003828819bafbf">ut</a>, const ivec &amp;indeces)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::stateDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
@@ -150 +158 @@
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::stateDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" args="" -->
 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#a19ed7794819b195e9d9adbd29da999bd" title="Accepts action variable and schedule it for application.">write()</a></code>. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::stateDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
 <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aeb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::stateDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::stateDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13c89cfedbd132742534641ed69391d4"></a><!-- doxytag: member="bdm::stateDS::LIDs" ref="a13c89cfedbd132742534641ed69391d4" args="" -->
+ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a13c89cfedbd132742534641ed69391d4">LIDs</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L, [0=dt, 1=ut]. <br/></td></tr>
 </table>
 <hr/><h2>Member Function Documentation</h2>
@@ -176 +182 @@
 </div>
 <div class="memdoc">
-<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 <a class="el" href="classbdm_1_1stateDS.html">stateDS</a></p>
+<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 <a class="el" href="classbdm_1_1stateDS.html" title="State-space data source simulating two densities.">stateDS</a></p>
 <p>The <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> is constructed from a structure with fields: </p>
 <div class="fragment"><pre class="fragment">                system = {
@@ -204 +210 @@
 <p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
 
-<p>References <a class="el" href="datasources_8h_source.html#l00453">dt</a>, <a class="el" href="datasources_8h_source.html#l00457">ut</a>, and <a class="el" href="datasources_8h_source.html#l00455">xt</a>.</p>
+<p>References <a class="el" href="datasources_8h_source.html#l00315">dt</a>, <a class="el" href="datasources_8h_source.html#l00319">ut</a>, and <a class="el" href="datasources_8h_source.html#l00317">xt</a>.</p>
 
 </div>
@@ -213 +219 @@
 </ul>
 </div>
-<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Oct 12 19:37:21 2009 for mixpp by&nbsp;
+<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:49 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>