Eclipse SUMO - Simulation of Urban MObility
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
LogitCalculator< R, E, V > Class Template Reference

Cost calculation with c-logit or logit method. More...

#include <LogitCalculator.h>

Inheritance diagram for LogitCalculator< R, E, V >:
Collaboration diagram for LogitCalculator< R, E, V >:

Public Member Functions

void calculateProbabilities (std::vector< R * > alternatives, const V *const veh, const SUMOTime time)
 calculate the probabilities in the logit model More...
 
int getMaxRouteNumber () const
 
bool keepRoutes () const
 
 LogitCalculator (const double beta, const double gamma, const double theta)
 Constructor. More...
 
void setCosts (R *route, const double costs, const bool) const
 
bool skipRouteCalculation () const
 
virtual ~LogitCalculator ()
 Destructor. More...
 

Static Public Member Functions

static void cleanup ()
 
static RouteCostCalculator< R, E, V > & getCalculator ()
 

Private Member Functions

double getBetaForCLogit (const std::vector< R * > alternatives) const
 calculate the scaling factor in the logit model More...
 
double getThetaForCLogit (const std::vector< R * > alternatives) const
 calculate the scaling factor in the logit model More...
 
LogitCalculator & operator= (const LogitCalculator &s)
 invalidated assignment operator More...
 

Private Attributes

const double myBeta
 logit beta - value More...
 
std::map< const R *, double > myCommonalities
 The route commonality factors for c-logit. More...
 
const double myGamma
 logit gamma - value More...
 
bool myKeepRoutes
 Information whether all routes should be saved. More...
 
int myMaxRouteNumber
 The maximum route alternatives number. More...
 
bool mySkipRouteCalculation
 Information whether new routes should be calculated. More...
 
const double myTheta
 logit theta - value More...
 

Static Private Attributes

static RouteCostCalculator * myInstance = 0
 

Detailed Description

template<class R, class E, class V>
class LogitCalculator< R, E, V >

Cost calculation with c-logit or logit method.

Definition at line 39 of file LogitCalculator.h.

Constructor & Destructor Documentation

◆ LogitCalculator()

template<class R , class E , class V >
LogitCalculator< R, E, V >::LogitCalculator ( const double  beta,
const double  gamma,
const double  theta 
)
inline

Constructor.

Definition at line 42 of file LogitCalculator.h.

◆ ~LogitCalculator()

template<class R , class E , class V >
virtual LogitCalculator< R, E, V >::~LogitCalculator ( )
inlinevirtual

Destructor.

Definition at line 46 of file LogitCalculator.h.

Member Function Documentation

◆ calculateProbabilities()

template<class R , class E , class V >
void LogitCalculator< R, E, V >::calculateProbabilities ( std::vector< R * >  alternatives,
const V *const  veh,
const SUMOTime  time 
)
inlinevirtual

calculate the probabilities in the logit model

Implements RouteCostCalculator< R, E, V >.

Definition at line 53 of file LogitCalculator.h.

References LogitCalculator< R, E, V >::getBetaForCLogit(), LogitCalculator< R, E, V >::getThetaForCLogit(), LogitCalculator< R, E, V >::myBeta, LogitCalculator< R, E, V >::myCommonalities, LogitCalculator< R, E, V >::myGamma, LogitCalculator< R, E, V >::myTheta, and STEPS2TIME.

◆ cleanup()

template<class R, class E, class V>
static void RouteCostCalculator< R, E, V >::cleanup ( )
inlinestaticinherited

Definition at line 47 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::myInstance.

Referenced by RONet::cleanup().

◆ getBetaForCLogit()

template<class R , class E , class V >
double LogitCalculator< R, E, V >::getBetaForCLogit ( const std::vector< R * >  alternatives) const
inlineprivate

calculate the scaling factor in the logit model

Definition at line 97 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

◆ getCalculator()

template<class R , class E , class V >
RouteCostCalculator< R, E, V > & RouteCostCalculator< R, E, V >::getCalculator ( )
staticinherited

Definition at line 107 of file RouteCostCalculator.h.

References OptionsCont::getFloat(), OptionsCont::getOptions(), and OptionsCont::getString().

Referenced by RORouteDef::addAlternative(), RORouteDef::preComputeCurrentRoute(), and ROMAAssignments::sue().

◆ getMaxRouteNumber()

template<class R, class E, class V>
int RouteCostCalculator< R, E, V >::getMaxRouteNumber ( ) const
inlineinherited

Definition at line 57 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::myMaxRouteNumber.

◆ getThetaForCLogit()

template<class R , class E , class V >
double LogitCalculator< R, E, V >::getThetaForCLogit ( const std::vector< R * >  alternatives) const
inlineprivate

calculate the scaling factor in the logit model

Definition at line 109 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

◆ keepRoutes()

template<class R, class E, class V>
bool RouteCostCalculator< R, E, V >::keepRoutes ( ) const
inlineinherited

Definition at line 61 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::myKeepRoutes.

Referenced by RORouteDef::addAlternative().

◆ operator=()

template<class R , class E , class V >
LogitCalculator& LogitCalculator< R, E, V >::operator= ( const LogitCalculator< R, E, V > &  s)
private

invalidated assignment operator

◆ setCosts()

template<class R , class E , class V >
void LogitCalculator< R, E, V >::setCosts ( R *  route,
const double  costs,
const bool   
) const
inlinevirtual

Implements RouteCostCalculator< R, E, V >.

Definition at line 48 of file LogitCalculator.h.

◆ skipRouteCalculation()

template<class R, class E, class V>
bool RouteCostCalculator< R, E, V >::skipRouteCalculation ( ) const
inlineinherited

Definition at line 65 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::mySkipRouteCalculation.

Field Documentation

◆ myBeta

template<class R , class E , class V >
const double LogitCalculator< R, E, V >::myBeta
private

logit beta - value

Definition at line 136 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

◆ myCommonalities

template<class R , class E , class V >
std::map<const R*, double> LogitCalculator< R, E, V >::myCommonalities
private

The route commonality factors for c-logit.

Definition at line 145 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

◆ myGamma

template<class R , class E , class V >
const double LogitCalculator< R, E, V >::myGamma
private

logit gamma - value

Definition at line 139 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

◆ myInstance

template<class R, class E, class V>
RouteCostCalculator< R, E, V > * RouteCostCalculator< R, E, V >::myInstance = 0
staticprivateinherited

Definition at line 82 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::cleanup().

◆ myKeepRoutes

template<class R, class E, class V>
bool RouteCostCalculator< R, E, V >::myKeepRoutes
privateinherited

Information whether all routes should be saved.

Definition at line 88 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::keepRoutes(), and RouteCostCalculator< R, E, V >::RouteCostCalculator().

◆ myMaxRouteNumber

template<class R, class E, class V>
int RouteCostCalculator< R, E, V >::myMaxRouteNumber
privateinherited

The maximum route alternatives number.

Definition at line 85 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::getMaxRouteNumber(), and RouteCostCalculator< R, E, V >::RouteCostCalculator().

◆ mySkipRouteCalculation

template<class R, class E, class V>
bool RouteCostCalculator< R, E, V >::mySkipRouteCalculation
privateinherited

Information whether new routes should be calculated.

Definition at line 91 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::RouteCostCalculator(), and RouteCostCalculator< R, E, V >::skipRouteCalculation().

◆ myTheta

template<class R , class E , class V >
const double LogitCalculator< R, E, V >::myTheta
private

logit theta - value

Definition at line 142 of file LogitCalculator.h.

Referenced by LogitCalculator< R, E, V >::calculateProbabilities().

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