root/library/doc/html/classbdm_1_1EpdfDS.html @ 608

Revision 608, 19.0 kB (checked in by smidl, 15 years ago)

doc

Line 
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"/>
5<title>mixpp: bdm::EpdfDS Class Reference</title>
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 -->
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>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
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>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
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>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1EpdfDS.html">EpdfDS</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::EpdfDS Class Reference</h1><!-- doxytag: class="bdm::EpdfDS" --><!-- doxytag: inherits="bdm::DS" -->
74<p>Simulate data from a static pdf Trivial example of a data source, could be used for tests of some estimation algorithms. For example, simulating data from a mixture model and feeding them to mixture model estimators. 
75<a href="#_details">More...</a></p>
76
77<p><code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code></p>
78
79<p><a href="classbdm_1_1EpdfDS-members.html">List of all members.</a></p>
80<table border="0" cellpadding="0" cellspacing="0">
81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1bd25d052dd50da9854d78e2f2096d0"></a><!-- doxytag: member="bdm::EpdfDS::step" ref="aa1bd25d052dd50da9854d78e2f2096d0" args="()" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#aa1bd25d052dd50da9854d78e2f2096d0">step</a> ()</td></tr>
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_18.png"/> to <img class="formulaInl" alt="$ t+1 $" src="form_19.png"/>, i.e. perfroms the actions and reads response of the system. <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62c4a9d343dd773c4e75b5f2338b9ba7"></a><!-- doxytag: member="bdm::EpdfDS::getdata" ref="a62c4a9d343dd773c4e75b5f2338b9ba7" args="(vec &amp;dt_out)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#a62c4a9d343dd773c4e75b5f2338b9ba7">getdata</a> (vec &amp;dt_out)</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b3d9370351ca393d4df6f6da6ac5f99"></a><!-- doxytag: member="bdm::EpdfDS::getdata" ref="a5b3d9370351ca393d4df6f6da6ac5f99" args="(vec &amp;dt_out, const ivec &amp;ids)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#a5b3d9370351ca393d4df6f6da6ac5f99">getdata</a> (vec &amp;dt_out, const ivec &amp;ids)</td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a741eaa5986311ce3535a2de2cfb389f8"></a><!-- doxytag: member="bdm::EpdfDS::_drv" ref="a741eaa5986311ce3535a2de2cfb389f8" args="()" -->
92const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_drv</b> ()</td></tr>
93<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#a3fdfb570b5d12332b2ba5662d17badac">from_setting</a> (const Setting &amp;set)</td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5baeee8528e5e4c5c7a344b2e3f192a"></a><!-- doxytag: member="bdm::EpdfDS::write" ref="af5baeee8528e5e4c5c7a344b2e3f192a" args="(vec &amp;ut)" -->
95virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a">write</a> (vec &amp;ut)</td></tr>
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::EpdfDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
98virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::EpdfDS::log_add" ref="a3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3c9e417d85052396fe74c164857ee67e">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br/></td></tr>
103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::EpdfDS::logit" ref="ae03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ae03d2c93cddd5c3a03107ddd3ae999cf">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br/></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::EpdfDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
107virtual const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a069497b610296be053d862a2493be0ce">_drv</a> () const </td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::EpdfDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
110const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aa6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
112<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::EpdfDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " -->
113const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ac09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr>
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
115<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::EpdfDS::set_drv" ref="a3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
116virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3a92d77fd97fdb6bf1c8edb1e38c6bbc">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;yrv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br/></td></tr>
118<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::EpdfDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
119virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
121<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::EpdfDS::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
122virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
124<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::EpdfDS::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
125virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
127<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
128<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83784c6ca9d311a38ff768cb0718c5b5"></a><!-- doxytag: member="bdm::EpdfDS::iepdf" ref="a83784c6ca9d311a38ff768cb0718c5b5" args="" -->
129<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1epdf.html">epdf</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#a83784c6ca9d311a38ff768cb0718c5b5">iepdf</a></td></tr>
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal pointer to <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> from which we samplecond <br/></td></tr>
131<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67637d64bcabf6ecb4a80284dc60dc3f"></a><!-- doxytag: member="bdm::EpdfDS::dt" ref="a67637d64bcabf6ecb4a80284dc60dc3f" args="" -->
132vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EpdfDS.html#a67637d64bcabf6ecb4a80284dc60dc3f">dt</a></td></tr>
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal storage of data sample <br/></td></tr>
134<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::EpdfDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
135int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code> <br/></td></tr>
137<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::EpdfDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
138int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br/></td></tr>
140<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::EpdfDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
141int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br/></td></tr>
143<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::EpdfDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
144<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#ad8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br/></td></tr>
146<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::EpdfDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" args="" -->
147<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>
148<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>
149<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::EpdfDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
150<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>
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
152<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::EpdfDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
153int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
155<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::EpdfDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
156int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
157</table>
158<hr/><a name="_details"></a><h2>Detailed Description</h2>
159<p>Simulate data from a static pdf Trivial example of a data source, could be used for tests of some estimation algorithms. For example, simulating data from a mixture model and feeding them to mixture model estimators. </p>
160<hr/><h2>Member Function Documentation</h2>
161<a class="anchor" id="a3fdfb570b5d12332b2ba5662d17badac"></a><!-- doxytag: member="bdm::EpdfDS::from_setting" ref="a3fdfb570b5d12332b2ba5662d17badac" args="(const Setting &amp;set)" -->
162<div class="memitem">
163<div class="memproto">
164      <table class="memname">
165        <tr>
166          <td class="memname">void bdm::EpdfDS::from_setting </td>
167          <td>(</td>
168          <td class="paramtype">const Setting &amp;&nbsp;</td>
169          <td class="paramname"> <em>set</em></td>
170          <td>&nbsp;)&nbsp;</td>
171          <td><code> [inline, virtual]</code></td>
172        </tr>
173      </table>
174</div>
175<div class="memdoc">
176<div class="fragment"><pre class="fragment">                <span class="keyword">class </span>= &quot;PdfDS&quot;;
177                epdf = {<span class="keyword">class</span>=<span class="stringliteral">&quot;epdf_offspring&quot;</span>, ...}<span class="comment">// list of points</span>
178</pre></div> 
179<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
180
181<p>References <a class="el" href="datasources_8h_source.html#l00068">dt</a>, and <a class="el" href="datasources_8h_source.html#l00066">iepdf</a>.</p>
182
183</div>
184</div>
185<hr/>The documentation for this class was generated from the following file:<ul>
186<li><a class="el" href="datasources_8h_source.html">datasources.h</a></li>
187</ul>
188</div>
189<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp;
190<a href="http://www.doxygen.org/index.html">
191<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
192</body>
193</html>
Note: See TracBrowser for help on using the browser.