Changeset 676 for library

Timestamp:

10/22/09 01:13:47 (15 years ago)

Author:

smidl

Message:

logger refactoring

Location:

library/bdm

Files:

• base/bdmbase.h (modified) (8 diffs)
• base/datasources.cpp (modified) (1 diff)
• base/datasources.h (modified) (6 diffs)
• base/loggers.cpp (modified) (2 diffs)
• base/loggers.h (modified) (1 diff)
• bdmroot.h (modified) (2 diffs)
• design/ctrlbase.h (modified) (1 diff)
• estim/particles.h (modified) (3 diffs)
• mex/mex_datasource.h (modified) (2 diffs)

library/bdm/base/bdmbase.h

@@ -298 +298 @@
 RV concat ( const RV &rv1, const RV &rv2 );
 
+/*!
+@brief Class for storing results (and semi-results) of an experiment
+
+This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a logger. Specializations of this abstract class for specific storage method are designed.
+*/
+class logger : public root {
+        protected:
+                //! RVs of all logged variables.
+                Array<RV> entries;
+                //! Names of logged quantities, e.g. names of algorithm variants
+                Array<string> names;
+                //!separator of prefixes of entries
+                const string separator;
+        public:
+                //!Default constructor
+                logger(const string separator0) : entries ( 0 ), names ( 0 ), separator(separator0) {}
+                
+                //! returns an identifier which will be later needed for calling the \c logit() function
+                //! For empty RV it returns -1, this entry will be ignored by \c logit().
+                virtual int add ( const RV &rv, string prefix = "" ) {
+                        int id;
+                        if ( rv._dsize() > 0 ) {
+                                id = entries.length();
+                                names = concat ( names, prefix ); // diff
+                                entries.set_length ( id + 1, true );
+                                entries ( id ) = rv;
+                        } else {
+                                id = -1;
+                        }
+                        return id; // identifier of the last entry
+                }
+                
+                //! log this vector
+                virtual void logit ( int id, const vec &v ) {
+                        bdm_error ( "Not implemented" );
+                };
+                //! log this double
+                virtual void logit ( int id, const double &d ) {
+                        bdm_error ( "Not implemented" );
+                };
+                
+                //! Shifts storage position for another time step.
+                virtual void step() {
+                        bdm_error ( "Not implemneted" );
+                };
+                
+                //! Finalize storing information
+                virtual void finalize() {};
+                
+                //! Initialize the storage
+                virtual void init() {};
+                
+                //!separator of prefixes for this logger
+                const string& prefix_sep() {return separator;}
+};
+
+
 //! Class representing function \f$f(x)\f$ of variable \f$x\f$ represented by \c rv
 class fnc : public root {
@@ -532 +589 @@
                 //bdm_assert_debug ( isnamed(), "" );
                 return rv;
+        }
+        //! store values of the epdf on the following levels:
+        //!  #1 mean
+        //!  #2 mean + lower & upper bound
+        void log_register(logger &L, const string &prefix){
+                RV r;
+                if ( isnamed() ) {
+                        r = _rv();
+                } else {
+                        r = RV ( "", dimension() );
+                };
+                root::log_register(L,prefix);
+                logrec->ids.set_size(3);
+                if (log_level >0){
+                        logrec->ids(0) = logrec->L.add ( r, prefix + logrec->L.prefix_sep()+ "mean" );
+                }
+                if (log_level >1){
+                        logrec->ids(1) = logrec->L.add ( r, prefix + logrec->L.prefix_sep()+ "lb" );
+                        logrec->ids(2) = logrec->L.add ( r, prefix + logrec->L.prefix_sep()+ "ub" );
+                }
         }
         //!@}
@@ -861 +938 @@
 };
 
-/*!
-@brief Class for storing results (and semi-results) of an experiment
-
-This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a logger. Specializations of this abstract class for specific storage method are designed.
- */
-class logger : public root {
-protected:
-        //! RVs of all logged variables.
-        Array<RV> entries;
-        //! Names of logged quantities, e.g. names of algorithm variants
-        Array<string> names;
-public:
-        //!Default constructor
-        logger() : entries ( 0 ), names ( 0 ) {}
-
-        //! returns an identifier which will be later needed for calling the \c logit() function
-        //! For empty RV it returns -1, this entry will be ignored by \c logit().
-        virtual int add ( const RV &rv, string prefix = "" ) {
-                int id;
-                if ( rv._dsize() > 0 ) {
-                        id = entries.length();
-                        names = concat ( names, prefix ); // diff
-                        entries.set_length ( id + 1, true );
-                        entries ( id ) = rv;
-                } else {
-                        id = -1;
-                }
-                return id; // identifier of the last entry
-        }
-
-        //! log this vector
-        virtual void logit ( int id, const vec &v ) {
-                bdm_error ( "Not implemented" );
-        };
-        //! log this double
-        virtual void logit ( int id, const double &d ) {
-                bdm_error ( "Not implemented" );
-        };
-
-        //! Shifts storage position for another time step.
-        virtual void step() {
-                bdm_error ( "Not implemneted" );
-        };
-
-        //! Finalize storing information
-        virtual void finalize() {};
-
-        //! Initialize the storage
-        virtual void init() {};
-
-};
-
 
 //! \brief Combines RVs from a list of mpdfs to a single one.
@@ -946 +971 @@
                 //!Description of output data
                 RV Yrv; //
-        //! Remember its own index in Logger L, [0=dt, 1=ut]
-        ivec LIDs;
 public:
         //! default constructors
-                DS() : Drv(), Urv(),Yrv(), LIDs(2) {};
+                DS() : Drv(), Urv(),Yrv() {log_level=1;};
 
         //! 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().
         virtual int max_length() {return std::numeric_limits< int >::max();}
         //! Returns full vector of observed data=[output, input]
-        virtual void getdata ( vec &dt ) {
+        virtual void getdata ( vec &dt ) const {
                 bdm_error ( "abstract class" );
         }
@@ -980 +1003 @@
 
         //! Register DS for logging into logger L
-        virtual void log_add ( logger &L ) {
-                bdm_assert ( dtsize == Drv._dsize(), "invalid DS: dtsize (" + num2str ( dtsize ) + ") different from Drv " + num2str ( Drv._dsize() ) );
+        virtual void log_register (logger &L,  const string &prefix ) {
+                bdm_assert ( ytsize == Yrv._dsize(), "invalid DS: ytsize (" + num2str ( ytsize ) + ") different from Drv " + num2str ( Yrv._dsize() ) );
                 bdm_assert ( utsize == Urv._dsize(), "invalid DS: utsize (" + num2str ( utsize ) + ") different from Urv " + num2str ( Urv._dsize() ) );
 
-                LIDs(0) = L.add ( Drv, "" );
-                LIDs(1) = L.add ( Urv, "" );
+                root::log_register(L,prefix);
+                //we know that 
+                if (log_level >0){
+                        logrec->ids.set_size(2);
+                        logrec->ids(0) = logrec->L.add ( Yrv, "" );
+                        logrec->ids(1) = logrec->L.add ( Urv, "" );
+                }
         }
         //! Register DS for logging into logger L
-        virtual void logit ( logger &L ) {
-                vec tmp ( Drv._dsize() + Urv._dsize() );
-                getdata ( tmp );
-                // d is first in getdata
-                L.logit ( LIDs(0), tmp.left ( Drv._dsize() ) );
-                // u follows after d in getdata
-                L.logit ( LIDs(1), tmp.mid ( Drv._dsize(), Urv._dsize() ) );
+        virtual void log_write ( ) const {
+                if (log_level >0) {
+                        vec tmp ( Yrv._dsize() + Urv._dsize());
+                        getdata ( tmp );
+                        // d is first in getdata
+                        logrec->L.logit ( logrec->ids(0), tmp.left ( Yrv._dsize() ) );
+                        // u follows after d in getdata
+                        logrec->L.logit ( logrec->ids(1), tmp.mid ( Yrv._dsize(), Urv._dsize() ) );
+                }
         }
         //!access function
         virtual const RV& _drv() const {
-                //              return concat (Drv, Urv);// why!!!
-                return Drv;// why!!!
+                return Drv;
         }
         //!access function
@@ -1005 +1034 @@
                 return Urv;
         }
-                //!access function
-                const RV& _yrv() const {
-                        return Yrv;
-                }
+        //!access function
+        const RV& _yrv() const {
+                return Yrv;
+        }
         //! set random variables
-                virtual void set_drv (const  RV &yrv, const RV &urv) {
-                    Yrv = yrv;
-                        Drv = concat(yrv,urv);
+        virtual void set_drv (const  RV &yrv, const RV &urv) {
+                Yrv = yrv;
+                Drv = concat(yrv,urv);
                 Urv = urv;
         }
@@ -1046 +1075 @@
         //!  If true, the filter will compute likelihood of the data record and store it in \c ll . Set to false if you want to save computational time.
         bool evalll;
+        
 public:
         //! \name Constructors
         //! @{
 
-        BM() : ll ( 0 ), evalll ( true ), LIDs ( 4 ), LFlags ( 4 ) {
-                LIDs = -1;/*empty IDs*/
-                LFlags = 0;
-                LFlags ( 0 ) = 1;  /*log only mean*/
-        };
+        BM() : ll ( 0 ), evalll ( true ) { };
         BM ( const BM &B ) :  drv ( B.drv ), ll ( B.ll ), evalll ( B.evalll ) {}
         //! \brief Copy function required in vectors, Arrays of BM etc. Have to be DELETED manually!
@@ -1151 +1177 @@
         //! Set boolean options from a string, recognized are: "logbounds,logll"
         virtual void set_options ( const string &opt ) {
-                LFlags ( 0 ) = 1;
                 if ( opt.find ( "logbounds" ) != string::npos ) {
-                        LFlags ( 1 ) = 1;
-                        LFlags ( 2 ) = 1;
+                        const_cast<epdf&>(posterior()).set_log_level(2) ;
+                } else {
+                        const_cast<epdf&>(posterior()).set_log_level(1) ;
                 }
                 if ( opt.find ( "logll" ) != string::npos ) {
-                        LFlags ( 3 ) = 1;
-                }
-        }
-        //! IDs of storages in loggers 4:[1=mean,2=lb,3=ub,4=ll]
-        ivec LIDs;
-
-        //! Flags for logging - same size as LIDs, each entry correspond to the same in LIDs
-        ivec LFlags;
+                        log_level = 1;
+                }
+        }
+
         //! Add all logged variables to a logger
-        virtual void log_add ( logger &L, const string &name = "" ) {
-                // internal
-                RV r;
-                if ( posterior().isnamed() ) {
-                        r = posterior()._rv();
-                } else {
-                        r = RV ( "est", posterior().dimension() );
-                };
-
-                // Add mean value
-                if ( LFlags ( 0 ) ) LIDs ( 0 ) = L.add ( r, name + "mean_" );
-                if ( LFlags ( 1 ) ) LIDs ( 1 ) = L.add ( r, name + "lb_" );
-                if ( LFlags ( 2 ) ) LIDs ( 2 ) = L.add ( r, name + "ub_" );
-                if ( LFlags ( 3 ) ) LIDs ( 3 ) = L.add ( RV ( "ll", 1 ), name );    //TODO: "local" RV
-        }
-        virtual void logit ( logger &L ) {
-                L.logit ( LIDs ( 0 ), posterior().mean() );
-                if ( LFlags ( 1 ) || LFlags ( 2 ) ) {  //if one of them is off, its LID==-1 and will not be stored
-                        vec ub, lb;
-                        posterior().qbounds ( lb, ub );
-                        L.logit ( LIDs ( 1 ), lb );
-                        L.logit ( LIDs ( 2 ), ub );
-                }
-                if ( LFlags ( 3 ) ) L.logit ( LIDs ( 3 ), ll );
+        //! Log levels two digits: xy where
+        //!  * y = 0/1 log-likelihood is to be logged
+        //!  * x = level of the posterior (typically 0/1/2 for nothing/mean/bounds)
+        virtual void log_register ( logger &L, const string &prefix = "" ) {
+                root::log_register(L,prefix);           
+
+                const_cast<epdf&>(posterior()).log_register(L, prefix+L.prefix_sep()+"apost"); 
+                
+                if ((log_level) > 0){
+                        logrec->ids.set_size(1);
+                        logrec->ids(0) = L.add(RV("ll",1), prefix+L.prefix_sep()+"ll");
+                }
+        }
+        //! Save results to the given logger, details of what is stored is configured by \c LIDs and \c options
+        virtual void log_write ( ) const {
+                posterior().log_write();
+                if (log_level >0) { logrec->L.logit ( logrec->ids ( 0 ), ll );}
         }
         //!@}

library/bdm/base/datasources.cpp

@@ -4 +4 @@
 using namespace bdm;
 
-void MemDS::getdata ( vec &dt ) {
+void MemDS::getdata ( vec &dt ) const {
         int i;
 

library/bdm/base/datasources.h

@@ -38 +38 @@
         public:
                 int max_length() {return Data.cols();}
-                void getdata ( vec &dt );
+                void getdata ( vec &dt ) const;
                 void getdata ( vec &dt, const ivec &indeces );
                 void set_drv (const RV &drv,const  RV &urv );
@@ -89 +89 @@
                         set_drv(*r,RV()); //empty urv
                         dtsize=r->_dsize();
+                        ytsize = dtsize;
                         utsize=0;
                 }
@@ -109 +110 @@
                         dt=iepdf->sample();
                 }
-                void getdata ( vec &dt_out ) {
+                void getdata ( vec &dt_out ) const {
                         dt_out = dt;
                 }
@@ -167 +168 @@
                         ut2rgr.step(ut); //u is now history
                 }
-                void getdata ( vec &dt_out ) {
+                void getdata ( vec &dt_out ) const {
                         bdm_assert_debug(dt_out.length()>=utsize+ytsize,"Short output vector");
                         dt_out.set_subvector(0, yt);
@@ -249 +250 @@
                 }
                 //! no sense to log this type
-                void log_add ( logger &L ) {};
+                void log_register(logger &L, const string &prefix){};
                 //! no sense to log this type
-                void logit ( logger &L ) {};
+                void log_write ( ) const {};
 };
 
@@ -341 +342 @@
                 }
 
-                virtual void log_add ( logger &L ) {
-                        DS::log_add ( L );
-                        L_xt = L.add ( IM->_rv(), "true" );
-                }
-                virtual void logit ( logger &L ) {
-                        DS::logit ( L );
-                        L.logit ( L_xt, xt );
+                virtual void log_register(logger &L, const string &prefix){
+                        DS::log_register ( L, prefix ); //ids 0 and 1
+                        
+                        logrec->ids.set_size(3,true);//copy
+                        logrec->ids(2)=logrec->L.add ( IM->_rv(), "true" );
+                }
+                virtual void log_write () {
+                        DS::log_write ( );
+                        logrec->L.logit ( logrec->ids(2), xt );
                 }
 

library/bdm/base/loggers.cpp

@@ -78 +78 @@
                         // for non-empty names
                         if ( names ( i ).length() > 0 ) {
-                                scalarnames ( ii ) = names ( i ) + "_";
+                                scalarnames ( ii ) = names ( i ) + separator;
                         }
                         // add name
@@ -91 +91 @@
                                 for ( k = 0; k < rvsize; k++ ) { //for all scalars in given RV
                                         sprintf ( num, "%d", k );
-                                        scalarnames ( ii ) += ( std::string ) "_" + num;
+                                        scalarnames ( ii ) += separator + num;
                                         ii++;
                                 }

library/bdm/base/loggers.h

@@ -36 +36 @@
 public:
         //! convenience constructor
-        memlog ( int maxlen0, string itf = "" ) : maxlen ( maxlen0 ), ind ( 0 ), vectors ( 0 ), itfilename ( itf ) {}
+        memlog ( int maxlen0, string itf = "" ) :logger("."), maxlen ( maxlen0 ), ind ( 0 ), vectors ( 0 ), itfilename ( itf ) {}
 
         //!Default constructor
-        memlog() : maxlen ( 0 ), ind ( 0 ), vectors ( 0 ) {}
+        memlog() : logger("."), maxlen ( 0 ), ind ( 0 ), vectors ( 0 ) {}
 
         //! Initialize storage

library/bdm/bdmroot.h

@@ +1 @@
+
 /*!
   \file
@@ -24 +25 @@
 
 namespace bdm {
-
+        
+//forward declaration
+class logger;
+        
+//! information about connection to a logger
+class log_record {
+public:
+        //!remember which logger is registered 
+        logger &L;
+        //! vector of log IDs - one element for each entry
+        ivec ids;
+        
+        //!default constructor
+        log_record(logger &L0): L(L0),ids(0){}
+};
+        
 //! Root class of BDM objects
 class root {
         protected:
-        //! level of details that will be logged to logger
+        //! record of connections to the logger
+        log_record* logrec;
+        //! level of details that will be logged to a logger
         int log_level;
-        //! vector of log IDs - one element for each entry
-        ivec log_ids;
+        
 public:
+        //!default constructor
+        root() : logrec(NULL),log_level(0) {};
+        
         //! make sure this is a virtual object
         virtual ~root() {
+                if (logrec) delete logrec;
         }
 
-        //! This method returns a basic info about the current instance
+        //! Returns a basic textual info about the current instance
         virtual string to_string() const {
                 return "";
         }
+        //! Register itself in a logger, i.e. allocate space for data from this class
+        //! The level of details (parameter \c level ) is individual for each class.
+        virtual void log_register(logger &L, const string &prefix){
+                logrec = new log_record(L);
+        }
+        
+        //! Write current information into the given logger 
+        virtual void log_write() const {
+        }
+        //! set level of details to be logged - needs to be called before log_register!
+        virtual void set_log_level(int level) {log_level = level;}
 
-        //! This method arrange instance properties according the data stored in the Setting structure
+        //! Read instance properties according the data stored in the Setting structure
         virtual void from_setting ( const Setting &set ) {
         }
 
-        //! This method save all the instance properties into the Setting structure
+        //! Save all the instance properties into the Setting structure
         virtual void to_setting ( Setting &set ) const {
         }
 
-        //! This method checks that all internal structures has been correctly set-up, always call at the ned of from_setting
+        //! Check that all internal structures has been correctly set-up. Called at the end of from_setting.
         virtual void validate() {
         }
+        
 };
 

library/bdm/design/ctrlbase.h

@@ -146 +146 @@
                         const RV& _drv() {return drv;}
                         //! register this controller with given datasource under name "name"
-                        virtual void log_add ( logger &L, const string &name = "" ) { }
+                        virtual void log_register (logger &L,  int level, const string &prefix ) { }
                         //! write requested values into the logger
-                        virtual void logit ( logger &L ) { }
+                        virtual void log_write ( ) const { }
                         
         };

library/bdm/estim/particles.h

@@ -50 +50 @@
         //! \name Options
         //!@{
-
-        //! Log all samples
-        bool opt_L_smp;
-        //! Log all samples
-        bool opt_L_wei;
         //!@}
 
@@ -60 +55 @@
         //! \name Constructors
         //!@{
-        PF ( ) : est(), _w ( est._w() ), _samples ( est._samples() ), opt_L_smp ( false ), opt_L_wei ( false ) {
-                LIDs.set_size ( 5 );
+        PF ( ) : est(), _w ( est._w() ), _samples ( est._samples() ) {
         };
         
@@ -89 +83 @@
         void set_options ( const string &opt ) {
                 BM::set_options ( opt );
-                opt_L_wei = ( opt.find ( "logweights" ) != string::npos );
-                opt_L_smp = ( opt.find ( "logsamples" ) != string::npos );
         }
         //! bayes I - generate samples and add their weights to lls

library/bdm/mex/mex_datasource.h

@@ -45 +45 @@
                 rowid = linspace(0,Data.rows()-1);
                 dtsize=rowid.length();
+                ytsize=rowid.length();
                 utsize=0;
                 
@@ -126 +127 @@
         }
         void write(const vec &ut0){ ut=ut0;}
-        void getdata(vec &dt_out){dt_out = dt;  }
+        void getdata(vec &dt_out) const {dt_out = dt;   }