noise.hpp

Go to the documentation of this file.

/*
 *    This file is part of ACADO Toolkit.
 *
 *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
 *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
 *    Milan Vukov, Rien Quirynen, KU Leuven.
 *    Developed within the Optimization in Engineering Center (OPTEC)
 *    under supervision of Moritz Diehl. All rights reserved.
 *
 *    ACADO Toolkit is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    ACADO Toolkit is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with ACADO Toolkit; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */


#ifndef ACADO_TOOLKIT_NOISE_HPP
#define ACADO_TOOLKIT_NOISE_HPP


#include <acado/utils/acado_utils.hpp>

#include <acado/matrix_vector/matrix_vector.hpp>
#include <acado/variables_grid/variables_grid.hpp>


BEGIN_NAMESPACE_ACADO


class Noise
{
        //
        //  PUBLIC MEMBER FUNCTIONS:
        //
        public:

                Noise( );

                Noise(  const Noise& rhs
                                );

                virtual ~Noise( );

                Noise& operator=(       const Noise& rhs
                                                        );

        virtual Noise* clone( ) const = 0;

        virtual Noise* clone(   uint idx
                                                                ) const = 0;


                virtual returnValue init(       uint seed = 0
                                                                        ) = 0;

                virtual returnValue step(       DVector& _w
                                                                        ) = 0;

                virtual returnValue step(       VariablesGrid& _w
                                                                        ) = 0;


                inline uint getDim( ) const;

                inline BooleanType isEmpty( ) const;


                inline BlockStatus getStatus( ) const;



        //
        //  PROTECTED MEMBER FUNCTIONS:
        //
        protected:

                inline returnValue setStatus(   BlockStatus _status
                                                                                );

                inline double getUniformRandomNumber(   double _lowerLimit,
                                                                                                double _upperLimit
                                                                                                ) const;


        //
        //  PROTECTED MEMBERS:
        //
        protected:
                BlockStatus status;                             
                VariablesGrid w;                                
};


CLOSE_NAMESPACE_ACADO


#include <acado/noise/noise.ipp>


#include <acado/noise/uniform_noise.hpp>
#include <acado/noise/gaussian_noise.hpp>
#include <acado/noise/colored_noise.hpp>


#endif  // ACADO_TOOLKIT_NOISE_HPP


/*
 *      end of file
 */