uniform_noise.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of ACADO Toolkit.
3  *
4  * ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
5  * Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
6  * Milan Vukov, Rien Quirynen, KU Leuven.
7  * Developed within the Optimization in Engineering Center (OPTEC)
8  * under supervision of Moritz Diehl. All rights reserved.
9  *
10  * ACADO Toolkit is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 3 of the License, or (at your option) any later version.
14  *
15  * ACADO Toolkit is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with ACADO Toolkit; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 
33 #ifndef ACADO_TOOLKIT_UNIFORM_NOISE_HPP
34 #define ACADO_TOOLKIT_UNIFORM_NOISE_HPP
35 
36 
37 #include <acado/noise/noise.hpp>
38 
39 
41 
42 
53 class UniformNoise : public Noise
54 {
55  //
56  // PUBLIC MEMBER FUNCTIONS:
57  //
58 
59  public:
60 
63  UniformNoise( );
64 
72  UniformNoise( const DVector& _lowerLimit,
73  const DVector& _upperLimit
74  );
75 
83  UniformNoise( uint _dim,
84  double _lowerLimit,
85  double _upperLimit
86  );
87 
93  );
94 
97  virtual ~UniformNoise( );
98 
103  UniformNoise& operator=( const UniformNoise& rhs
104  );
105 
110  virtual UniformNoise* clone( ) const;
111 
118  virtual UniformNoise* clone( uint idx
119  ) const;
120 
121 
131  returnValue setLimits( const DVector& _lowerLimit,
132  const DVector& _upperLimit
133  );
134 
143  returnValue setLimits( double _lowerLimit,
144  double _upperLimit
145  );
146 
159  double _lowerLimit,
160  double _upperLimit
161  );
162 
163 
175  virtual returnValue init( uint seed = 0
176  );
177 
178 
188  virtual returnValue step( DVector& _w
189  );
190 
200  virtual returnValue step( VariablesGrid& _w
201  );
202 
203 
208  inline const DVector& getLowerLimit( ) const;
209 
214  inline const DVector& getUpperLimit( ) const;
215 
216 
217 
218  //
219  // PROTECTED MEMBER FUNCTIONS:
220  //
221  protected:
222 
223 
224  //
225  // PROTECTED MEMBERS:
226  //
227  protected:
228 
231 };
232 
233 
235 
236 
237 
238 #include <acado/noise/uniform_noise.ipp>
239 
240 
241 #endif // ACADO_TOOLKIT_UNIFORM_NOISE_HPP
242 
243 
244 /*
245  * end of file
246  */
virtual ~UniformNoise()
returnValue setLimit(uint idx, double _lowerLimit, double _upperLimit)
Provides a time grid consisting of vector-valued optimization variables at each grid point...
Allows to pass back messages to the calling function.
virtual returnValue init(uint seed=0)
Base class for generating pseudo-random noise for simulating the Process.
Definition: noise.hpp:56
BEGIN_NAMESPACE_ACADO typedef unsigned int uint
Definition: acado_types.hpp:42
Generates pseudo-random uniformly distributed noise for simulating the Process.
DVector upperLimit
#define CLOSE_NAMESPACE_ACADO
virtual returnValue step(DVector &_w)
const DVector & getLowerLimit() const
void rhs(const real_t *x, real_t *f)
returnValue setLimits(const DVector &_lowerLimit, const DVector &_upperLimit)
DVector lowerLimit
virtual UniformNoise * clone() const
const DVector & getUpperLimit() const
#define BEGIN_NAMESPACE_ACADO
UniformNoise & operator=(const UniformNoise &rhs)


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:15