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 /****************************************************************************/
16 // A distribution described by parameters such as the mean value and std-dev
17 /****************************************************************************/
18 #ifndef Distribution_MeanDev_h
19 #define Distribution_MeanDev_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <vector>
28 #include <random>
29 
30 #include "Distribution.h"
31 
32 
33 // ===========================================================================
34 // class definitions
35 // ===========================================================================
44 
45 public:
47  Distribution_Parameterized(const std::string& id, double mean, double deviation);
48 
50  Distribution_Parameterized(const std::string& id, double mean, double deviation, double min, double max);
51 
54 
56  void parse(const std::string& description, const bool hardFail);
57 
65  double sample(std::mt19937* which = 0) const;
66 
68  double getMax() const;
69 
71  std::vector<double>& getParameter();
72 
74  const std::vector<double>& getParameter() const;
75 
77  bool isValid(std::string& error);
78 
80  std::string toStr(std::streamsize accuracy) const;
81 
82 private:
84  std::vector<double> myParameter;
85 };
86 
87 
88 #endif
89 
90 /****************************************************************************/
91 
Distribution_Parameterized
Definition: Distribution_Parameterized.h:43
Distribution.h
Distribution
Definition: Distribution.h:38
Distribution_Parameterized::~Distribution_Parameterized
virtual ~Distribution_Parameterized()
Destructor.
Definition: Distribution_Parameterized.cpp:54
Distribution_Parameterized::sample
double sample(std::mt19937 *which=0) const
Draw a sample of the distribution.
Definition: Distribution_Parameterized.cpp:85
Distribution_Parameterized::isValid
bool isValid(std::string &error)
check whether the distribution is valid
Definition: Distribution_Parameterized.cpp:136
Distribution_Parameterized::myParameter
std::vector< double > myParameter
The distribution's parameters.
Definition: Distribution_Parameterized.h:84
Distribution_Parameterized::getParameter
std::vector< double > & getParameter()
Returns the parameters of this distribution.
Definition: Distribution_Parameterized.cpp:111
Distribution_Parameterized::getMax
double getMax() const
Returns the maximum value of this distribution.
Definition: Distribution_Parameterized.cpp:102
Distribution_Parameterized::toStr
std::string toStr(std::streamsize accuracy) const
Returns the string representation of this distribution.
Definition: Distribution_Parameterized.cpp:123
Distribution_Parameterized::Distribution_Parameterized
Distribution_Parameterized(const std::string &id, double mean, double deviation)
Constructor for standard normal distribution.
Definition: Distribution_Parameterized.cpp:38
config.h
Distribution_Parameterized::parse
void parse(const std::string &description, const bool hardFail)
Overwrite by parsable distribution description.
Definition: Distribution_Parameterized.cpp:58