Changeset 660 for library/bdm/estim/particles.h

Timestamp:

10/15/09 00:04:30 (15 years ago)

Author:

smidl

Message:

doc - doxygen warnings

Files:

• library/bdm/estim/particles.h (modified) (8 diffs)

library/bdm/estim/particles.h

@@ -106 +106 @@
         //!access function
         vec& _lls() { return lls; }
+        //!access function
         RESAMPLING_METHOD _resmethod() const { return resmethod; }
-        //!access function
+        //! return correctly typed posterior (covariant return)
         const eEmp& posterior() const {return est;}
         
@@ -190 +191 @@
                 est.resample(ind,resmethod);
         }
+        //! access function
         Array<vec>& __samples(){return _samples;}
 };
@@ -203 +205 @@
 class MPF : public BM  {
         protected:
+                //! particle filter on non-linear variable
         shared_ptr<PF> pf;
+        //! Array of Bayesian models
         Array<BM*> BMs;
 
@@ -209 +213 @@
 
         class mpfepdf : public epdf  {
+                //! pointer to particle filter
                 shared_ptr<PF> &pf;
+                //! pointer to Array of BMs
                 Array<BM*> &BMs;
         public:
+                //! constructor
                 mpfepdf (shared_ptr<PF> &pf0, Array<BM*> &BMs0): epdf(), pf(pf0), BMs(BMs0) { };
                 //! a variant of set parameters - this time, parameters are read from BMs and pf
@@ -300 +307 @@
         //! Default constructor.
         MPF () :  jest (pf,BMs) {};
+        //! set all parameters at once
         void set_parameters ( shared_ptr<mpdf> par0, shared_ptr<mpdf> obs0, int n0, RESAMPLING_METHOD rm = SYSTEMATIC ) {
                 pf->set_model ( par0, obs0); 
@@ -305 +313 @@
                 BMs.set_length ( n0 );
         }
+        //! set a prototype of BM, copy it to as many times as there is particles in pf
         void set_BM ( const BM &BMcond0 ) {
 
@@ -313 +322 @@
                 for ( int i = 0; i < n; i++ ) {
                         BMs ( i ) = BMcond0._copy_();
-                        BMs ( i )->condition ( pf->posterior()._sample ( i ) );
                 }
         };
@@ -374 +382 @@
                 }
                 jest.read_parameters();
+                for ( int i = 0; i < pf->__w().length(); i++ ) {
+                        BMs ( i )->condition ( pf->posterior()._sample ( i ) );
+                }
         }