Changeset 85 for bdm/stat/libFN.h

Show
Ignore:
Timestamp:
04/28/08 10:21:21 (16 years ago)
Author:
smidl
Message:

compilation and documantation fixes

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • bdm/stat/libFN.h

    r62 r85  
    1818using namespace itpp; 
    1919 
    20 //! class representing function $f(x) = a$, here rv is empty 
     20//! class representing function \f$f(x) = a\f$, here \c rv is empty 
    2121class constfn : public fnc 
    2222{ 
    … …  
    3232}; 
    3333 
    34 //! Class representing function $f(x) = Ax+B$ 
     34//! Class representing function \f$f(x) = Ax+B\f$ 
    3535class linfn: public fnc 
    3636{ 
    37                 //! Identification of $x$ 
     37                //! Identification of \f$x\f$ 
    3838                RV rv; 
    3939                //! Matrix A 
    … …  
    5353 
    5454/*! 
    55 \brief Class representing a differentiable function of two variables $f(x,u)$. 
     55\brief Class representing a differentiable function of two variables \f$f(x,u)\f$. 
    5656 
    5757Function of two variables. 
    … …  
    7373                int dimu; 
    7474        public: 
    75                 //! Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ) 
     75                //! Evaluates \f$f(x0,u0)\f$ (VS: Do we really need common eval? ) 
    7676                vec eval ( const vec &cond ) 
    7777                { 
    … …  
    8080                }; 
    8181 
    82                 //! Evaluates $f(x0,u0)$ 
     82                //! Evaluates \f$f(x0,u0)\f$ 
    8383                virtual vec eval ( const vec &x0, const vec &u0 ) {return zeros ( dimy );}; 
    84                 //! Evaluates \f$A=\frac{d}{dx}f(x,u)|_{x0,u0}\f$ and writes result into \c A . @param full denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. @param x0 numeric value of $x$, @param u0 numeric value of $u$ @param A a place where the result will be stored. 
     84                //! Evaluates \f$A=\frac{d}{dx}f(x,u)|_{x0,u0}\f$ and writes result into \c A . @param full denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. @param x0 numeric value of \f$x\f$, @param u0 numeric value of \f$u\f$ @param A a place where the result will be stored. 
    8585                virtual void dfdx_cond ( const vec &x0, const vec &u0, mat &A , bool full=true ) {}; 
    86                 //! Evaluates \f$A=\frac{d}{du}f(x,u)|_{x0,u0}\f$ and writes result into \c A . @param full denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed.        @param x0 numeric value of $x$, @param u0 numeric value of $u$ @param A a place where the result will be stored. 
     86                //! Evaluates \f$A=\frac{d}{du}f(x,u)|_{x0,u0}\f$ and writes result into \c A . @param full denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed.        @param x0 numeric value of \f$x\f$, @param u0 numeric value of \f$u\f$ @param A a place where the result will be stored. 
    8787                virtual void dfdu_cond ( const vec &x0, const vec &u0, mat &A, bool full=true ) {}; 
    8888                //!Default constructor (dimy is not set!) 
    … …  
    9494}; 
    9595 
    96 //! Class representing function $f(x,u) = Ax+Bu$ 
     96//! Class representing function \f$f(x,u) = Ax+Bu\f$ 
    9797//TODO can be generalized into multilinear form! 
    9898class bilinfn: public diffbifn