Changeset 1059

Show
Ignore:
Timestamp:
06/08/10 17:12:22 (14 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/bdm/base/datasources.h

    r1058 r1059  
    2222* \brief Memory storage of off-line data column-wise (used mostly in C++) 
    2323 
    24 The data are stored in an internal matrix \c Data . E 
    25 ach column of Data corresponds to one discrete time observation \f$t\f$.  
     24The data are stored in an internal matrix \c Data .  
     25Each column of Data corresponds to one discrete time observation \f$t\f$.  
    2626 
    2727*/ 
     
    6565        /*! Create object from the following structure 
    6666        \code 
    67         class = "MemDS"; 
    68         Data = (...);               % Data matrix or data vector 
    69            --- optional --- 
    70         time = 0;                   % Index of the first column to user_info, 
    71         ...                         % fields from  bdm::DS::from_setting 
     67        class = 'MemDS'; 
     68        Data = [...];               // Data matrix or data vector 
     69        --- optional --- 
     70        time = 0;                   // Index of the first column in the matrix Data 
     71        --- fields from  bdm::DS::from_setting --- 
    7272        \endcode 
    7373 
    7474        If the optional fields are not given, they will be filled as follows: 
    7575        \code 
    76         drv = {names=("ch0", "ch1", "ch2", ..."number_of_rows_of_Data"); 
    77               sizes=( 1    1    1 ...); 
    78                   times=( 0    0    0 ...); 
    79                   }; 
     76        drv.names=(""); 
     77        drv.sizes=( no_rows_Data ); 
    8078        time = 0; 
    8179        \endcode 
    8280        If \c rowid is given, \c drv will be named after indices in rowids. 
    8381 
    84         Hence the data provided by method \c getdata() will be full column of matrix Data starting from the first record. 
    8582        */ 
    8683        void from_setting ( const Setting &set ); 
     
    9289/*! \brief Pseudovirtual class for reading data from files 
    9390 
     91Common predecessord to various file formats. 
    9492*/ 
    9593class FileDS: public MemDS { 
     
    10098        \code 
    10199        filename = 'data_file.ext';           // name of the file where the data sare stored 
    102         the same as #bdm::DS 
     100        --- fields from bdm::DS --- 
    103101        \endcode 
    104102        */ 
     
    127125        }; 
    128126 
     127        /*!  
     128        \code 
     129        class    = 'ITppFileDS';          
     130        filename = 'file_with_data.it'; 
     131        varname  = 'Data1';                  // Name of a variable in which are th data stored 
     132        \endcode 
     133        */ 
    129134        void from_setting ( const Setting &set ); 
    130135 
     
    207212 
    208213/*!  \brief Simulate data from conditional density 
    209 Still having only one density but allowing conditioning on either input or delayed values. 
     214 
     215Data are simulated by sampling from conditional pdf. 
     216 
     217The condition can be of two types: 
     218 -# delayed output values: these are cached internally, initiated via \c init_rv and \c init_values. 
     219 -# input values: remaining RVs in the rvc of the given pdf are considered to be inputs and are declared as \c urv 
     220 
     221Note: 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. 
    210222*/ 
    211223class PdfDS : public DS {