noise.hpp
Go to the documentation of this file.
00001 /*
00002  *    This file is part of ACADO Toolkit.
00003  *
00004  *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
00005  *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
00006  *    Milan Vukov, Rien Quirynen, KU Leuven.
00007  *    Developed within the Optimization in Engineering Center (OPTEC)
00008  *    under supervision of Moritz Diehl. All rights reserved.
00009  *
00010  *    ACADO Toolkit is free software; you can redistribute it and/or
00011  *    modify it under the terms of the GNU Lesser General Public
00012  *    License as published by the Free Software Foundation; either
00013  *    version 3 of the License, or (at your option) any later version.
00014  *
00015  *    ACADO Toolkit is distributed in the hope that it will be useful,
00016  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  *    Lesser General Public License for more details.
00019  *
00020  *    You should have received a copy of the GNU Lesser General Public
00021  *    License along with ACADO Toolkit; if not, write to the Free Software
00022  *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00023  *
00024  */
00025 
00026 
00033 #ifndef ACADO_TOOLKIT_NOISE_HPP
00034 #define ACADO_TOOLKIT_NOISE_HPP
00035 
00036 
00037 #include <acado/utils/acado_utils.hpp>
00038 
00039 #include <acado/matrix_vector/matrix_vector.hpp>
00040 #include <acado/variables_grid/variables_grid.hpp>
00041 
00042 
00043 BEGIN_NAMESPACE_ACADO
00044 
00045 
00056 class Noise
00057 {
00058         //
00059         //  PUBLIC MEMBER FUNCTIONS:
00060         //
00061         public:
00062 
00065                 Noise( );
00066 
00071                 Noise(  const Noise& rhs
00072                                 );
00073 
00076                 virtual ~Noise( );
00077 
00082                 Noise& operator=(       const Noise& rhs
00083                                                         );
00084 
00089         virtual Noise* clone( ) const = 0;
00090 
00097         virtual Noise* clone(   uint idx
00098                                                                 ) const = 0;
00099 
00100 
00112                 virtual returnValue init(       uint seed = 0
00113                                                                         ) = 0;
00114 
00123                 virtual returnValue step(       DVector& _w
00124                                                                         ) = 0;
00125 
00135                 virtual returnValue step(       VariablesGrid& _w
00136                                                                         ) = 0;
00137 
00138 
00143                 inline uint getDim( ) const;
00144 
00150                 inline BooleanType isEmpty( ) const;
00151 
00152 
00157                 inline BlockStatus getStatus( ) const;
00158 
00159 
00160 
00161         //
00162         //  PROTECTED MEMBER FUNCTIONS:
00163         //
00164         protected:
00165 
00172                 inline returnValue setStatus(   BlockStatus _status
00173                                                                                 );
00174 
00183                 inline double getUniformRandomNumber(   double _lowerLimit,
00184                                                                                                 double _upperLimit
00185                                                                                                 ) const;
00186 
00187 
00188         //
00189         //  PROTECTED MEMBERS:
00190         //
00191         protected:
00192                 BlockStatus status;                             
00194                 VariablesGrid w;                                
00195 };
00196 
00197 
00198 CLOSE_NAMESPACE_ACADO
00199 
00200 
00201 #include <acado/noise/noise.ipp>
00202 
00203 
00204 #include <acado/noise/uniform_noise.hpp>
00205 #include <acado/noise/gaussian_noise.hpp>
00206 #include <acado/noise/colored_noise.hpp>
00207 
00208 
00209 #endif  // ACADO_TOOLKIT_NOISE_HPP
00210 
00211 
00212 /*
00213  *      end of file
00214  */


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 11:59:22