Public Member Functions | Protected Attributes

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

#include <colored_noise.hpp>

Inheritance diagram for ColoredNoise:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ColoredNoiseclone () const
virtual ColoredNoiseclone (uint idx) const
 ColoredNoise ()
 ColoredNoise (const DynamicSystem &_dynamicSystem)
 ColoredNoise (const ColoredNoise &rhs)
virtual returnValue init (uint seed=0)
ColoredNoiseoperator= (const ColoredNoise &rhs)
returnValue setDynamicSystem (const DynamicSystem &_dynamicSystem)
virtual returnValue step (DVector &_w)
virtual returnValue step (VariablesGrid &_w)
virtual ~ColoredNoise ()

Protected Attributes

DynamicSystemdynamicSystem

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

Default constructor.

Definition at line 42 of file colored_noise.cpp.

ColoredNoise::ColoredNoise ( const DynamicSystem _dynamicSystem)

Constructor that takes dimension of noise vector.

Definition at line 48 of file colored_noise.cpp.

Copy constructor (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 55 of file colored_noise.cpp.

Destructor.

Definition at line 64 of file colored_noise.cpp.


Member Function Documentation

ColoredNoise * ColoredNoise::clone ( ) const [virtual]

Clone constructor (deep copy).

Returns:
Pointer to deep copy of base class type

Implements Noise.

Definition at line 90 of file colored_noise.cpp.

ColoredNoise * ColoredNoise::clone ( uint  idx) const [virtual]

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

Parameters:
[in]idxRight-hand side object.
Returns:
Pointer to deep copy of base class type

Implements Noise.

Definition at line 96 of file colored_noise.cpp.

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]seedSeed 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.

ColoredNoise & ColoredNoise::operator= ( const ColoredNoise rhs)

Assignment Operator (deep copy)

Parameters:
[in]rhsRight-hand side object.

Definition at line 71 of file colored_noise.cpp.

Assigns a new dynamic system for generating the colored noise.

Returns:
SUCCESFUL_RETURN

Definition at line 106 of file colored_noise.cpp.

returnValue ColoredNoise::step ( DVector _w) [virtual]

Generates a single noise vector based on current internal settings.

Parameters:
[out]_wGenerated noise vector.
Returns:
SUCCESSFUL_RETURN,
RET_BLOCK_NOT_READY,
RET_VECTOR_DIMENSION_MISMATCH

Implements Noise.

Definition at line 129 of file colored_noise.cpp.

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

Parameters:
[in,out]_wGenerated 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

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:


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23