SUMO - Simulation of Urban MObility
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes
OUProcess Class Reference

An Ornstein-Uhlenbeck stochastic process. More...

#include <MSDriverState.h>

Collaboration diagram for OUProcess:
Collaboration graph

Public Member Functions

double getNoiseIntensity () const
 
double getState () const
 Obtain the current state of the process. More...
 
double getTimeScale () const
 
 OUProcess (double initialState, double timeScale, double noiseIntensity)
 constructor More...
 
void setNoiseIntensity (double noiseIntensity)
 set the process' noise intensity to a new value More...
 
void setState (double state)
 set the process' state to a new value More...
 
void setTimeScale (double timeScale)
 set the process' timescale to a new value More...
 
void step (double dt)
 evolve for a time step of length dt. More...
 
 ~OUProcess ()
 destructor More...
 

Static Public Member Functions

static std::mt19937 * getRNG ()
 

Private Attributes

double myNoiseIntensity
 The noise intensity of the process. More...
 
double myState
 The current state of the process. More...
 
double myTimeScale
 The time scale of the process. More...
 

Static Private Attributes

static std::mt19937 myRNG
 Random generator for OUProcesses. More...
 

Detailed Description

An Ornstein-Uhlenbeck stochastic process.

Todo:
: check parameter admissibility in setter methods

Definition at line 51 of file MSDriverState.h.

Constructor & Destructor Documentation

◆ OUProcess()

OUProcess::OUProcess ( double  initialState,
double  timeScale,
double  noiseIntensity 
)

constructor

Definition at line 94 of file MSDriverState.cpp.

◆ ~OUProcess()

OUProcess::~OUProcess ( )

destructor

Definition at line 100 of file MSDriverState.cpp.

Member Function Documentation

◆ getNoiseIntensity()

double OUProcess::getNoiseIntensity ( ) const
inline

Definition at line 76 of file MSDriverState.h.

References myNoiseIntensity.

◆ getRNG()

static std::mt19937* OUProcess::getRNG ( )
inlinestatic

Definition at line 89 of file MSDriverState.h.

References myRNG.

Referenced by MSStateHandler::myStartElement(), and MSStateHandler::saveRNGs().

◆ getState()

double OUProcess::getState ( ) const

Obtain the current state of the process.

Definition at line 116 of file MSDriverState.cpp.

References myState.

Referenced by MSSimpleDriverState::getPerceivedHeadway(), MSSimpleDriverState::getPerceivedSpeedDifference(), getTimeScale(), and MSSimpleDriverState::update().

◆ getTimeScale()

double OUProcess::getTimeScale ( ) const
inline

Definition at line 80 of file MSDriverState.h.

References getState(), and myTimeScale.

◆ setNoiseIntensity()

void OUProcess::setNoiseIntensity ( double  noiseIntensity)
inline

set the process' noise intensity to a new value

Definition at line 67 of file MSDriverState.h.

References myNoiseIntensity.

Referenced by MSSimpleDriverState::updateError().

◆ setState()

void OUProcess::setState ( double  state)
inline

set the process' state to a new value

Definition at line 72 of file MSDriverState.h.

References myState.

Referenced by MSSimpleDriverState::setAwareness(), and MSSimpleDriverState::updateError().

◆ setTimeScale()

void OUProcess::setTimeScale ( double  timeScale)
inline

set the process' timescale to a new value

Definition at line 62 of file MSDriverState.h.

References myTimeScale.

Referenced by MSSimpleDriverState::updateError().

◆ step()

void OUProcess::step ( double  dt)

evolve for a time step of length dt.

Definition at line 104 of file MSDriverState.cpp.

References myNoiseIntensity, myRNG, myState, myTimeScale, and RandHelper::randNorm().

Referenced by MSSimpleDriverState::updateError().

Field Documentation

◆ myNoiseIntensity

double OUProcess::myNoiseIntensity
private

The noise intensity of the process.

Definition at line 104 of file MSDriverState.h.

Referenced by getNoiseIntensity(), setNoiseIntensity(), and step().

◆ myRNG

std::mt19937 OUProcess::myRNG
staticprivate

Random generator for OUProcesses.

Definition at line 107 of file MSDriverState.h.

Referenced by getRNG(), and step().

◆ myState

double OUProcess::myState
private

The current state of the process.

Definition at line 96 of file MSDriverState.h.

Referenced by getState(), setState(), and step().

◆ myTimeScale

double OUProcess::myTimeScale
private

The time scale of the process.

Definition at line 100 of file MSDriverState.h.

Referenced by getTimeScale(), setTimeScale(), and step().

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