Eclipse SUMO - Simulation of Urban MObility
RouteCostCalculator.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2002-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
16 // Calculators for route costs and probabilities
17 /****************************************************************************/
18 #ifndef RouteCostCalculator_h
19 #define RouteCostCalculator_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <vector>
28 #include <map>
29 #include <cmath>
30 #include <utils/common/StdDefs.h>
31 #include <utils/common/SUMOTime.h>
33 
34 
35 // ===========================================================================
36 // class definitions
37 // ===========================================================================
42 template<class R, class E, class V>
44 public:
46 
47  static void cleanup() {
48  delete myInstance;
49  myInstance = 0;
50  }
51 
52  virtual void setCosts(R* route, const double costs, const bool isActive = false) const = 0;
53 
55  virtual void calculateProbabilities(std::vector<R*> alternatives, const V* const veh, const SUMOTime time) = 0;
56 
57  int getMaxRouteNumber() const {
58  return myMaxRouteNumber;
59  }
60 
61  bool keepRoutes() const {
62  return myKeepRoutes;
63  }
64 
65  bool skipRouteCalculation() const {
67  }
68 
69 protected:
73  myMaxRouteNumber = oc.getInt("max-alternatives");
74  myKeepRoutes = oc.getBool("keep-all-routes");
75  mySkipRouteCalculation = oc.getBool("skip-new-routes");
76  }
77 
79  virtual ~RouteCostCalculator() {}
80 
81 private:
83 
86 
89 
92 
93 };
94 
95 
96 // ===========================================================================
97 // static member definitions
98 // ===========================================================================
99 template<class R, class E, class V>
101 
102 
103 #include "GawronCalculator.h"
104 #include "LogitCalculator.h"
105 
106 template<class R, class E, class V>
108  if (myInstance == 0) {
110  if (oc.getString("route-choice-method") == "logit") {
111  myInstance = new LogitCalculator<R, E, V>(oc.getFloat("logit.beta"), oc.getFloat("logit.gamma"), oc.getFloat("logit.theta"));
112  } else if (oc.getString("route-choice-method") == "gawron") {
113  myInstance = new GawronCalculator<R, E, V>(oc.getFloat("gawron.beta"), oc.getFloat("gawron.a"));
114  }
115  }
116  return *myInstance;
117 }
118 #endif
119 
120 /****************************************************************************/
121 
RouteCostCalculator::myMaxRouteNumber
int myMaxRouteNumber
The maximum route alternatives number.
Definition: RouteCostCalculator.h:85
OptionsCont::getInt
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
Definition: OptionsCont.cpp:215
SUMOTime.h
GawronCalculator.h
OptionsCont.h
OptionsCont::getString
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
Definition: OptionsCont.cpp:201
RouteCostCalculator::cleanup
static void cleanup()
Definition: RouteCostCalculator.h:47
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
OptionsCont::getBool
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
Definition: OptionsCont.cpp:222
OptionsCont::getOptions
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:57
RouteCostCalculator::getCalculator
static RouteCostCalculator< R, E, V > & getCalculator()
Definition: RouteCostCalculator.h:107
LogitCalculator
Cost calculation with c-logit or logit method.
Definition: LogitCalculator.h:39
RouteCostCalculator
Abstract base class providing static factory method.
Definition: RouteCostCalculator.h:43
RouteCostCalculator::myInstance
static RouteCostCalculator * myInstance
Definition: RouteCostCalculator.h:82
LogitCalculator.h
RouteCostCalculator::calculateProbabilities
virtual void calculateProbabilities(std::vector< R * > alternatives, const V *const veh, const SUMOTime time)=0
calculate the probabilities in the logit model
RouteCostCalculator::setCosts
virtual void setCosts(R *route, const double costs, const bool isActive=false) const =0
OptionsCont
A storage for options typed value containers)
Definition: OptionsCont.h:89
RouteCostCalculator::getMaxRouteNumber
int getMaxRouteNumber() const
Definition: RouteCostCalculator.h:57
RouteCostCalculator::keepRoutes
bool keepRoutes() const
Definition: RouteCostCalculator.h:61
RouteCostCalculator::mySkipRouteCalculation
bool mySkipRouteCalculation
Information whether new routes should be calculated.
Definition: RouteCostCalculator.h:91
OptionsCont::getFloat
double getFloat(const std::string &name) const
Returns the double-value of the named option (only for Option_Float)
Definition: OptionsCont.cpp:208
RouteCostCalculator::skipRouteCalculation
bool skipRouteCalculation() const
Definition: RouteCostCalculator.h:65
GawronCalculator
Cost calculation with Gawron's method.
Definition: GawronCalculator.h:39
RouteCostCalculator::~RouteCostCalculator
virtual ~RouteCostCalculator()
Destructor.
Definition: RouteCostCalculator.h:79
RouteCostCalculator::myKeepRoutes
bool myKeepRoutes
Information whether all routes should be saved.
Definition: RouteCostCalculator.h:88
config.h
StdDefs.h
RouteCostCalculator::RouteCostCalculator
RouteCostCalculator()
Constructor.
Definition: RouteCostCalculator.h:71