Line data    Source code

       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              : /****************************************************************************/
      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              : 
      25              : 
      26              : // ===========================================================================
      27              : // class declarations
      28              : // ===========================================================================
      29              : class SumoRNG;
      30              : 
      31              : 
      32              : // ===========================================================================
      33              : // class definitions
      34              : // ===========================================================================
      35              : /**
      36              :  * @class Distribution
      37              :  * The base class for distribution descriptions. Only an interface
      38              :  *  specification.
      39              :  */
      40              : class Distribution : public Named {
      41              : public:
      42              :     /// Constructor
      43      3007404 :     Distribution(const std::string& id) : Named(id) { }
      44              : 
      45              :     /// Destructor
      46            0 :     virtual ~Distribution() { }
      47              : 
      48              :     /** @brief Draw a sample of the distribution.
      49              :     *
      50              :     * A random sample is drawn according to the assigned probabilities.
      51              :     *
      52              :     * @param[in] which The random number generator to use; the static one will be used if nullptr is passed
      53              :     * @return the drawn member
      54              :     */
      55              :     virtual double sample(SumoRNG* which = nullptr) const = 0;
      56              : 
      57              :     /// Returns the maximum value of this distribution
      58              :     virtual double getMax() const = 0;
      59              : 
      60              :     /// Returns the string representation of this distribution
      61              :     virtual std::string toStr(std::streamsize accuracy) const = 0;
      62              : 
      63              : };