Changeset 944 for library/bdm/base

Timestamp:

05/16/10 23:13:21 (14 years ago)

Author:

smidl

Message:

Doc + new examples

Location:

library/bdm/base

Files:

• bdmbase.h (modified) (1 diff)
• datasources.h (modified) (1 diff)

library/bdm/base/bdmbase.h

@@ -1016 +1016 @@
 The DataSource has three main data interaction structures:
 \li input, \f$ u_t \f$,
-\li output \f$ y_t \f$,
-\li data, \f$ d_t=[y_t,u_t, \ldots ]\f$ a collection of all inputs and outputs and possibly some internal variables too.
-
+\li output \f$ d_t \f$,
+In simulators, d_t may contain "hidden" variables as well.
 */
 
 class DS : public root {
-        //! \var log_level_enums logdt
-        //! TODO DOPLNIT
+        //! \var log_level_enums logdt 
+        //! log all outputs
 
         //! \var log_level_enums logut 
-        //! TODO DOPLNIT
+        //! log all inputs
         LOG_LEVEL(DS,logdt,logut);
 

library/bdm/base/datasources.h

@@ -77 +77 @@
         /*! Create object from the following structure
         \code
-        { class = "MemDS";
-           Data = (...);            // Data matrix or data vector
+        DS.class = "MemDS";
+        DS.Data = (...);               % Data matrix or data vector
            --- optional ---
-           drv = {class="RV"; ...} // Identification how rows of the matrix Data will be known to others
-           time = 0;               // Index of the first column to user_info,
+        DS.drv = {class="RV"; ...}     % Identification how rows of the matrix Data will be known to others
+        DS.time = 0;                   % Index of the first column to user_info,
+        DS.log_level = "logdt,logut";  % switches to log (or not log) dt or ut
         }
         \endcode