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_Points.h
      15              : /// @author  Daniel Krajzewicz
      16              : /// @author  Michael Behrisch
      17              : /// @date    Sept 2002
      18              : ///
      19              : // The description of a distribution by a curve
      20              : /****************************************************************************/
      21              : #pragma once
      22              : #include <config.h>
      23              : 
      24              : #include "RandomDistributor.h"
      25              : #include "Distribution.h"
      26              : 
      27              : 
      28              : // ===========================================================================
      29              : // class definitions
      30              : // ===========================================================================
      31              : /**
      32              :  * @class Distribution_Points
      33              :  * A description of a distribution that uses a set of points in a 2d-space
      34              :  *  to describe the values (each points x-value) and their possibilities
      35              :  *  (each points y-value)
      36              :  */
      37              : class Distribution_Points :
      38              :     public Distribution, public RandomDistributor<double> {
      39              : public:
      40              :     /// Constructor
      41              :     Distribution_Points(const std::string& id);
      42              : 
      43              :     /// Destructor
      44              :     virtual ~Distribution_Points();
      45              : 
      46              :     /** @brief Draw a sample of the distribution.
      47              :     *
      48              :     * A random sample is drawn according to the assigned probabilities.
      49              :     *
      50              :     * @param[in] which The random number generator to use; the static one will be used if 0 is passed
      51              :     * @return the drawn member
      52              :     */
      53            0 :     double sample(SumoRNG* which = 0) const {
      54            0 :         return get(which);
      55              :     }
      56              : 
      57              :     /// Returns the maximum value of this distribution
      58              :     double getMax() const;
      59              : 
      60              :     /// Returns the string representation of this distribution
      61              :     std::string toStr(std::streamsize accuracy) const;
      62              : };