Line data    Source code

       1             : /****************************************************************************/
       2             : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
       3             : // Copyright (C) 2001-2024 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             : /****************************************************************************/
      14             : /// @file    Distribution.h
      15             : /// @author  Daniel Krajzewicz
      16             : /// @date    Sept 2002
      17             : ///
      18             : // The base class for distribution descriptions.
      19             : /****************************************************************************/
      20             : #pragma once
      21             : #include <config.h>
      22             : 
      23             : #include <utils/common/Named.h>
      24             : #include <utils/common/RandHelper.h>
      25             : 
      26             : 
      27             : // ===========================================================================
      28             : // class definitions
      29             : // ===========================================================================
      30             : /**
      31             :  * @class Distribution
      32             :  * The base class for distribution descriptions. Only an interface
      33             :  *  specification.
      34             :  */
      35             : class Distribution : public Named {
      36             : public:
      37             :     /// Constructor
      38       45060 :     Distribution(const std::string& id) : Named(id) { }
      39             : 
      40             :     /// Destructor
      41           0 :     virtual ~Distribution() { }
      42             : 
      43             :     /** @brief Draw a sample of the distribution.
      44             :     *
      45             :     * A random sample is drawn according to the assigned probabilities.
      46             :     *
      47             :     * @param[in] which The random number generator to use; the static one will be used if 0 is passed
      48             :     * @return the drawn member
      49             :     */
      50             :     virtual double sample(SumoRNG* which = 0) const = 0;
      51             : 
      52             :     /// Returns the maximum value of this distribution
      53             :     virtual double getMax() const = 0;
      54             : 
      55             :     /// Returns the string representation of this distribution
      56             :     virtual std::string toStr(std::streamsize accuracy) const = 0;
      57             : 
      58             : };