Distribution_Parameterized.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A distribution described by parameters such as the mean value and std-dev
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
 
#include "Distribution.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class Distribution_Parameterized : public Distribution {
 
public:
    Distribution_Parameterized();
 
    Distribution_Parameterized(const std::string& description);
 
    Distribution_Parameterized(const std::string& id, double mean, double deviation);
 
    Distribution_Parameterized(const std::string& id, double mean, double deviation, double min, double max);
 
    virtual ~Distribution_Parameterized();
 
    void parse(const std::string& description, const bool hardFail);
 
    double sample(SumoRNG* which = nullptr) const;
 
    double getMax() const;
 
    double getMin() const;
 
    inline double getParameter(const int index) const {
        return myParameter[index];
    }
 
    void setParameter(const int index, const double value);
 
    const std::string isValid() const;
 
    bool isDummy() const {
        return myParameter.empty();
    }
 
    bool isVariable() const {
        return !myParameter.empty() && getMin() != getMax();
    }
 
    std::string toStr(std::streamsize accuracy) const;
 
    static bool isValidDescription(const std::string& description, std::string& error);
 
private:
    std::vector<double> myParameter;
};