UniformNoise Class Reference

Generates pseudo-random uniformly distributed noise for simulating the Process. More...

#include <uniform_noise.hpp>

Inheritance diagram for UniformNoise:

Public Member Functions
virtual UniformNoise *	clone () const
virtual UniformNoise *	clone (uint idx) const
const DVector &	getLowerLimit () const
const DVector &	getUpperLimit () const
virtual returnValue	init (uint seed=0)
UniformNoise &	operator= (const UniformNoise &rhs)
returnValue	setLimit (uint idx, double _lowerLimit, double _upperLimit)
returnValue	setLimits (const DVector &_lowerLimit, const DVector &_upperLimit)
returnValue	setLimits (double _lowerLimit, double _upperLimit)
virtual returnValue	step (DVector &_w)
virtual returnValue	step (VariablesGrid &_w)
	UniformNoise ()
	UniformNoise (const DVector &_lowerLimit, const DVector &_upperLimit)
	UniformNoise (uint _dim, double _lowerLimit, double _upperLimit)
	UniformNoise (const UniformNoise &rhs)
virtual	~UniformNoise ()
Public Member Functions inherited from Noise
uint	getDim () const
BlockStatus	getStatus () const
BooleanType	isEmpty () const
	Noise ()
	Noise (const Noise &rhs)
Noise &	operator= (const Noise &rhs)
virtual	~Noise ()

Protected Attributes
DVector	lowerLimit
DVector	upperLimit
Protected Attributes inherited from Noise
BlockStatus	status
VariablesGrid	w

Additional Inherited Members
Protected Member Functions inherited from Noise
double	getUniformRandomNumber (double _lowerLimit, double _upperLimit) const
returnValue	setStatus (BlockStatus _status)

Detailed Description

Generates pseudo-random uniformly distributed noise for simulating the Process.

The class UniformNoise generates pseudo-random uniformly distributed noise for simulating the Process within the SimulationEnvironment.

Author

Hans Joachim Ferreau, Boris Houska

Definition at line 53 of file uniform_noise.hpp.

Constructor & Destructor Documentation

UniformNoise() [1/4]

BEGIN_NAMESPACE_ACADO UniformNoise::UniformNoise

(

)

Default constructor.

Definition at line 45 of file uniform_noise.cpp.

UniformNoise() [2/4]

UniformNoise::UniformNoise	(	const DVector &	_lowerLimit,
		const DVector &	_upperLimit
	)

Constructor which takes lower and upper limits of the random variable. The dimension of these limit vector determine the dimension of the random variable.

Parameters

[in]	_lowerLimit	Lower limit for each component.
[in]	_upperLimit	Upper limit for each component.

Definition at line 50 of file uniform_noise.cpp.

UniformNoise() [3/4]

UniformNoise::UniformNoise	(	uint	_dim,
		double	_lowerLimit,
		double	_upperLimit
	)

Constructor which takes the dimension of the random variable as well as as common values for the lower and upper limits of all components.

Parameters

[in]	_dim	Dimension of random variable.
[in]	_lowerLimit	Common lower limit for all components.
[in]	_upperLimit	Common upper limit for all components.

Definition at line 65 of file uniform_noise.cpp.

UniformNoise() [4/4]

UniformNoise::UniformNoise

(

const UniformNoise &

rhs

)

Copy constructor (deep copy).

@param[in] rhs      Right-hand side object.

Definition at line 82 of file uniform_noise.cpp.

~UniformNoise()

UniformNoise::~UniformNoise ( )

virtual

Destructor.

Definition at line 89 of file uniform_noise.cpp.

Member Function Documentation

clone() [1/2]

UniformNoise * UniformNoise::clone ( ) const

virtual

Clone constructor (deep copy).

\return Pointer to deep copy of base class type

Implements Noise.

Definition at line 108 of file uniform_noise.cpp.

clone() [2/2]

UniformNoise * UniformNoise::clone ( uint  idx ) const

virtual

Clone constructor for a given noise component (deep copy).

@param[in] idx              Right-hand side object.

\return Pointer to deep copy of base class type

Implements Noise.

Definition at line 114 of file uniform_noise.cpp.

getLowerLimit()

const DVector& UniformNoise::getLowerLimit ( ) const

inline

Returns lower limits of the random variable.

\return Lower limits of the random variable

getUpperLimit()

const DVector& UniformNoise::getUpperLimit ( ) const

inline

Returns upper limits of the random variable.

\return Upper limits of the random variable

init()

returnValue UniformNoise::init ( uint  seed = 0 )

virtual

Initializes noise generation and performs a couple of consistency checks. Initialization of the pseudo-random number generator can be based on a seed in order to allow exact reproduction of generated noise. If seed is not specified (i.e. 0), a seed is obtain from the system clock.

Parameters

[in]

seed

Seed for pseudo-random number generator.

Returns

SUCCESSFUL_RETURN,
RET_INVALID_NOISE_SETTINGS,
RET_NO_NOISE_SETTINGS

Implements Noise.

Definition at line 188 of file uniform_noise.cpp.

operator=()

UniformNoise & UniformNoise::operator=

(

const UniformNoise &

rhs

)

Assignment Operator (deep copy)

@param[in] rhs      Right-hand side object.

Definition at line 94 of file uniform_noise.cpp.

setLimit()

returnValue UniformNoise::setLimit	(	uint	idx,
		double	_lowerLimit,
		double	_upperLimit
	)

Assigns new lower and upper limit on the component of the random variable with given index.

Parameters

[in]	idx	Index of component.
[in]	_lowerLimit	New lower limit.
[in]	_upperLimit	New upper limit.

Returns

SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS,
RET_INVALID_ARGUMENTS

Definition at line 169 of file uniform_noise.cpp.

setLimits() [1/2]

returnValue UniformNoise::setLimits	(	const DVector &	_lowerLimit,
		const DVector &	_upperLimit
	)

Assigns new lower and upper limits on the random variable.

@param[in] _lowerLimit              New lower limits for each component.
@param[in] _upperLimit              New upper limits for each component.

\return SUCCESSFUL_RETURN, \n
        RET_VECTOR_DIMENSION_MISMATCH, \n
        RET_INVALID_ARGUMENTS

Definition at line 131 of file uniform_noise.cpp.

setLimits() [2/2]

returnValue UniformNoise::setLimits	(	double	_lowerLimit,
		double	_upperLimit
	)

Assigns new lower and upper limits on the random variable.

@param[in] _lowerLimit              New common lower limit for all components.
@param[in] _upperLimit              New common upper limit for all components.

\return SUCCESSFUL_RETURN, \n
        RET_INVALID_ARGUMENTS

Definition at line 152 of file uniform_noise.cpp.

step() [1/2]

returnValue UniformNoise::step ( DVector &  _w )

virtual

Generates a single noise vector based on current internal settings.

@param[out] _w              Generated noise vector.

Returns

SUCCESSFUL_RETURN,
RET_BLOCK_NOT_READY,
RET_VECTOR_DIMENSION_MISMATCH

Implements Noise.

Definition at line 209 of file uniform_noise.cpp.

step() [2/2]

returnValue UniformNoise::step ( VariablesGrid &  _w )

virtual

Generates a noise vector sequence based on current internal settings. Noise is generated for each grid point of the VariablesGrid passed.

Parameters

[in,out]

_w

Generated noise vector sequence.

Returns

SUCCESSFUL_RETURN,
RET_BLOCK_NOT_READY,
RET_VECTOR_DIMENSION_MISMATCH

Implements Noise.

Definition at line 230 of file uniform_noise.cpp.

Member Data Documentation

lowerLimit

DVector UniformNoise::lowerLimit

protected

Lower limit for each component.

Definition at line 229 of file uniform_noise.hpp.

upperLimit

DVector UniformNoise::upperLimit

protected

Upper limit for each component.

Definition at line 230 of file uniform_noise.hpp.

---

The documentation for this class was generated from the following files:

• uniform_noise.hpp
• uniform_noise.cpp