Changeset 1059

Timestamp:

06/08/10 17:12:22 (14 years ago)

Author:

smidl

Message:

doc

Files:

• library/bdm/base/datasources.h (modified) (6 diffs)

library/bdm/base/datasources.h

@@ -22 +22 @@
 * \brief Memory storage of off-line data column-wise (used mostly in C++)
 
-The data are stored in an internal matrix \c Data . E
-ach column of Data corresponds to one discrete time observation \f$t\f$. 
+The data are stored in an internal matrix \c Data . 
+Each column of Data corresponds to one discrete time observation \f$t\f$. 
 
 */
@@ -65 +65 @@
         /*! Create object from the following structure
         \code
-        class = "MemDS";
-        Data = (...);               % Data matrix or data vector
-           --- optional ---
-        time = 0;                   % Index of the first column to user_info,
-        ...                         % fields from  bdm::DS::from_setting
+        class = 'MemDS';
+        Data = [...];               // Data matrix or data vector
+        --- optional ---
+        time = 0;                   // Index of the first column in the matrix Data
+        --- fields from  bdm::DS::from_setting ---
         \endcode
 
         If the optional fields are not given, they will be filled as follows:
         \code
-        drv = {names=("ch0", "ch1", "ch2", ..."number_of_rows_of_Data");
-              sizes=( 1    1    1 ...);
-                  times=( 0    0    0 ...);
-                  };
+        drv.names=("");
+        drv.sizes=( no_rows_Data );
         time = 0;
         \endcode
         If \c rowid is given, \c drv will be named after indices in rowids.
 
-        Hence the data provided by method \c getdata() will be full column of matrix Data starting from the first record.
         */
         void from_setting ( const Setting &set );
@@ -92 +89 @@
 /*! \brief Pseudovirtual class for reading data from files
 
+Common predecessord to various file formats.
 */
 class FileDS: public MemDS {
@@ -100 +98 @@
         \code
         filename = 'data_file.ext';           // name of the file where the data sare stored
-        the same as #bdm::DS
+        --- fields from bdm::DS ---
         \endcode
         */
@@ -127 +125 @@
         };
 
+        /*! 
+        \code
+        class    = 'ITppFileDS';         
+        filename = 'file_with_data.it';
+        varname  = 'Data1';                  // Name of a variable in which are th data stored
+        \endcode
+        */
         void from_setting ( const Setting &set );
 
@@ -207 +212 @@
 
 /*!  \brief Simulate data from conditional density
-Still having only one density but allowing conditioning on either input or delayed values.
+
+Data are simulated by sampling from conditional pdf.
+
+The condition can be of two types:
+ -# delayed output values: these are cached internally, initiated via \c init_rv and \c init_values.
+ -# input values: remaining RVs in the rvc of the given pdf are considered to be inputs and are declared as \c urv
+
+Note: a classical state-space model can be simulated as an instance of this case since it can be seen as a chain rule on state-evolution pdf and observation pdf. See class bdm::mprod and other offsprings of pdf.
 */
 class PdfDS : public DS {