Changeset 660 for library/bdm/base/bdmbase.h

Timestamp:

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

Author:

smidl

Message:

doc - doxygen warnings

Files:

• library/bdm/base/bdmbase.h (modified) (11 diffs)

library/bdm/base/bdmbase.h

@@ -238 +238 @@
                 return tmp;
         }
-        //! return rvs with expanded delayes and sorted in the order of: \f$ [ rv_{0}, rv_{-1}, rv_{
+        //! return rvs with expanded delayes and sorted in the order of: \f$ [ rv_{0}, rv_{-1},\ldots  rv_{max_delay}]\f$
         RV expand_delayes() const {
                 RV rvt = this->remove_time(); //rv at t=0
@@ -764 +764 @@
 class datalink_2to1_buffered {
 protected:
+        //! link 1st vector to down
         datalink_buffered dl1;
+        //! link 2nd vector to down
         datalink_buffered dl2;
 public:
@@ -772 +774 @@
                 dl2.set_connection ( rv, rv_up2 );
         }
+        //! fill values of down from the values of the two up vectors
         void filldown ( const vec &val1, const vec &val2, vec &val_down ) {
                 bdm_assert_debug ( val_down.length() >= dl1._downsize() + dl2._downsize(), "short val_down" );
@@ -777 +780 @@
                 dl2.filldown ( val2, val_down );
         }
+        //! update buffer
         void step ( const vec &dt, const vec &ut ) {
                 dl1.step ( dt );
@@ -962 +966 @@
                 //!Description of output data
                 RV Yrv; //
-        //! Remember its own index in Logger L
-        int L_dt, L_ut;
+        //! Remember its own index in Logger L, [0=dt, 1=ut]
+        ivec LIDs;
 public:
         //! default constructors
-                DS() : Drv(), Urv(),Yrv() {};
+                DS() : Drv(), Urv(),Yrv(), LIDs(2) {};
 
         //! Returns maximum number of provided data, by default it is set to maximum allowed length, shorter DS should overload this method! See, MemDS.max_length().
@@ -980 +984 @@
 
         //! Accepts action variable and schedule it for application.
-        virtual void write ( vec &ut ) {
+        virtual void write (const vec &ut ) {
                 bdm_error ( "abstract class" );
         }
 
         //! Accepts action variables at specific indeces
-        virtual void write ( vec &ut, const ivec &indeces ) {
+        virtual void write (const vec &ut, const ivec &indeces ) {
                 bdm_error ( "abstract class" );
         }
@@ -1000 +1004 @@
                 bdm_assert ( utsize == Urv._dsize(), "invalid DS: utsize (" + num2str ( utsize ) + ") different from Urv " + num2str ( Urv._dsize() ) );
 
-                L_dt = L.add ( Drv, "" );
-                L_ut = L.add ( Urv, "" );
+                LIDs(0) = L.add ( Drv, "" );
+                LIDs(1) = L.add ( Urv, "" );
         }
         //! Register DS for logging into logger L
@@ -1008 +1012 @@
                 getdata ( tmp );
                 // d is first in getdata
-                L.logit ( L_dt, tmp.left ( Drv._dsize() ) );
+                L.logit ( LIDs(0), tmp.left ( Drv._dsize() ) );
                 // u follows after d in getdata
-                L.logit ( L_ut, tmp.mid ( Drv._dsize(), Urv._dsize() ) );
+                L.logit ( LIDs(1), tmp.mid ( Drv._dsize(), Urv._dsize() ) );
         }
         //!access function
@@ -1072 +1076 @@
         };
         BM ( const BM &B ) :  drv ( B.drv ), ll ( B.ll ), evalll ( B.evalll ) {}
-        //! Copy function required in vectors, Arrays of BM etc. Have to be DELETED manually!
+        //! \brief Copy function required in vectors, Arrays of BM etc. Have to be DELETED manually!
         //! Prototype: \code BM* _copy_() const {return new BM(*this);} \endcode
         virtual BM* _copy_() const {
@@ -1138 +1142 @@
         //! \name Access to attributes
         //!@{
-
+        //! access function
         const RV& _drv() const {
                 return drv;
         }
+        //! access function
         void set_drv ( const RV &rv ) {
                 drv = rv;
         }
+        //! access to rv of the posterior
         void set_rv ( const RV &rv ) {
                 const_cast<epdf&> ( posterior() ).set_rv ( rv );
         }
+        //! return internal log-likelihood of the last data vector
         double _ll() const {
                 return ll;
         }
+        //! switch evaluation of log-likelihood on/off
         void set_evalll ( bool evl0 ) {
                 evalll = evl0;
         }
+        //! return posterior density
         virtual const epdf& posterior() const = 0;
         //!@}
@@ -1216 +1225 @@
 
 };
-
+//! array of pointers to epdf
 typedef Array<shared_ptr<epdf> > epdf_array;
-
+//! array of pointers to mpdf
 typedef Array<shared_ptr<mpdf> > mpdf_array;