ColoredNoise Class Reference

Generates pseudo-random colored noise for simulating the Process. More...

#include <colored_noise.hpp>

Inheritance diagram for ColoredNoise:

Public Member Functions
virtual ColoredNoise *	clone () const
virtual ColoredNoise *	clone (uint idx) const
	ColoredNoise ()
	ColoredNoise (const DynamicSystem &_dynamicSystem)
	ColoredNoise (const ColoredNoise &rhs)
virtual returnValue	init (uint seed=0)
ColoredNoise &	operator= (const ColoredNoise &rhs)
returnValue	setDynamicSystem (const DynamicSystem &_dynamicSystem)
virtual returnValue	step (DVector &_w)
virtual returnValue	step (VariablesGrid &_w)
virtual	~ColoredNoise ()
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
DynamicSystem *	dynamicSystem
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 colored noise for simulating the Process.

The class ColoredNoise generates pseudo-random colored noise for simulating the Process within the SimulationEnvironment.

Note

NOT YET OPERATIONAL!

Author

Hans Joachim Ferreau, Boris Houska

Definition at line 57 of file colored_noise.hpp.

Constructor & Destructor Documentation

ColoredNoise() [1/3]

BEGIN_NAMESPACE_ACADO ColoredNoise::ColoredNoise

(

)

Default constructor.

Definition at line 42 of file colored_noise.cpp.

ColoredNoise() [2/3]

ColoredNoise::ColoredNoise

(

const DynamicSystem &

_dynamicSystem

)

Constructor that takes dimension of noise vector.

Definition at line 48 of file colored_noise.cpp.

ColoredNoise() [3/3]

ColoredNoise::ColoredNoise

(

const ColoredNoise &

rhs

)

Copy constructor (deep copy).

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

Definition at line 55 of file colored_noise.cpp.

~ColoredNoise()

ColoredNoise::~ColoredNoise ( )

virtual

Destructor.

Definition at line 64 of file colored_noise.cpp.

Member Function Documentation

clone() [1/2]

ColoredNoise * ColoredNoise::clone ( ) const

virtual

Clone constructor (deep copy).

\return Pointer to deep copy of base class type

Implements Noise.

Definition at line 90 of file colored_noise.cpp.

clone() [2/2]

ColoredNoise * ColoredNoise::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 96 of file colored_noise.cpp.

init()

returnValue ColoredNoise::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 119 of file colored_noise.cpp.

operator=()

ColoredNoise & ColoredNoise::operator=

(

const ColoredNoise &

rhs

)

Assignment Operator (deep copy)

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

Definition at line 71 of file colored_noise.cpp.

setDynamicSystem()

returnValue ColoredNoise::setDynamicSystem

(

const DynamicSystem &

_dynamicSystem

)

Assigns a new dynamic system for generating the colored noise.

\return SUCCESFUL_RETURN

Definition at line 106 of file colored_noise.cpp.

step() [1/2]

returnValue ColoredNoise::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 129 of file colored_noise.cpp.

step() [2/2]

returnValue ColoredNoise::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 137 of file colored_noise.cpp.

Member Data Documentation

dynamicSystem

DynamicSystem* ColoredNoise::dynamicSystem

protected

Dynamic system generating the colored noise.

Definition at line 166 of file colored_noise.hpp.

---

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

• colored_noise.hpp
• colored_noise.cpp