root/library/doc/html/classbdm_1_1Kalman.html @ 440

Revision 401, 33.6 kB (checked in by smidl, 15 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::Kalman&lt; sq_T &gt; Class Template Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1Kalman.html">Kalman</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::Kalman&lt; sq_T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::Kalman" --><!-- doxytag: inherits="bdm::BM" --><a class="el" href="classbdm_1_1Kalman.html" title="Kalman filter with covariance matrices in square root form.">Kalman</a> filter with covariance matrices in square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> form. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="kalman_8h-source.html">kalman.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1Kalman-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="025a0196cbcc2e6adb13311f9d3d52b4"></a><!-- doxytag: member="bdm::Kalman::Kalman" ref="025a0196cbcc2e6adb13311f9d3d52b4" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#025a0196cbcc2e6adb13311f9d3d52b4">Kalman</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b22c45cffa949d70b8e5ac92ed5ce25"></a><!-- doxytag: member="bdm::Kalman::Kalman" ref="8b22c45cffa949d70b8e5ac92ed5ce25" args="(const Kalman&lt; sq_T &gt; &amp;K0)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#8b22c45cffa949d70b8e5ac92ed5ce25">Kalman</a> (const <a class="el" href="classbdm_1_1Kalman.html">Kalman</a>&lt; sq_T &gt; &amp;K0)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c7fb87fb6b87d08deb6a5a7862da957"></a><!-- doxytag: member="bdm::Kalman::set_parameters" ref="3c7fb87fb6b87d08deb6a5a7862da957" args="(const mat &amp;A0, const mat &amp;B0, const mat &amp;C0, const mat &amp;D0, const sq_T &amp;Q0, const sq_T &amp;R0)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#3c7fb87fb6b87d08deb6a5a7862da957">set_parameters</a> (const mat &amp;A0, const mat &amp;B0, const mat &amp;C0, const mat &amp;D0, const sq_T &amp;Q0, const sq_T &amp;R0)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set parameters with check of relevance. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9264fc6b173ecb803d2684b883f32c68"></a><!-- doxytag: member="bdm::Kalman::set_est" ref="9264fc6b173ecb803d2684b883f32c68" args="(const vec &amp;mu0, const sq_T &amp;P0)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#9264fc6b173ecb803d2684b883f32c68">set_est</a> (const vec &amp;mu0, const sq_T &amp;P0)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set estimate values, used e.g. in initialization. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a39330c14eff8d13179e868a1d1aa8c"></a><!-- doxytag: member="bdm::Kalman::bayes" ref="4a39330c14eff8d13179e868a1d1aa8c" args="(const vec &amp;dt)" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bayes</a> (const vec &amp;dt)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Here dt = [yt;ut] of appropriate dimensions. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f75e487ff6c129d7012d702030f8c890"></a><!-- doxytag: member="bdm::Kalman::posterior" ref="f75e487ff6c129d7012d702030f8c890" args="() const " -->
102const <a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#f75e487ff6c129d7012d702030f8c890">posterior</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c34989b1e53c7d4ecdaea63a95ddbd77"></a><!-- doxytag: member="bdm::Kalman::_e" ref="c34989b1e53c7d4ecdaea63a95ddbd77" args="() const " -->
106const <a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; sq_T &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> () const </td></tr>
107
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c788ec6e6c6f5f5861ae8a56d8ede277"></a><!-- doxytag: member="bdm::Kalman::__K" ref="c788ec6e6c6f5f5861ae8a56d8ede277" args="()" -->
109mat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#c788ec6e6c6f5f5861ae8a56d8ede277">__K</a> ()</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a250d1dbe7bba861dba2a324520cfa48"></a><!-- doxytag: member="bdm::Kalman::_dP" ref="a250d1dbe7bba861dba2a324520cfa48" args="()" -->
113vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#a250d1dbe7bba861dba2a324520cfa48">_dP</a> ()</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::Kalman::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
117virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::Kalman::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
121virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::Kalman::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
125virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::Kalman::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
129virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
132<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classbdm_1_1BM.html">BM</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a> () const </td></tr>
134
135<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1dee3fddaf021e62d925289660a707dc"></a><!-- doxytag: member="bdm::Kalman::bayesB" ref="1dee3fddaf021e62d925289660a707dc" args="(const mat &amp;Dt)" -->
137virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#1dee3fddaf021e62d925289660a707dc">bayesB</a> (const mat &amp;Dt)</td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Batch Bayes rule (columns of Dt are observations). <br></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#50257e0c1e5b5c73153ea6e716ad8ae0">logpred</a> (const vec &amp;dt) const </td></tr>
141
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e8ebe61fb14990abe1254bd3dda5fae"></a><!-- doxytag: member="bdm::Kalman::logpred_m" ref="0e8ebe61fb14990abe1254bd3dda5fae" args="(const mat &amp;dt) const " -->
143vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#0e8ebe61fb14990abe1254bd3dda5fae">logpred_m</a> (const mat &amp;dt) const </td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of logpred. <br></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="688d7a2aced1e06aa1c468d73a9e5eba"></a><!-- doxytag: member="bdm::Kalman::epredictor" ref="688d7a2aced1e06aa1c468d73a9e5eba" args="() const " -->
147virtual <a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#688d7a2aced1e06aa1c468d73a9e5eba">epredictor</a> () const </td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a predictive density <img class="formulaInl" alt="$ f(d_{t+1} |d_{t}, \ldots d_{0}) $" src="form_14.png">. <br></td></tr>
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="598b25e3f3d96a5bc00a5faeb5b3c912"></a><!-- doxytag: member="bdm::Kalman::predictor" ref="598b25e3f3d96a5bc00a5faeb5b3c912" args="() const " -->
151virtual <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#598b25e3f3d96a5bc00a5faeb5b3c912">predictor</a> () const </td></tr>
152
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a conditional density 1-step ahead predictor. <br></td></tr>
154<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff2d8755ba0b3def927d31305c03b09c"></a><!-- doxytag: member="bdm::Kalman::_drv" ref="ff2d8755ba0b3def927d31305c03b09c" args="() const " -->
156const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_drv</b> () const </td></tr>
157
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f135ae6dce7e9f30c9f88229c7930b96"></a><!-- doxytag: member="bdm::Kalman::set_drv" ref="f135ae6dce7e9f30c9f88229c7930b96" args="(const RV &amp;rv)" -->
159void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_drv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
160
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b38d92f17620813ad872d86e01a26e5e"></a><!-- doxytag: member="bdm::Kalman::set_rv" ref="b38d92f17620813ad872d86e01a26e5e" args="(const RV &amp;rv)" -->
162void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
163
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5be65d37dedfe33a3671e7065f523a70"></a><!-- doxytag: member="bdm::Kalman::_ll" ref="5be65d37dedfe33a3671e7065f523a70" args="() const " -->
165double&nbsp;</td><td class="memItemRight" valign="bottom"><b>_ll</b> () const </td></tr>
166
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="236b3abbcc93594fc97cd86d82c1a83f"></a><!-- doxytag: member="bdm::Kalman::set_evalll" ref="236b3abbcc93594fc97cd86d82c1a83f" args="(bool evl0)" -->
168void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_evalll</b> (bool evl0)</td></tr>
169
170<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fe475a1e920b20b63bb342c0e1571f7"></a><!-- doxytag: member="bdm::Kalman::rvy" ref="3fe475a1e920b20b63bb342c0e1571f7" args="" -->
172<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#3fe475a1e920b20b63bb342c0e1571f7">rvy</a></td></tr>
173
174<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indetifier of output rv. <br></td></tr>
175<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="149e27424fd1a7cc1c998ea088618a94"></a><!-- doxytag: member="bdm::Kalman::rvu" ref="149e27424fd1a7cc1c998ea088618a94" args="" -->
176<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#149e27424fd1a7cc1c998ea088618a94">rvu</a></td></tr>
177
178<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indetifier of exogeneous rv. <br></td></tr>
179<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba7699cdb3b1382a54d3e28b9b7517fa"></a><!-- doxytag: member="bdm::Kalman::dimx" ref="ba7699cdb3b1382a54d3e28b9b7517fa" args="" -->
180int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#ba7699cdb3b1382a54d3e28b9b7517fa">dimx</a></td></tr>
181
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of rv.count() <br></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2c36ba01760bf207b985bf321b7817f"></a><!-- doxytag: member="bdm::Kalman::dimy" ref="d2c36ba01760bf207b985bf321b7817f" args="" -->
184int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#d2c36ba01760bf207b985bf321b7817f">dimy</a></td></tr>
185
186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of rvy.count() <br></td></tr>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5136ef617f6ac0e426bea222755d92b"></a><!-- doxytag: member="bdm::Kalman::dimu" ref="c5136ef617f6ac0e426bea222755d92b" args="" -->
188int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#c5136ef617f6ac0e426bea222755d92b">dimu</a></td></tr>
189
190<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of rvu.count() <br></td></tr>
191<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a2072e2090c10fac74ad30a023a4ace"></a><!-- doxytag: member="bdm::Kalman::A" ref="0a2072e2090c10fac74ad30a023a4ace" args="" -->
192mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#0a2072e2090c10fac74ad30a023a4ace">A</a></td></tr>
193
194<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix A. <br></td></tr>
195<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5977b2c81857948a35105f0e7840203c"></a><!-- doxytag: member="bdm::Kalman::B" ref="5977b2c81857948a35105f0e7840203c" args="" -->
196mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#5977b2c81857948a35105f0e7840203c">B</a></td></tr>
197
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix B. <br></td></tr>
199<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="818eba63a23972786a4579ad30294177"></a><!-- doxytag: member="bdm::Kalman::C" ref="818eba63a23972786a4579ad30294177" args="" -->
200mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#818eba63a23972786a4579ad30294177">C</a></td></tr>
201
202<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix C. <br></td></tr>
203<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b56ac423d0654b5755e4f852a870456"></a><!-- doxytag: member="bdm::Kalman::D" ref="7b56ac423d0654b5755e4f852a870456" args="" -->
204mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#7b56ac423d0654b5755e4f852a870456">D</a></td></tr>
205
206<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix D. <br></td></tr>
207<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70f8bf19e81b532c60fd3a7a152425ee"></a><!-- doxytag: member="bdm::Kalman::Q" ref="70f8bf19e81b532c60fd3a7a152425ee" args="" -->
208sq_T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#70f8bf19e81b532c60fd3a7a152425ee">Q</a></td></tr>
209
210<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix Q in square-root form. <br></td></tr>
211<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="475b088287cdfbba4dc60a3d027728b7"></a><!-- doxytag: member="bdm::Kalman::R" ref="475b088287cdfbba4dc60a3d027728b7" args="" -->
212sq_T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#475b088287cdfbba4dc60a3d027728b7">R</a></td></tr>
213
214<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix R in square-root form. <br></td></tr>
215<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="383f329ff18bbe219254c8b3b916f40d"></a><!-- doxytag: member="bdm::Kalman::est" ref="383f329ff18bbe219254c8b3b916f40d" args="" -->
216<a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; sq_T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#383f329ff18bbe219254c8b3b916f40d">est</a></td></tr>
217
218<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">posterior density on $x_t$ <br></td></tr>
219<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba555c394c429f6831c9bbabfa2c944c"></a><!-- doxytag: member="bdm::Kalman::fy" ref="ba555c394c429f6831c9bbabfa2c944c" args="" -->
220<a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; sq_T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#ba555c394c429f6831c9bbabfa2c944c">fy</a></td></tr>
221
222<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">preditive density on $y_t$ <br></td></tr>
223<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd69dfb802465f22dd84d73a180d5c92"></a><!-- doxytag: member="bdm::Kalman::_K" ref="bd69dfb802465f22dd84d73a180d5c92" args="" -->
224mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#bd69dfb802465f22dd84d73a180d5c92">_K</a></td></tr>
225
226<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">placeholder for <a class="el" href="classbdm_1_1Kalman.html" title="Kalman filter with covariance matrices in square root form.">Kalman</a> gain <br></td></tr>
227<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c249d45258c8578b13858ad3e7b729b1"></a><!-- doxytag: member="bdm::Kalman::_yp" ref="c249d45258c8578b13858ad3e7b729b1" args="" -->
228vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#c249d45258c8578b13858ad3e7b729b1">_yp</a></td></tr>
229
230<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of fy.mu <br></td></tr>
231<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2dd268f2d7fbe6382cb8825a1114192a"></a><!-- doxytag: member="bdm::Kalman::_Ry" ref="2dd268f2d7fbe6382cb8825a1114192a" args="" -->
232sq_T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#2dd268f2d7fbe6382cb8825a1114192a">_Ry</a></td></tr>
233
234<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of fy.R <br></td></tr>
235<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fa172078091e45561343fa513dd573b0"></a><!-- doxytag: member="bdm::Kalman::_mu" ref="fa172078091e45561343fa513dd573b0" args="" -->
236vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#fa172078091e45561343fa513dd573b0">_mu</a></td></tr>
237
238<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of est.mu <br></td></tr>
239<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00c27b0bf324f0018497921ca23c71ed"></a><!-- doxytag: member="bdm::Kalman::_P" ref="00c27b0bf324f0018497921ca23c71ed" args="" -->
240sq_T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Kalman.html#00c27b0bf324f0018497921ca23c71ed">_P</a></td></tr>
241
242<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of est.R <br></td></tr>
243<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c400357e37d27a4834b2b1d9211009ed"></a><!-- doxytag: member="bdm::Kalman::drv" ref="c400357e37d27a4834b2b1d9211009ed" args="" -->
244<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#c400357e37d27a4834b2b1d9211009ed">drv</a></td></tr>
245
246<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Random variable of the data (optional). <br></td></tr>
247<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4064b6559d962633e4372b12f4cd204a"></a><!-- doxytag: member="bdm::Kalman::ll" ref="4064b6559d962633e4372b12f4cd204a" args="" -->
248double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#4064b6559d962633e4372b12f4cd204a">ll</a></td></tr>
249
250<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of marginalized data likelihood. <br></td></tr>
251<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="faff0ad12556fe7dc0e2807d4fd938ee"></a><!-- doxytag: member="bdm::Kalman::evalll" ref="faff0ad12556fe7dc0e2807d4fd938ee" args="" -->
252bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#faff0ad12556fe7dc0e2807d4fd938ee">evalll</a></td></tr>
253
254<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If true, the filter will compute likelihood of the data record and store it in <code>ll</code> . Set to false if you want to save computational time. <br></td></tr>
255<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr>
256<tr><td colspan="2">This extension is useful e.g. in Marginalized Particle Filter (<a class="el" href="classbdm_1_1MPF.html">bdm::MPF</a>). Alternatively, it can be used for automated connection to <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> when the condition is observed <br><br></td></tr>
257<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::Kalman::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " -->
258const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#b5e8e016be16e4029c789063cb3f3b33">_rvc</a> () const </td></tr>
259
260<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
261<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6799f4b16a6a59ed58b1d0d6e17116f4"></a><!-- doxytag: member="bdm::Kalman::condition" ref="6799f4b16a6a59ed58b1d0d6e17116f4" args="(const vec &amp;val)" -->
262virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#6799f4b16a6a59ed58b1d0d6e17116f4">condition</a> (const vec &amp;val)</td></tr>
263
264<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr>
265<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::Kalman::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" -->
266<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#de95c590d650b2db423d53992f0906cb">rvc</a></td></tr>
267
268<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr>
269<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr>
270<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adb539fa2585c8a2a91c54e5aebf330e"></a><!-- doxytag: member="bdm::Kalman::set_options" ref="adb539fa2585c8a2a91c54e5aebf330e" args="(const string &amp;opt)" -->
271virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#adb539fa2585c8a2a91c54e5aebf330e">set_options</a> (const string &amp;opt)</td></tr>
272
273<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string recognized are: "logbounds,logll". <br></td></tr>
274<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2298ca6af9b13a78a4c9e18ab43f1827"></a><!-- doxytag: member="bdm::Kalman::log_add" ref="2298ca6af9b13a78a4c9e18ab43f1827" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" -->
275virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#2298ca6af9b13a78a4c9e18ab43f1827">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr>
276
277<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add all logged variables to a <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a>. <br></td></tr>
278<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b517e1679eaa94e803ea4cd0b8efbcd7"></a><!-- doxytag: member="bdm::Kalman::logit" ref="b517e1679eaa94e803ea4cd0b8efbcd7" args="(logger &amp;L)" -->
279virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
280
281<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::Kalman::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" -->
282ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr>
283
284<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers 4:[1=mean,2=lb,3=ub,4=ll]. <br></td></tr>
285<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="398b7e7a162cf37d0022d6126495f207"></a><!-- doxytag: member="bdm::Kalman::LFlags" ref="398b7e7a162cf37d0022d6126495f207" args="" -->
286ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#398b7e7a162cf37d0022d6126495f207">LFlags</a></td></tr>
287
288<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags for logging - same size as LIDs, each entry correspond to the same in LIDs. <br></td></tr>
289</table>
290<hr><a name="_details"></a><h2>Detailed Description</h2>
291<h3>template&lt;class sq_T&gt;<br>
292 class bdm::Kalman&lt; sq_T &gt;</h3>
293
294<a class="el" href="classbdm_1_1Kalman.html" title="Kalman filter with covariance matrices in square root form.">Kalman</a> filter with covariance matrices in square <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> form.
295<p>
296Parameter evolution model:<p class="formulaDsp">
297<img class="formulaDsp" alt="\[ x_t = A x_{t-1} + B u_t + Q^{1/2} e_t \]" src="form_29.png">
298<p>
299 Observation model: <p class="formulaDsp">
300<img class="formulaDsp" alt="\[ y_t = C x_{t-1} + C u_t + Q^{1/2} w_t. \]" src="form_30.png">
301<p>
302 Where $e_t$ and $w_t$ are independent vectors Normal(0,1)-distributed disturbances. <hr><h2>Member Function Documentation</h2>
303<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="bdm::Kalman::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " -->
304<div class="memitem">
305<div class="memproto">
306      <table class="memname">
307        <tr>
308          <td class="memname">virtual <a class="el" href="classbdm_1_1BM.html">BM</a>* bdm::BM::_copy_           </td>
309          <td>(</td>
310          <td class="paramname">          </td>
311          <td>&nbsp;)&nbsp;</td>
312          <td> const<code> [inline, virtual, inherited]</code></td>
313        </tr>
314      </table>
315</div>
316<div class="memdoc">
317
318<p>
319Copy function required in vectors, Arrays of <a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: <div class="fragment"><pre class="fragment"> BM* <a class="code" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> BM(*<span class="keyword">this</span>);}
320</pre></div> 
321<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#ca0b54c0997cfd567f49377af5def106">bdm::ARX</a>, <a class="el" href="classbdm_1_1KalmanCh.html#24ce65bdaa538d4d5153d709a929b996">bdm::KalmanCh</a>, <a class="el" href="classbdm_1_1EKF.html#fe9b2e227255ad32dc73df316b7318f4">bdm::EKF&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1EKFCh.html#1d1d91400e3f177de9fe7962ea17adc4">bdm::EKFCh</a>, and <a class="el" href="classbdm_1_1BMEF.html#62d2e4691bed41a1efa6b9c2e35e5c67">bdm::BMEF</a>.</p>
322
323</div>
324</div><p>
325<a class="anchor" name="50257e0c1e5b5c73153ea6e716ad8ae0"></a><!-- doxytag: member="bdm::Kalman::logpred" ref="50257e0c1e5b5c73153ea6e716ad8ae0" args="(const vec &amp;dt) const " -->
326<div class="memitem">
327<div class="memproto">
328      <table class="memname">
329        <tr>
330          <td class="memname">virtual double bdm::BM::logpred           </td>
331          <td>(</td>
332          <td class="paramtype">const vec &amp;&nbsp;</td>
333          <td class="paramname"> <em>dt</em>          </td>
334          <td>&nbsp;)&nbsp;</td>
335          <td> const<code> [inline, virtual, inherited]</code></td>
336        </tr>
337      </table>
338</div>
339<div class="memdoc">
340
341<p>
342Evaluates predictive log-likelihood of the given data record I.e. marginal likelihood of the data with the posterior integrated out.
343<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#080a7e531e3aa06694112863b15bc6a4">bdm::ARX</a>, <a class="el" href="classbdm_1_1MixEF.html#da724da464a75e07521941e430929efa">bdm::MixEF</a>, and <a class="el" href="classbdm_1_1multiBM.html#e157b607c1e3fa91d42aeea44458e2bf">bdm::multiBM</a>.</p>
344
345<p>Referenced by <a class="el" href="bdmbase_8h-source.html#l00768">bdm::BM::logpred_m()</a>.</p>
346
347</div>
348</div><p>
349<hr>The documentation for this class was generated from the following file:<ul>
350<li><a class="el" href="kalman_8h-source.html">kalman.h</a></ul>
351</div>
352<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by&nbsp;
353<a href="http://www.doxygen.org/index.html">
354<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
355</body>
356</html>
Note: See TracBrowser for help on using the browser.