Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
Distribution.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2001-2026 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
18// The base class for distribution descriptions.
19/****************************************************************************/
20#pragma once
21#include <config.h>
22
23#include <ios>
24#include <utils/common/Named.h>
25
26
27// ===========================================================================
28// class declarations
29// ===========================================================================
30class SumoRNG;
31
32
33// ===========================================================================
34// class definitions
35// ===========================================================================
41class Distribution : public Named {
42public:
44 Distribution(const std::string& id) : Named(id) { }
45
47 virtual ~Distribution() { }
48
56 virtual double sample(SumoRNG* which = nullptr) const = 0;
57
59 virtual double getMax() const = 0;
60
62 virtual std::string toStr(std::streamsize accuracy) const = 0;
63
64};
virtual std::string toStr(std::streamsize accuracy) const =0
Returns the string representation of this distribution.
virtual ~Distribution()
Destructor.
virtual double getMax() const =0
Returns the maximum value of this distribution.
virtual double sample(SumoRNG *which=nullptr) const =0
Draw a sample of the distribution.
Distribution(const std::string &id)
Constructor.
Base class for objects which have an id.
Definition Named.h:53