SUMO - Simulation of Urban MObility
Distribution.h
Go to the documentation of this file.
1 /****************************************************************************/
7 // The base class for distribution descriptions.
8 /****************************************************************************/
9 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
10 // Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
11 /****************************************************************************/
12 //
13 // This file is part of SUMO.
14 // SUMO is free software: you can redistribute it and/or modify
15 // it under the terms of the GNU General Public License as published by
16 // the Free Software Foundation, either version 3 of the License, or
17 // (at your option) any later version.
18 //
19 /****************************************************************************/
20 #ifndef Distribution_h
21 #define Distribution_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #include <random>
34 #include <utils/common/Named.h>
35 
36 
37 // ===========================================================================
38 // class definitions
39 // ===========================================================================
45 class Distribution : public Named {
46 public:
48  Distribution(const std::string& id) : Named(id) { }
49 
51  virtual ~Distribution() { }
52 
60  virtual double sample(std::mt19937* which = 0) const = 0;
61 
63  virtual double getMax() const = 0;
64 
66  virtual std::string toStr(std::streamsize accuracy) const = 0;
67 
68 };
69 
70 
71 #endif
72 
73 /****************************************************************************/
74 
Distribution(const std::string &id)
Constructor.
Definition: Distribution.h:48
virtual double sample(std::mt19937 *which=0) const =0
Draw a sample of the distribution.
virtual double getMax() const =0
Returns the maximum value of this distribution.
virtual std::string toStr(std::streamsize accuracy) const =0
Returns the string representation of this distribution.
Base class for objects which have an id.
Definition: Named.h:46
virtual ~Distribution()
Destructor.
Definition: Distribution.h:51