Base class for generating pseudo-random noise for simulating the Process. More...
#include <noise.hpp>
Public Member Functions | |
| virtual Noise * | clone () const =0 |
| virtual Noise * | clone (uint idx) const =0 |
| uint | getDim () const |
| BlockStatus | getStatus () const |
| virtual returnValue | init (uint seed=0)=0 |
| BooleanType | isEmpty () const |
| Noise () | |
| Noise (const Noise &rhs) | |
| Noise & | operator= (const Noise &rhs) |
| virtual returnValue | step (DVector &_w)=0 |
| virtual returnValue | step (VariablesGrid &_w)=0 |
| virtual | ~Noise () |
Protected Member Functions | |
| double | getUniformRandomNumber (double _lowerLimit, double _upperLimit) const |
| returnValue | setStatus (BlockStatus _status) |
Protected Attributes | |
| BlockStatus | status |
| VariablesGrid | w |
Detailed Description
Base class for generating pseudo-random noise for simulating the Process.
The class Noise serves as base class for generating pseudo-random noise for simulating the Process within the SimulationEnvironment.
Constructor & Destructor Documentation
| Noise::Noise | ( | const Noise & | rhs | ) |
| Noise::~Noise | ( | ) | [virtual] |
Member Function Documentation
| virtual Noise* Noise::clone | ( | ) | const [pure virtual] |
Clone constructor (deep copy).
- Returns:
- Pointer to deep copy of base class type
Implemented in GaussianNoise, UniformNoise, and ColoredNoise.
| virtual Noise* Noise::clone | ( | uint | idx | ) | const [pure virtual] |
Clone constructor for a given noise component (deep copy).
- Parameters:
-
[in] idx Right-hand side object.
- Returns:
- Pointer to deep copy of base class type
Implemented in GaussianNoise, UniformNoise, and ColoredNoise.
| uint Noise::getDim | ( | ) | const [inline] |
Returns dimension of noise vector.
- Returns:
- Dimension of noise vector
| BlockStatus Noise::getStatus | ( | ) | const [inline] |
Returns current status of noise block, see documentation of BlockStatus for details.
- Returns:
- Current status of noise block
| double Noise::getUniformRandomNumber | ( | double | _lowerLimit, |
| double | _upperLimit | ||
| ) | const [inline, protected] |
Returns a pseudo-random number based on a uniform distribution with given lower and upper limits.
- Parameters:
-
[in] _lowerLimit Lower limit of random variable. [in] _upperLimit Lower limit of random variable.
- Returns:
- Uniformly distributed pseudo-random number
| virtual returnValue Noise::init | ( | uint | seed = 0 | ) | [pure 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
Implemented in GaussianNoise, UniformNoise, and ColoredNoise.
| BooleanType Noise::isEmpty | ( | ) | const [inline] |
Returns whether noise vector is empty (i.e. has dimension zero).
- Returns:
- BT_TRUE iff noise vector is empty,
BT_FALSE otherwise
| returnValue Noise::setStatus | ( | BlockStatus | _status | ) | [inline, protected] |
Assigns new status to noise block
- Parameters:
-
[in] _status New status.
- Returns:
- SUCCESSFUL_RETURN
| virtual returnValue Noise::step | ( | DVector & | _w | ) | [pure virtual] |
Generates a single noise vector based on current internal settings.
- Parameters:
-
[out] _w Generated noise vector.
- Returns:
- SUCCESSFUL_RETURN,
RET_BLOCK_NOT_READY,
RET_VECTOR_DIMENSION_MISMATCH
Implemented in GaussianNoise, UniformNoise, and ColoredNoise.
| virtual returnValue Noise::step | ( | VariablesGrid & | _w | ) | [pure 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
Implemented in GaussianNoise, UniformNoise, and ColoredNoise.
Member Data Documentation
BlockStatus Noise::status [protected] |
VariablesGrid Noise::w [protected] |
The documentation for this class was generated from the following files: