| 1 | <?xml version='1.0' encoding='UTF-8' standalone='no'?> |
|---|
| 2 | <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6"> |
|---|
| 3 | <compounddef id="classDS" kind="class" prot="public"> |
|---|
| 4 | <compoundname>DS</compoundname> |
|---|
| 5 | <derivedcompoundref refid="classMemDS" prot="public" virt="non-virtual">MemDS</derivedcompoundref> |
|---|
| 6 | <includes refid="libBM_8h" local="no">libBM.h</includes> |
|---|
| 7 | <sectiondef kind="protected-attrib"> |
|---|
| 8 | <memberdef kind="variable" id="classDS_11012025a1a3a1fdd24aa48698a3d3454" prot="protected" static="no" mutable="no"> |
|---|
| 9 | <type><ref refid="classRV" kindref="compound">RV</ref></type> |
|---|
| 10 | <definition>RV DS::Drv</definition> |
|---|
| 11 | <argsstring></argsstring> |
|---|
| 12 | <name>Drv</name> |
|---|
| 13 | <briefdescription> |
|---|
| 14 | <para>Observed variables, returned by <computeroutput><ref refid="classDS_1db2dacc9e71a36eeb9c5c2ee402eeeb1" kindref="member">getdata()</ref></computeroutput>. </para> </briefdescription> |
|---|
| 15 | <detaileddescription> |
|---|
| 16 | </detaileddescription> |
|---|
| 17 | <inbodydescription> |
|---|
| 18 | </inbodydescription> |
|---|
| 19 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="233" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="233" bodyend="-1"/> |
|---|
| 20 | <referencedby refid="classMemDS_15f72b555e0e4a61de1440c457cf57007" compoundref="libDS_8cpp" startline="28" endline="34">MemDS::linkrvs</referencedby> |
|---|
| 21 | </memberdef> |
|---|
| 22 | <memberdef kind="variable" id="classDS_10a88ffaeb3c7c2cf30c69bc41a000629" prot="protected" static="no" mutable="no"> |
|---|
| 23 | <type><ref refid="classRV" kindref="compound">RV</ref></type> |
|---|
| 24 | <definition>RV DS::Urv</definition> |
|---|
| 25 | <argsstring></argsstring> |
|---|
| 26 | <name>Urv</name> |
|---|
| 27 | <briefdescription> |
|---|
| 28 | <para>Action variables, accepted by <computeroutput><ref refid="classDS_10dfb6788b70c0d48a1f5276ed6c93039" kindref="member">write()</ref></computeroutput>. </para> </briefdescription> |
|---|
| 29 | <detaileddescription> |
|---|
| 30 | </detaileddescription> |
|---|
| 31 | <inbodydescription> |
|---|
| 32 | </inbodydescription> |
|---|
| 33 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="235" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="235" bodyend="-1"/> |
|---|
| 34 | <referencedby refid="classMemDS_15f72b555e0e4a61de1440c457cf57007" compoundref="libDS_8cpp" startline="28" endline="34">MemDS::linkrvs</referencedby> |
|---|
| 35 | </memberdef> |
|---|
| 36 | </sectiondef> |
|---|
| 37 | <sectiondef kind="public-func"> |
|---|
| 38 | <memberdef kind="function" id="classDS_1db2dacc9e71a36eeb9c5c2ee402eeeb1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 39 | <type>void</type> |
|---|
| 40 | <definition>void DS::getdata</definition> |
|---|
| 41 | <argsstring>(vec &dt)</argsstring> |
|---|
| 42 | <name>getdata</name> |
|---|
| 43 | <reimplementedby refid="classMemDS_123522b9e7dd0bb0c365cc9cde4c05449">getdata</reimplementedby> |
|---|
| 44 | <param> |
|---|
| 45 | <type>vec &</type> |
|---|
| 46 | <declname>dt</declname> |
|---|
| 47 | </param> |
|---|
| 48 | <briefdescription> |
|---|
| 49 | <para>Returns full vector of observed data. </para> </briefdescription> |
|---|
| 50 | <detaileddescription> |
|---|
| 51 | </detaileddescription> |
|---|
| 52 | <inbodydescription> |
|---|
| 53 | </inbodydescription> |
|---|
| 54 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="238"/> |
|---|
| 55 | </memberdef> |
|---|
| 56 | <memberdef kind="function" id="classDS_14027575bc66ea358f9b03dd3be28fe1e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 57 | <type>void</type> |
|---|
| 58 | <definition>void DS::getdata</definition> |
|---|
| 59 | <argsstring>(vec &dt, ivec &indeces)</argsstring> |
|---|
| 60 | <name>getdata</name> |
|---|
| 61 | <reimplementedby refid="classMemDS_1900f1e1c9eb950f87e557c068628e60e">getdata</reimplementedby> |
|---|
| 62 | <param> |
|---|
| 63 | <type>vec &</type> |
|---|
| 64 | <declname>dt</declname> |
|---|
| 65 | </param> |
|---|
| 66 | <param> |
|---|
| 67 | <type>ivec &</type> |
|---|
| 68 | <declname>indeces</declname> |
|---|
| 69 | </param> |
|---|
| 70 | <briefdescription> |
|---|
| 71 | <para>Returns data records at indeces. </para> </briefdescription> |
|---|
| 72 | <detaileddescription> |
|---|
| 73 | </detaileddescription> |
|---|
| 74 | <inbodydescription> |
|---|
| 75 | </inbodydescription> |
|---|
| 76 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="240"/> |
|---|
| 77 | </memberdef> |
|---|
| 78 | <memberdef kind="function" id="classDS_10dfb6788b70c0d48a1f5276ed6c93039" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 79 | <type>void</type> |
|---|
| 80 | <definition>void DS::write</definition> |
|---|
| 81 | <argsstring>(vec &ut)</argsstring> |
|---|
| 82 | <name>write</name> |
|---|
| 83 | <reimplementedby refid="classMemDS_1b120ed178f7c848f1227c928d8a79be8">write</reimplementedby> |
|---|
| 84 | <param> |
|---|
| 85 | <type>vec &</type> |
|---|
| 86 | <declname>ut</declname> |
|---|
| 87 | </param> |
|---|
| 88 | <briefdescription> |
|---|
| 89 | <para>Accepts action variable and schedule it for application. </para> </briefdescription> |
|---|
| 90 | <detaileddescription> |
|---|
| 91 | </detaileddescription> |
|---|
| 92 | <inbodydescription> |
|---|
| 93 | </inbodydescription> |
|---|
| 94 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="242"/> |
|---|
| 95 | </memberdef> |
|---|
| 96 | <memberdef kind="function" id="classDS_1f4ae51a3bc1267a6a52fc229973afe85" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 97 | <type>void</type> |
|---|
| 98 | <definition>void DS::write</definition> |
|---|
| 99 | <argsstring>(vec &ut, ivec &indeces)</argsstring> |
|---|
| 100 | <name>write</name> |
|---|
| 101 | <reimplementedby refid="classMemDS_16279bf18d44343750747ecc12e050f09">write</reimplementedby> |
|---|
| 102 | <param> |
|---|
| 103 | <type>vec &</type> |
|---|
| 104 | <declname>ut</declname> |
|---|
| 105 | </param> |
|---|
| 106 | <param> |
|---|
| 107 | <type>ivec &</type> |
|---|
| 108 | <declname>indeces</declname> |
|---|
| 109 | </param> |
|---|
| 110 | <briefdescription> |
|---|
| 111 | <para>Accepts action variables at specific indeces. </para> </briefdescription> |
|---|
| 112 | <detaileddescription> |
|---|
| 113 | </detaileddescription> |
|---|
| 114 | <inbodydescription> |
|---|
| 115 | </inbodydescription> |
|---|
| 116 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="244"/> |
|---|
| 117 | </memberdef> |
|---|
| 118 | <memberdef kind="function" id="classDS_19a35ca9c9321dce2bf63bf668f785b75" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 119 | <type>void</type> |
|---|
| 120 | <definition>void DS::linkrvs</definition> |
|---|
| 121 | <argsstring>(RV &drv, RV &urv)</argsstring> |
|---|
| 122 | <name>linkrvs</name> |
|---|
| 123 | <reimplementedby refid="classMemDS_15f72b555e0e4a61de1440c457cf57007">linkrvs</reimplementedby> |
|---|
| 124 | <param> |
|---|
| 125 | <type><ref refid="classRV" kindref="compound">RV</ref> &</type> |
|---|
| 126 | <declname>drv</declname> |
|---|
| 127 | </param> |
|---|
| 128 | <param> |
|---|
| 129 | <type><ref refid="classRV" kindref="compound">RV</ref> &</type> |
|---|
| 130 | <declname>urv</declname> |
|---|
| 131 | </param> |
|---|
| 132 | <briefdescription> |
|---|
| 133 | <para>Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs. </para> </briefdescription> |
|---|
| 134 | <detaileddescription> |
|---|
| 135 | <para>(Inherited from m3k, may be deprecated soon). </para> </detaileddescription> |
|---|
| 136 | <inbodydescription> |
|---|
| 137 | </inbodydescription> |
|---|
| 138 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="250"/> |
|---|
| 139 | </memberdef> |
|---|
| 140 | <memberdef kind="function" id="classDS_1470ba89e8e7c3c4d830803221b4e9be6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
|---|
| 141 | <type>void</type> |
|---|
| 142 | <definition>void DS::step</definition> |
|---|
| 143 | <argsstring>()</argsstring> |
|---|
| 144 | <name>step</name> |
|---|
| 145 | <reimplementedby refid="classMemDS_121916feb3e5ff960855c09b06a0d279b">step</reimplementedby> |
|---|
| 146 | <briefdescription> |
|---|
| 147 | <para>Moves from <formula id="38">$t$</formula> to <formula id="39">$t+1$</formula>, i.e. perfroms the actions and reads response of the system. </para> </briefdescription> |
|---|
| 148 | <detaileddescription> |
|---|
| 149 | </detaileddescription> |
|---|
| 150 | <inbodydescription> |
|---|
| 151 | </inbodydescription> |
|---|
| 152 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="253"/> |
|---|
| 153 | </memberdef> |
|---|
| 154 | </sectiondef> |
|---|
| 155 | <briefdescription> |
|---|
| 156 | <para>Abstract class for discrete-time sources of data. </para> </briefdescription> |
|---|
| 157 | <detaileddescription> |
|---|
| 158 | <para>The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). </para> </detaileddescription> |
|---|
| 159 | <inheritancegraph> |
|---|
| 160 | <node id="825"> |
|---|
| 161 | <label>MemDS</label> |
|---|
| 162 | <link refid="classMemDS"/> |
|---|
| 163 | <childnode refid="824" relation="public-inheritance"> |
|---|
| 164 | </childnode> |
|---|
| 165 | </node> |
|---|
| 166 | <node id="824"> |
|---|
| 167 | <label>DS</label> |
|---|
| 168 | <link refid="classDS"/> |
|---|
| 169 | </node> |
|---|
| 170 | </inheritancegraph> |
|---|
| 171 | <collaborationgraph> |
|---|
| 172 | <node id="826"> |
|---|
| 173 | <label>DS</label> |
|---|
| 174 | <link refid="classDS"/> |
|---|
| 175 | <childnode refid="827" relation="usage"> |
|---|
| 176 | <edgelabel>Urv |
|---|
| 177 | Drv</edgelabel> |
|---|
| 178 | </childnode> |
|---|
| 179 | </node> |
|---|
| 180 | <node id="827"> |
|---|
| 181 | <label>RV</label> |
|---|
| 182 | <link refid="classRV"/> |
|---|
| 183 | </node> |
|---|
| 184 | </collaborationgraph> |
|---|
| 185 | <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="230" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="230" bodyend="255"/> |
|---|
| 186 | <listofallmembers> |
|---|
| 187 | <member refid="classDS_11012025a1a3a1fdd24aa48698a3d3454" prot="protected" virt="non-virtual"><scope>DS</scope><name>Drv</name></member> |
|---|
| 188 | <member refid="classDS_1db2dacc9e71a36eeb9c5c2ee402eeeb1" prot="public" virt="non-virtual"><scope>DS</scope><name>getdata</name></member> |
|---|
| 189 | <member refid="classDS_14027575bc66ea358f9b03dd3be28fe1e" prot="public" virt="non-virtual"><scope>DS</scope><name>getdata</name></member> |
|---|
| 190 | <member refid="classDS_19a35ca9c9321dce2bf63bf668f785b75" prot="public" virt="non-virtual"><scope>DS</scope><name>linkrvs</name></member> |
|---|
| 191 | <member refid="classDS_1470ba89e8e7c3c4d830803221b4e9be6" prot="public" virt="non-virtual"><scope>DS</scope><name>step</name></member> |
|---|
| 192 | <member refid="classDS_10a88ffaeb3c7c2cf30c69bc41a000629" prot="protected" virt="non-virtual"><scope>DS</scope><name>Urv</name></member> |
|---|
| 193 | <member refid="classDS_10dfb6788b70c0d48a1f5276ed6c93039" prot="public" virt="non-virtual"><scope>DS</scope><name>write</name></member> |
|---|
| 194 | <member refid="classDS_1f4ae51a3bc1267a6a52fc229973afe85" prot="public" virt="non-virtual"><scope>DS</scope><name>write</name></member> |
|---|
| 195 | </listofallmembers> |
|---|
| 196 | </compounddef> |
|---|
| 197 | </doxygen> |
|---|
