root/doc/html/classbdm_1_1ArxDS.html @ 261

Revision 261, 10.8 kB (checked in by smidl, 16 years ago)

doc

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::ArxDS Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1ArxDS.html">ArxDS</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::ArxDS Class Reference</h1><!-- doxytag: class="bdm::ArxDS" --><!-- doxytag: inherits="bdm::DS" -->Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. 
32<a href="#_details">More...</a>
33<p>
34<code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::ArxDS:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1ArxDS__inherit__graph.png" border="0" usemap="#bdm_1_1ArxDS__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1ArxDS__inherit__map">
41<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43<div class="dynheader">
44Collaboration diagram for bdm::ArxDS:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1ArxDS__coll__graph.png" border="0" usemap="#bdm_1_1ArxDS__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1ArxDS__coll__map">
48<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="5,201,83,228"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="163,7,275,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="133,87,208,113"><area shape="rect" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="197,300,288,327"><area shape="rect" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="284,201,369,228"><area shape="rect" href="classbdm_1_1mlnorm.html" title="bdm::mlnorm\&lt; chmat \&gt;" alt="" coords="157,588,336,615"><area shape="rect" href="classbdm_1_1mEF.html" title="Exponential family model." alt="" coords="179,396,264,423"><area shape="rect" href="classbdm_1_1mlnorm.html" title="Normal distributed linear function with linear function of mean value;." alt="" coords="208,492,376,519"><area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="401,300,481,327"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; chmat \&gt;" alt="" coords="400,492,571,519"><area shape="rect" href="classbdm_1_1enorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix." alt="" coords="288,396,448,423"><area shape="rect" href="classchmat.html" title="Symmetric matrix stored in square root decomposition using upper cholesky." alt="" coords="523,396,584,423"><area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="523,300,584,327"><area shape="rect" href="classbdm_1_1datalink__e2e.html" title="DataLink is a connection between two data vectors Up and Down." alt="" coords="360,588,499,615"></map>
49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
50
51<p>
52<a href="classbdm_1_1ArxDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
53<tr><td></td></tr>
54<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db242e35812c311c8415bb7e31c3f595"></a><!-- doxytag: member="bdm::ArxDS::getdata" ref="db242e35812c311c8415bb7e31c3f595" args="(vec &amp;dt)" -->
56void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#db242e35812c311c8415bb7e31c3f595">getdata</a> (vec &amp;dt)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd61140869637b91bc23215ab7f45d3b"></a><!-- doxytag: member="bdm::ArxDS::getdata" ref="fd61140869637b91bc23215ab7f45d3b" args="(vec &amp;dt, const ivec &amp;indexes)" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#fd61140869637b91bc23215ab7f45d3b">getdata</a> (vec &amp;dt, const ivec &amp;indexes)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f6da8a00abba70bc58c7a4030bd8940"></a><!-- doxytag: member="bdm::ArxDS::write" ref="8f6da8a00abba70bc58c7a4030bd8940" args="(vec &amp;ut)" -->
64void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#8f6da8a00abba70bc58c7a4030bd8940">write</a> (vec &amp;ut)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7240ea989a6453e58468feea319dcf0b"></a><!-- doxytag: member="bdm::ArxDS::write" ref="7240ea989a6453e58468feea319dcf0b" args="(vec &amp;ut, const ivec &amp;indexes)" -->
68void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#7240ea989a6453e58468feea319dcf0b">write</a> (vec &amp;ut, const ivec &amp;indexes)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57dfa26b23cc03d53b123fa7e0474b19"></a><!-- doxytag: member="bdm::ArxDS::step" ref="57dfa26b23cc03d53b123fa7e0474b19" args="()" -->
72void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#57dfa26b23cc03d53b123fa7e0474b19">step</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$t$" src="form_38.png"> to <img class="formulaInl" alt="$t+1$" src="form_39.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6f17e13dc0c9187ed8dbb19f3c4330a"></a><!-- doxytag: member="bdm::ArxDS::ArxDS" ref="e6f17e13dc0c9187ed8dbb19f3c4330a" args="(RV &amp;drv, RV &amp;urv, RV &amp;rrv)" -->
76&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#e6f17e13dc0c9187ed8dbb19f3c4330a">ArxDS</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rrv)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d9abc62f1fee862f0e1c60c5c4a3c8a"></a><!-- doxytag: member="bdm::ArxDS::set_parameters" ref="2d9abc62f1fee862f0e1c60c5c4a3c8a" args="(const mat &amp;Th0, const vec mu0, const chmat &amp;sqR0)" -->
80void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#2d9abc62f1fee862f0e1c60c5c4a3c8a">set_parameters</a> (const mat &amp;Th0, const vec mu0, const <a class="el" href="classchmat.html">chmat</a> &amp;sqR0)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set parameters of the internal model. <br></td></tr>
83<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::ArxDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
85<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#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::ArxDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
89<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#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
92</table>
93<hr><a name="_details"></a><h2>Detailed Description</h2>
94Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <hr>The documentation for this class was generated from the following files:<ul>
95<li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul>
96</div>
97<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 15:29:53 2009 for mixpp by&nbsp;
98<a href="http://www.doxygen.org/index.html">
99<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
100</body>
101</html>
Note: See TracBrowser for help on using the browser.