[261] | 1 | \hypertarget{classbdm_1_1KalmanCh}{ |
---|
| 2 | \section{bdm::KalmanCh Class Reference} |
---|
| 3 | \label{classbdm_1_1KalmanCh}\index{bdm::KalmanCh@{bdm::KalmanCh}} |
---|
| 4 | } |
---|
| 5 | {\tt \#include $<$libKF.h$>$} |
---|
| 6 | |
---|
[271] | 7 | Inheritance diagram for bdm::KalmanCh::\begin{figure}[H] |
---|
[261] | 8 | \begin{center} |
---|
| 9 | \leavevmode |
---|
[271] | 10 | \includegraphics[height=6cm]{classbdm_1_1KalmanCh} |
---|
[261] | 11 | \end{center} |
---|
| 12 | \end{figure} |
---|
[270] | 13 | |
---|
| 14 | |
---|
| 15 | \subsection{Detailed Description} |
---|
[271] | 16 | \hyperlink{classbdm_1_1Kalman}{Kalman} filter in square root form. |
---|
| 17 | |
---|
| 18 | Trivial example: |
---|
| 19 | |
---|
| 20 | \begin{DocInclude}\begin{verbatim}#include <estim/libKF.h> |
---|
| 21 | using namespace bdm; |
---|
| 22 | |
---|
| 23 | // estimation of AR(0) model |
---|
| 24 | int main() { |
---|
| 25 | //dimensions |
---|
| 26 | int dx=3, dy=3, du=1; |
---|
| 27 | // matrices |
---|
| 28 | mat A = eye(dx); |
---|
| 29 | mat B = zeros(dx,du); |
---|
| 30 | mat C = eye(dx); |
---|
| 31 | mat D = zeros(dy,du); |
---|
| 32 | mat Q = eye(dx); |
---|
| 33 | mat R = 0.1*eye(dy); |
---|
| 34 | //prior |
---|
| 35 | mat P0 = 100*eye(dx); |
---|
| 36 | vec mu0 = zeros(dx); |
---|
| 37 | // Estimator |
---|
| 38 | KalmanCh KF; |
---|
| 39 | KF.set_parameters(A,B,C,D,/*covariances*/ Q,R); |
---|
| 40 | KF.set_statistics(mu0,P0); |
---|
| 41 | // Estimation loop |
---|
| 42 | for (int i=0;i<100;i++){ |
---|
| 43 | KF.bayes(randn(dx+du)); |
---|
| 44 | } |
---|
| 45 | //print results |
---|
| 46 | cout << "Posterior estimate of x is: " << endl; |
---|
| 47 | cout << "mean: "<< KF.posterior().mean()<< endl; |
---|
| 48 | cout << "variance: "<< KF.posterior().variance()<< endl; |
---|
| 49 | } |
---|
| 50 | \end{verbatim} |
---|
| 51 | \end{DocInclude} |
---|
| 52 | \subsection*{Public Member Functions} |
---|
[261] | 53 | \begin{CompactItemize} |
---|
| 54 | \item |
---|
[270] | 55 | \hypertarget{classbdm_1_1KalmanCh_830486554e1a2c7652541dbc9dcd3fb3}{ |
---|
| 56 | \hyperlink{classbdm_1_1KalmanCh_830486554e1a2c7652541dbc9dcd3fb3}{KalmanCh} ()} |
---|
| 57 | \label{classbdm_1_1KalmanCh_830486554e1a2c7652541dbc9dcd3fb3} |
---|
[261] | 58 | |
---|
| 59 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
---|
[271] | 60 | \hypertarget{classbdm_1_1KalmanCh_20a4d4c664e8ac8a3f1bb7b0d11c6d87}{ |
---|
| 61 | void \hyperlink{classbdm_1_1KalmanCh_20a4d4c664e8ac8a3f1bb7b0d11c6d87}{set\_\-parameters} (const mat \&A0, const mat \&B0, const mat \&C0, const mat \&D0, const \hyperlink{classchmat}{chmat} \&Q0, const \hyperlink{classchmat}{chmat} \&R0)} |
---|
| 62 | \label{classbdm_1_1KalmanCh_20a4d4c664e8ac8a3f1bb7b0d11c6d87} |
---|
[261] | 63 | |
---|
| 64 | \begin{CompactList}\small\item\em Set parameters with check of relevance. \item\end{CompactList}\item |
---|
[271] | 65 | \hypertarget{classbdm_1_1KalmanCh_6e169272657ed101f3d128b49c59b890}{ |
---|
| 66 | void \textbf{set\_\-statistics} (const vec \&mu0, const \hyperlink{classchmat}{chmat} \&P0)} |
---|
| 67 | \label{classbdm_1_1KalmanCh_6e169272657ed101f3d128b49c59b890} |
---|
[261] | 68 | |
---|
[271] | 69 | \item |
---|
[261] | 70 | void \hyperlink{classbdm_1_1KalmanCh_b41fe5540548100b08e1684c3be767b6}{bayes} (const vec \&dt) |
---|
| 71 | \begin{CompactList}\small\item\em Here dt = \mbox{[}yt;ut\mbox{]} of appropriate dimensions. \item\end{CompactList}\item |
---|
[271] | 72 | \hypertarget{classbdm_1_1Kalman_9264fc6b173ecb803d2684b883f32c68}{ |
---|
| 73 | void \hyperlink{classbdm_1_1Kalman_9264fc6b173ecb803d2684b883f32c68}{set\_\-est} (const vec \&mu0, const \hyperlink{classchmat}{chmat} \&P0)} |
---|
| 74 | \label{classbdm_1_1Kalman_9264fc6b173ecb803d2684b883f32c68} |
---|
[261] | 75 | |
---|
[271] | 76 | \begin{CompactList}\small\item\em Set estimate values, used e.g. in initialization. \item\end{CompactList}\item |
---|
| 77 | \hypertarget{classbdm_1_1Kalman_f75e487ff6c129d7012d702030f8c890}{ |
---|
| 78 | const \hyperlink{classbdm_1_1epdf}{epdf} \& \hyperlink{classbdm_1_1Kalman_f75e487ff6c129d7012d702030f8c890}{posterior} () const } |
---|
| 79 | \label{classbdm_1_1Kalman_f75e487ff6c129d7012d702030f8c890} |
---|
| 80 | |
---|
[261] | 81 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\item |
---|
| 82 | \hypertarget{classbdm_1_1Kalman_c34989b1e53c7d4ecdaea63a95ddbd77}{ |
---|
[270] | 83 | const \hyperlink{classbdm_1_1enorm}{enorm}$<$ \hyperlink{classchmat}{chmat} $>$ $\ast$ \textbf{\_\-e} () const } |
---|
[261] | 84 | \label{classbdm_1_1Kalman_c34989b1e53c7d4ecdaea63a95ddbd77} |
---|
| 85 | |
---|
[270] | 86 | \item |
---|
[261] | 87 | \hypertarget{classbdm_1_1Kalman_c788ec6e6c6f5f5861ae8a56d8ede277}{ |
---|
| 88 | mat \& \hyperlink{classbdm_1_1Kalman_c788ec6e6c6f5f5861ae8a56d8ede277}{\_\-\_\-K} ()} |
---|
| 89 | \label{classbdm_1_1Kalman_c788ec6e6c6f5f5861ae8a56d8ede277} |
---|
| 90 | |
---|
| 91 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\item |
---|
| 92 | \hypertarget{classbdm_1_1Kalman_a250d1dbe7bba861dba2a324520cfa48}{ |
---|
| 93 | vec \hyperlink{classbdm_1_1Kalman_a250d1dbe7bba861dba2a324520cfa48}{\_\-dP} ()} |
---|
| 94 | \label{classbdm_1_1Kalman_a250d1dbe7bba861dba2a324520cfa48} |
---|
| 95 | |
---|
[270] | 96 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize} |
---|
| 97 | \begin{Indent}{\bf Constructors}\par |
---|
| 98 | \begin{CompactItemize} |
---|
| 99 | \item |
---|
| 100 | virtual \hyperlink{classbdm_1_1BM}{BM} $\ast$ \hyperlink{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff}{\_\-copy\_\-} () |
---|
| 101 | \end{CompactItemize} |
---|
| 102 | \end{Indent} |
---|
| 103 | \begin{Indent}{\bf Mathematical operations}\par |
---|
| 104 | \begin{CompactItemize} |
---|
| 105 | \item |
---|
[261] | 106 | \hypertarget{classbdm_1_1BM_1dee3fddaf021e62d925289660a707dc}{ |
---|
| 107 | virtual void \hyperlink{classbdm_1_1BM_1dee3fddaf021e62d925289660a707dc}{bayesB} (const mat \&Dt)} |
---|
| 108 | \label{classbdm_1_1BM_1dee3fddaf021e62d925289660a707dc} |
---|
| 109 | |
---|
| 110 | \begin{CompactList}\small\item\em Batch Bayes rule (columns of Dt are observations). \item\end{CompactList}\item |
---|
| 111 | virtual double \hyperlink{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0}{logpred} (const vec \&dt) const |
---|
| 112 | \item |
---|
| 113 | \hypertarget{classbdm_1_1BM_0e8ebe61fb14990abe1254bd3dda5fae}{ |
---|
| 114 | vec \hyperlink{classbdm_1_1BM_0e8ebe61fb14990abe1254bd3dda5fae}{logpred\_\-m} (const mat \&dt) const } |
---|
| 115 | \label{classbdm_1_1BM_0e8ebe61fb14990abe1254bd3dda5fae} |
---|
| 116 | |
---|
| 117 | \begin{CompactList}\small\item\em Matrix version of logpred. \item\end{CompactList}\item |
---|
[270] | 118 | \hypertarget{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba}{ |
---|
| 119 | virtual \hyperlink{classbdm_1_1epdf}{epdf} $\ast$ \hyperlink{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba}{epredictor} () const } |
---|
| 120 | \label{classbdm_1_1BM_688d7a2aced1e06aa1c468d73a9e5eba} |
---|
[261] | 121 | |
---|
[270] | 122 | \begin{CompactList}\small\item\em Constructs a predictive density $ f(d_{t+1} |d_{t}, \ldots d_{0}) $. \item\end{CompactList}\item |
---|
| 123 | \hypertarget{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912}{ |
---|
| 124 | virtual \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ \hyperlink{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912}{predictor} () const } |
---|
| 125 | \label{classbdm_1_1BM_598b25e3f3d96a5bc00a5faeb5b3c912} |
---|
[261] | 126 | |
---|
[270] | 127 | \begin{CompactList}\small\item\em Constructs a conditional density 1-step ahead predictor. \item\end{CompactList}\end{CompactItemize} |
---|
| 128 | \end{Indent} |
---|
| 129 | \begin{Indent}{\bf Access to attributes}\par |
---|
| 130 | \begin{CompactItemize} |
---|
| 131 | \item |
---|
[269] | 132 | \hypertarget{classbdm_1_1BM_ff2d8755ba0b3def927d31305c03b09c}{ |
---|
[270] | 133 | const \hyperlink{classbdm_1_1RV}{RV} \& \textbf{\_\-drv} () const } |
---|
[269] | 134 | \label{classbdm_1_1BM_ff2d8755ba0b3def927d31305c03b09c} |
---|
| 135 | |
---|
[270] | 136 | \item |
---|
[269] | 137 | \hypertarget{classbdm_1_1BM_f135ae6dce7e9f30c9f88229c7930b96}{ |
---|
[270] | 138 | void \textbf{set\_\-drv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv)} |
---|
[269] | 139 | \label{classbdm_1_1BM_f135ae6dce7e9f30c9f88229c7930b96} |
---|
| 140 | |
---|
[270] | 141 | \item |
---|
[271] | 142 | \hypertarget{classbdm_1_1BM_b38d92f17620813ad872d86e01a26e5e}{ |
---|
| 143 | void \textbf{set\_\-rv} (const \hyperlink{classbdm_1_1RV}{RV} \&rv)} |
---|
| 144 | \label{classbdm_1_1BM_b38d92f17620813ad872d86e01a26e5e} |
---|
| 145 | |
---|
| 146 | \item |
---|
[261] | 147 | \hypertarget{classbdm_1_1BM_5be65d37dedfe33a3671e7065f523a70}{ |
---|
[270] | 148 | double \textbf{\_\-ll} () const } |
---|
[261] | 149 | \label{classbdm_1_1BM_5be65d37dedfe33a3671e7065f523a70} |
---|
| 150 | |
---|
[270] | 151 | \item |
---|
[261] | 152 | \hypertarget{classbdm_1_1BM_236b3abbcc93594fc97cd86d82c1a83f}{ |
---|
[270] | 153 | void \textbf{set\_\-evalll} (bool evl0)} |
---|
[261] | 154 | \label{classbdm_1_1BM_236b3abbcc93594fc97cd86d82c1a83f} |
---|
| 155 | |
---|
| 156 | \end{CompactItemize} |
---|
[270] | 157 | \end{Indent} |
---|
[261] | 158 | \subsection*{Protected Attributes} |
---|
| 159 | \begin{CompactItemize} |
---|
| 160 | \item |
---|
| 161 | \hypertarget{classbdm_1_1KalmanCh_48611c8582706cfa62e832be0972e75d}{ |
---|
| 162 | mat \hyperlink{classbdm_1_1KalmanCh_48611c8582706cfa62e832be0972e75d}{preA}} |
---|
| 163 | \label{classbdm_1_1KalmanCh_48611c8582706cfa62e832be0972e75d} |
---|
| 164 | |
---|
| 165 | \begin{CompactList}\small\item\em pre array (triangular matrix) \item\end{CompactList}\item |
---|
| 166 | \hypertarget{classbdm_1_1KalmanCh_bcbd68f51d4b57246e7784ca5900171f}{ |
---|
| 167 | mat \hyperlink{classbdm_1_1KalmanCh_bcbd68f51d4b57246e7784ca5900171f}{postA}} |
---|
| 168 | \label{classbdm_1_1KalmanCh_bcbd68f51d4b57246e7784ca5900171f} |
---|
| 169 | |
---|
| 170 | \begin{CompactList}\small\item\em post array (triangular matrix) \item\end{CompactList}\item |
---|
| 171 | \hypertarget{classbdm_1_1Kalman_3fe475a1e920b20b63bb342c0e1571f7}{ |
---|
| 172 | \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1Kalman_3fe475a1e920b20b63bb342c0e1571f7}{rvy}} |
---|
| 173 | \label{classbdm_1_1Kalman_3fe475a1e920b20b63bb342c0e1571f7} |
---|
| 174 | |
---|
| 175 | \begin{CompactList}\small\item\em Indetifier of output rv. \item\end{CompactList}\item |
---|
| 176 | \hypertarget{classbdm_1_1Kalman_149e27424fd1a7cc1c998ea088618a94}{ |
---|
| 177 | \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1Kalman_149e27424fd1a7cc1c998ea088618a94}{rvu}} |
---|
| 178 | \label{classbdm_1_1Kalman_149e27424fd1a7cc1c998ea088618a94} |
---|
| 179 | |
---|
| 180 | \begin{CompactList}\small\item\em Indetifier of exogeneous rv. \item\end{CompactList}\item |
---|
| 181 | \hypertarget{classbdm_1_1Kalman_ba7699cdb3b1382a54d3e28b9b7517fa}{ |
---|
| 182 | int \hyperlink{classbdm_1_1Kalman_ba7699cdb3b1382a54d3e28b9b7517fa}{dimx}} |
---|
| 183 | \label{classbdm_1_1Kalman_ba7699cdb3b1382a54d3e28b9b7517fa} |
---|
| 184 | |
---|
| 185 | \begin{CompactList}\small\item\em cache of rv.count() \item\end{CompactList}\item |
---|
| 186 | \hypertarget{classbdm_1_1Kalman_d2c36ba01760bf207b985bf321b7817f}{ |
---|
| 187 | int \hyperlink{classbdm_1_1Kalman_d2c36ba01760bf207b985bf321b7817f}{dimy}} |
---|
| 188 | \label{classbdm_1_1Kalman_d2c36ba01760bf207b985bf321b7817f} |
---|
| 189 | |
---|
| 190 | \begin{CompactList}\small\item\em cache of rvy.count() \item\end{CompactList}\item |
---|
| 191 | \hypertarget{classbdm_1_1Kalman_c5136ef617f6ac0e426bea222755d92b}{ |
---|
| 192 | int \hyperlink{classbdm_1_1Kalman_c5136ef617f6ac0e426bea222755d92b}{dimu}} |
---|
| 193 | \label{classbdm_1_1Kalman_c5136ef617f6ac0e426bea222755d92b} |
---|
| 194 | |
---|
| 195 | \begin{CompactList}\small\item\em cache of rvu.count() \item\end{CompactList}\item |
---|
| 196 | \hypertarget{classbdm_1_1Kalman_0a2072e2090c10fac74ad30a023a4ace}{ |
---|
| 197 | mat \hyperlink{classbdm_1_1Kalman_0a2072e2090c10fac74ad30a023a4ace}{A}} |
---|
| 198 | \label{classbdm_1_1Kalman_0a2072e2090c10fac74ad30a023a4ace} |
---|
| 199 | |
---|
| 200 | \begin{CompactList}\small\item\em Matrix A. \item\end{CompactList}\item |
---|
| 201 | \hypertarget{classbdm_1_1Kalman_5977b2c81857948a35105f0e7840203c}{ |
---|
| 202 | mat \hyperlink{classbdm_1_1Kalman_5977b2c81857948a35105f0e7840203c}{B}} |
---|
| 203 | \label{classbdm_1_1Kalman_5977b2c81857948a35105f0e7840203c} |
---|
| 204 | |
---|
| 205 | \begin{CompactList}\small\item\em Matrix B. \item\end{CompactList}\item |
---|
| 206 | \hypertarget{classbdm_1_1Kalman_818eba63a23972786a4579ad30294177}{ |
---|
| 207 | mat \hyperlink{classbdm_1_1Kalman_818eba63a23972786a4579ad30294177}{C}} |
---|
| 208 | \label{classbdm_1_1Kalman_818eba63a23972786a4579ad30294177} |
---|
| 209 | |
---|
| 210 | \begin{CompactList}\small\item\em Matrix C. \item\end{CompactList}\item |
---|
| 211 | \hypertarget{classbdm_1_1Kalman_7b56ac423d0654b5755e4f852a870456}{ |
---|
| 212 | mat \hyperlink{classbdm_1_1Kalman_7b56ac423d0654b5755e4f852a870456}{D}} |
---|
| 213 | \label{classbdm_1_1Kalman_7b56ac423d0654b5755e4f852a870456} |
---|
| 214 | |
---|
| 215 | \begin{CompactList}\small\item\em Matrix D. \item\end{CompactList}\item |
---|
| 216 | \hypertarget{classbdm_1_1Kalman_70f8bf19e81b532c60fd3a7a152425ee}{ |
---|
| 217 | \hyperlink{classchmat}{chmat} \hyperlink{classbdm_1_1Kalman_70f8bf19e81b532c60fd3a7a152425ee}{Q}} |
---|
| 218 | \label{classbdm_1_1Kalman_70f8bf19e81b532c60fd3a7a152425ee} |
---|
| 219 | |
---|
| 220 | \begin{CompactList}\small\item\em Matrix Q in square-root form. \item\end{CompactList}\item |
---|
| 221 | \hypertarget{classbdm_1_1Kalman_475b088287cdfbba4dc60a3d027728b7}{ |
---|
| 222 | \hyperlink{classchmat}{chmat} \hyperlink{classbdm_1_1Kalman_475b088287cdfbba4dc60a3d027728b7}{R}} |
---|
| 223 | \label{classbdm_1_1Kalman_475b088287cdfbba4dc60a3d027728b7} |
---|
| 224 | |
---|
| 225 | \begin{CompactList}\small\item\em Matrix R in square-root form. \item\end{CompactList}\item |
---|
| 226 | \hypertarget{classbdm_1_1Kalman_383f329ff18bbe219254c8b3b916f40d}{ |
---|
| 227 | \hyperlink{classbdm_1_1enorm}{enorm}$<$ \hyperlink{classchmat}{chmat} $>$ \hyperlink{classbdm_1_1Kalman_383f329ff18bbe219254c8b3b916f40d}{est}} |
---|
| 228 | \label{classbdm_1_1Kalman_383f329ff18bbe219254c8b3b916f40d} |
---|
| 229 | |
---|
| 230 | \begin{CompactList}\small\item\em posterior density on \$x\_\-t\$ \item\end{CompactList}\item |
---|
| 231 | \hypertarget{classbdm_1_1Kalman_ba555c394c429f6831c9bbabfa2c944c}{ |
---|
| 232 | \hyperlink{classbdm_1_1enorm}{enorm}$<$ \hyperlink{classchmat}{chmat} $>$ \hyperlink{classbdm_1_1Kalman_ba555c394c429f6831c9bbabfa2c944c}{fy}} |
---|
| 233 | \label{classbdm_1_1Kalman_ba555c394c429f6831c9bbabfa2c944c} |
---|
| 234 | |
---|
| 235 | \begin{CompactList}\small\item\em preditive density on \$y\_\-t\$ \item\end{CompactList}\item |
---|
| 236 | \hypertarget{classbdm_1_1Kalman_bd69dfb802465f22dd84d73a180d5c92}{ |
---|
| 237 | mat \hyperlink{classbdm_1_1Kalman_bd69dfb802465f22dd84d73a180d5c92}{\_\-K}} |
---|
| 238 | \label{classbdm_1_1Kalman_bd69dfb802465f22dd84d73a180d5c92} |
---|
| 239 | |
---|
| 240 | \begin{CompactList}\small\item\em placeholder for Kalman gain \item\end{CompactList}\item |
---|
| 241 | \hypertarget{classbdm_1_1Kalman_c249d45258c8578b13858ad3e7b729b1}{ |
---|
| 242 | vec \& \hyperlink{classbdm_1_1Kalman_c249d45258c8578b13858ad3e7b729b1}{\_\-yp}} |
---|
| 243 | \label{classbdm_1_1Kalman_c249d45258c8578b13858ad3e7b729b1} |
---|
| 244 | |
---|
| 245 | \begin{CompactList}\small\item\em cache of fy.mu \item\end{CompactList}\item |
---|
| 246 | \hypertarget{classbdm_1_1Kalman_2dd268f2d7fbe6382cb8825a1114192a}{ |
---|
| 247 | \hyperlink{classchmat}{chmat} \& \hyperlink{classbdm_1_1Kalman_2dd268f2d7fbe6382cb8825a1114192a}{\_\-Ry}} |
---|
| 248 | \label{classbdm_1_1Kalman_2dd268f2d7fbe6382cb8825a1114192a} |
---|
| 249 | |
---|
| 250 | \begin{CompactList}\small\item\em cache of fy.R \item\end{CompactList}\item |
---|
| 251 | \hypertarget{classbdm_1_1Kalman_fa172078091e45561343fa513dd573b0}{ |
---|
| 252 | vec \& \hyperlink{classbdm_1_1Kalman_fa172078091e45561343fa513dd573b0}{\_\-mu}} |
---|
| 253 | \label{classbdm_1_1Kalman_fa172078091e45561343fa513dd573b0} |
---|
| 254 | |
---|
| 255 | \begin{CompactList}\small\item\em cache of est.mu \item\end{CompactList}\item |
---|
| 256 | \hypertarget{classbdm_1_1Kalman_00c27b0bf324f0018497921ca23c71ed}{ |
---|
| 257 | \hyperlink{classchmat}{chmat} \& \hyperlink{classbdm_1_1Kalman_00c27b0bf324f0018497921ca23c71ed}{\_\-P}} |
---|
| 258 | \label{classbdm_1_1Kalman_00c27b0bf324f0018497921ca23c71ed} |
---|
| 259 | |
---|
| 260 | \begin{CompactList}\small\item\em cache of est.R \item\end{CompactList}\item |
---|
[269] | 261 | \hypertarget{classbdm_1_1BM_c400357e37d27a4834b2b1d9211009ed}{ |
---|
| 262 | \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1BM_c400357e37d27a4834b2b1d9211009ed}{drv}} |
---|
| 263 | \label{classbdm_1_1BM_c400357e37d27a4834b2b1d9211009ed} |
---|
| 264 | |
---|
| 265 | \begin{CompactList}\small\item\em Random variable of the data (optional). \item\end{CompactList}\item |
---|
[261] | 266 | \hypertarget{classbdm_1_1BM_4064b6559d962633e4372b12f4cd204a}{ |
---|
| 267 | double \hyperlink{classbdm_1_1BM_4064b6559d962633e4372b12f4cd204a}{ll}} |
---|
| 268 | \label{classbdm_1_1BM_4064b6559d962633e4372b12f4cd204a} |
---|
| 269 | |
---|
| 270 | \begin{CompactList}\small\item\em Logarithm of marginalized data likelihood. \item\end{CompactList}\item |
---|
| 271 | \hypertarget{classbdm_1_1BM_faff0ad12556fe7dc0e2807d4fd938ee}{ |
---|
| 272 | bool \hyperlink{classbdm_1_1BM_faff0ad12556fe7dc0e2807d4fd938ee}{evalll}} |
---|
| 273 | \label{classbdm_1_1BM_faff0ad12556fe7dc0e2807d4fd938ee} |
---|
| 274 | |
---|
| 275 | \begin{CompactList}\small\item\em If true, the filter will compute likelihood of the data record and store it in {\tt ll} . Set to false if you want to save computational time. \item\end{CompactList}\end{CompactItemize} |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | \subsection{Member Function Documentation} |
---|
| 279 | \hypertarget{classbdm_1_1KalmanCh_b41fe5540548100b08e1684c3be767b6}{ |
---|
| 280 | \index{bdm::KalmanCh@{bdm::KalmanCh}!bayes@{bayes}} |
---|
| 281 | \index{bayes@{bayes}!bdm::KalmanCh@{bdm::KalmanCh}} |
---|
| 282 | \subsubsection[bayes]{\setlength{\rightskip}{0pt plus 5cm}void bdm::KalmanCh::bayes (const vec \& {\em dt})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
---|
| 283 | \label{classbdm_1_1KalmanCh_b41fe5540548100b08e1684c3be767b6} |
---|
| 284 | |
---|
| 285 | |
---|
| 286 | Here dt = \mbox{[}yt;ut\mbox{]} of appropriate dimensions. |
---|
| 287 | |
---|
| 288 | The following equality hold::\[ \left[\begin{array}{cc} R^{0.5}\\ P_{t|t-1}^{0.5}C' & P_{t|t-1}^{0.5}CA'\\ & Q^{0.5}\end{array}\right]<\mathrm{orth.oper.}>=\left[\begin{array}{cc} R_{y}^{0.5} & KA'\\ & P_{t+1|t}^{0.5}\\ \\\end{array}\right]\] |
---|
| 289 | |
---|
| 290 | Thus this object evaluates only predictors! Not filtering densities. |
---|
| 291 | |
---|
| 292 | Reimplemented from \hyperlink{classbdm_1_1Kalman_4a39330c14eff8d13179e868a1d1aa8c}{bdm::Kalman$<$ chmat $>$}. |
---|
| 293 | |
---|
| 294 | Reimplemented in \hyperlink{classbdm_1_1EKFCh_4c8609c37290b158f88a31dae4047225}{bdm::EKFCh}. |
---|
| 295 | |
---|
[270] | 296 | References chmat::\_\-Ch(), bdm::Kalman$<$ chmat $>$::\_\-K, bdm::Kalman$<$ chmat $>$::\_\-mu, bdm::Kalman$<$ chmat $>$::\_\-P, bdm::Kalman$<$ chmat $>$::\_\-Ry, bdm::Kalman$<$ chmat $>$::\_\-yp, bdm::Kalman$<$ chmat $>$::A, bdm::Kalman$<$ chmat $>$::B, bdm::Kalman$<$ chmat $>$::C, bdm::Kalman$<$ chmat $>$::D, bdm::Kalman$<$ chmat $>$::dimu, bdm::Kalman$<$ chmat $>$::dimx, bdm::Kalman$<$ chmat $>$::dimy, bdm::BM::evalll, bdm::eEF::evallog(), bdm::Kalman$<$ chmat $>$::fy, bdm::BM::ll, postA, and preA.\hypertarget{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff}{ |
---|
| 297 | \index{bdm::KalmanCh@{bdm::KalmanCh}!\_\-copy\_\-@{\_\-copy\_\-}} |
---|
| 298 | \index{\_\-copy\_\-@{\_\-copy\_\-}!bdm::KalmanCh@{bdm::KalmanCh}} |
---|
| 299 | \subsubsection[\_\-copy\_\-]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf BM}$\ast$ bdm::BM::\_\-copy\_\- ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual, inherited\mbox{]}}}} |
---|
| 300 | \label{classbdm_1_1BM_c0f027ff91d8459937c6f60ff8e553ff} |
---|
| 301 | |
---|
| 302 | |
---|
| 303 | Copy function required in vectors, Arrays of \hyperlink{classbdm_1_1BM}{BM} etc. Have to be DELETED manually! Prototype: |
---|
| 304 | |
---|
| 305 | \begin{Code}\begin{verbatim} BM* _copy_(){return new BM(*this);} |
---|
| 306 | \end{verbatim} |
---|
| 307 | \end{Code} |
---|
| 308 | |
---|
| 309 | |
---|
| 310 | |
---|
| 311 | Reimplemented in \hyperlink{classbdm_1_1ARX_60c40b5c6abc4c7e464b4ccae64a5a61}{bdm::ARX}.\hypertarget{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0}{ |
---|
[261] | 312 | \index{bdm::KalmanCh@{bdm::KalmanCh}!logpred@{logpred}} |
---|
| 313 | \index{logpred@{logpred}!bdm::KalmanCh@{bdm::KalmanCh}} |
---|
| 314 | \subsubsection[logpred]{\setlength{\rightskip}{0pt plus 5cm}virtual double bdm::BM::logpred (const vec \& {\em dt}) const\hspace{0.3cm}{\tt \mbox{[}inline, virtual, inherited\mbox{]}}}} |
---|
| 315 | \label{classbdm_1_1BM_50257e0c1e5b5c73153ea6e716ad8ae0} |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | Evaluates predictive log-likelihood of the given data record I.e. marginal likelihood of the data with the posterior integrated out. |
---|
| 319 | |
---|
| 320 | Reimplemented in \hyperlink{classbdm_1_1ARX_080a7e531e3aa06694112863b15bc6a4}{bdm::ARX}, \hyperlink{classbdm_1_1MixEF_da724da464a75e07521941e430929efa}{bdm::MixEF}, and \hyperlink{classbdm_1_1multiBM_e157b607c1e3fa91d42aeea44458e2bf}{bdm::multiBM}. |
---|
| 321 | |
---|
[270] | 322 | Referenced by bdm::BM::logpred\_\-m(). |
---|
[261] | 323 | |
---|
| 324 | The documentation for this class was generated from the following files:\begin{CompactItemize} |
---|
| 325 | \item |
---|
| 326 | \hyperlink{libKF_8h}{libKF.h}\item |
---|
| 327 | libKF.cpp\end{CompactItemize} |
---|