Changeset 651 for library/doc/tutorial

Show
Ignore:
Timestamp:
10/12/09 13:49:39 (15 years ago)
Author:
mido
Message:

\doc directory cleaned a bit

Location:
library/doc/tutorial
Files:
4 modified

Legend:

Unmodified
Added
Removed

  • library/doc/tutorial/01userguide.dox

    r632 r651  
    44This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref user_guide0 it also serves as introduction to configuration of an experiment (see \ref ui_page) and basic decision making objects (bdm::RV and bdm::DS). 
    55 
    6 All experiments are demonstarted on scenario simulator which can be either standalone application of mex file (simulator.mex**). 
     6All experiments are demonstarted on scenario simulator which can be either standalone application or mex file (simulator.mex**). 
    77 
    88 
    … …  
    121121 times=[-1, 1]; 
    122122 \endcode  
    123  denotes 5-dimensional vector \f$ [a_{t-1}', b_{t+1}] \f$. 
     123 denotes 5-dimensional vector \f$ [a_{t-1}, b_{t+1}] \f$. 
    124124  
    125125\subsection ug_rv_alg Algebra on RVs 
    … …  
    272272\section ug_store Storing results of simulation 
    273273 
    274 If the simulated data are to be analyzed off-line it may be advantageous to store them and use for later use.  
     274If the simulated data are to be analyzed off-line it may be advantageous to store them and use later on.  
    275275This operation is straightforward if the class of logger used in the \c simulator is compatible with some datasource class. 
    276276 

  • library/doc/tutorial/02userguide2.dox

    r642 r651  
    6262These values are stored in given logger (\ref ug_loggers). By default, only mean values of the estimate are stored. 
    6363 
    64 Storing of the log-likelihood is useful, e.g. in model selection task when too models are compared. 
     64Storing of the log-likelihood is useful, e.g. in model selection task when two models are compared. 
    6565 
    6666The bounds are useful e.g. for visualization of the results. Run of the example should provide result like the following: 

  • library/doc/tutorial/arx_ui.dox

    r600 r651  
    11/*! 
    2 \page arx_ui Running experiment \c estimator with ARX data fields \todo this page is out of date, as the user info concept has been changed 
     2\page arx_ui Running experiment \c estimator with ARX data fields  
    33 
    44The experiment \ref estimator.cpp can be run either on command line, or as a mex file in Matlab. 
    … …  
    66\section cmd Command Line 
    77 
    8 In order to use it for estimation of an ARX model, we can define the following \ref ui_page structure: 
     8In order to use it for estimation of an ARX model, we can define the following \ref ui_page "user info" structure: 
    99\include arx_test.cfg 
    1010 

  • library/doc/tutorial/library_structure.dox

    r613 r651  
    1818<li> source:/doc/html -- html documentation generated automatically by Doxygen </li> 
    1919<li> source:/doc/images -- ... </li> 
    20 <li> source:/doc/issues -- ... </li> 
    21 <li> source:/doc/latex -- latex documentation generated automatically by Doxygen </li> 
    2220<li> source:/doc/local -- documentation pages which are not related to any specific source file </li> 
    2321<li> source:/doc/tutorial -- documentation pages related to the library tutorial</li> 
    24 <li> source:/doc/xml -- ... </li> 
    2522<li> source:/matlab -- matlab input/output utilities </li> 
    2623<li> source:/system -- a system specific parts necessary to run CMake </li>