Eclipse SUMO - Simulation of Urban MObility
Distribution_Parameterized.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-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 /****************************************************************************/
15 // A distribution described by parameters such as the mean value and std-dev
16 /****************************************************************************/
17 #ifndef Distribution_MeanDev_h
18 #define Distribution_MeanDev_h
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
26 #include <vector>
27 #include <random>
28 
29 #include "Distribution.h"
30 
31 
32 // ===========================================================================
33 // class definitions
34 // ===========================================================================
43 
44 public:
46  Distribution_Parameterized(const std::string& id, double mean, double deviation);
47 
49  Distribution_Parameterized(const std::string& id, double mean, double deviation, double min, double max);
50 
53 
55  void parse(const std::string& description, const bool hardFail);
56 
64  double sample(std::mt19937* which = 0) const;
65 
67  double getMax() const;
68 
70  std::vector<double>& getParameter();
71 
73  const std::vector<double>& getParameter() const;
74 
76  bool isValid(std::string& error);
77 
79  std::string toStr(std::streamsize accuracy) const;
80 
81 private:
83  std::vector<double> myParameter;
84 };
85 
86 
87 #endif
88 
89 /****************************************************************************/
90 
Distribution_Parameterized
Definition: Distribution_Parameterized.h:42
Distribution.h
Distribution
Definition: Distribution.h:37
Distribution_Parameterized::~Distribution_Parameterized
virtual ~Distribution_Parameterized()
Destructor.
Definition: Distribution_Parameterized.cpp:53
Distribution_Parameterized::sample
double sample(std::mt19937 *which=0) const
Draw a sample of the distribution.
Definition: Distribution_Parameterized.cpp:84
Distribution_Parameterized::isValid
bool isValid(std::string &error)
check whether the distribution is valid
Definition: Distribution_Parameterized.cpp:135
Distribution_Parameterized::myParameter
std::vector< double > myParameter
The distribution's parameters.
Definition: Distribution_Parameterized.h:83
Distribution_Parameterized::getParameter
std::vector< double > & getParameter()
Returns the parameters of this distribution.
Definition: Distribution_Parameterized.cpp:110
Distribution_Parameterized::getMax
double getMax() const
Returns the maximum value of this distribution.
Definition: Distribution_Parameterized.cpp:101
Distribution_Parameterized::toStr
std::string toStr(std::streamsize accuracy) const
Returns the string representation of this distribution.
Definition: Distribution_Parameterized.cpp:122
Distribution_Parameterized::Distribution_Parameterized
Distribution_Parameterized(const std::string &id, double mean, double deviation)
Constructor for standard normal distribution.
Definition: Distribution_Parameterized.cpp:37
config.h
Distribution_Parameterized::parse
void parse(const std::string &description, const bool hardFail)
Overwrite by parsable distribution description.
Definition: Distribution_Parameterized.cpp:57