DistributionDescription.hpp

#pragma once
 
//OPALS
#include "opals/config.hpp"
#include "opals/String.hpp"
#include "opals/Vector.hpp"
#include "opals/CustomOptionType.hpp"
 
namespace opals
{  
  struct DistributionDescriptionAccess;
 
  /// \brief  Description of a variety of different statistical distribution
  ///
  ///           
  /// \author JO
  /// \date   01.09.2023
  class OPALS_API DistributionDescription : public CustomOptionType<DistributionDescription>
  {
  public:
 
    /// supported distributions
    enum struct Distribution {
        none,
        normal,               ///< Normal (Gaussian) Distribution (2 parameters: mean, stdDev)
        chiSquare,            ///< Chi Squared Distribution (1 parameter: degrees of freedom)
        exponential,          ///< Exponential Distribution (1 parameter: lambda)
        fisher,               ///< F Distribution           (2 parameters: degrees of freedom1, degrees of freedom2)
        poisson,              ///< Poisson Distribution     (1 parameter: mean)
        rayleigh,             ///< Rayleigh Distribution    (1 parameter: sigma)
        students              ///< Students t Distribution  (1 parameter: degrees of freedom)
    };
 
    /// supported distributions
    enum struct  Value {
        nummeric,
        min,
        max,
        mean,
        median,
        mode,
        stdDev,
        stdDevMAD,
        rms,
        skewness
    };
 
    DistributionDescription();
    DistributionDescription(const opals::String &rep);
    DistributionDescription(Distribution type, double param1);                 ///< initialize single parameter distributions
    DistributionDescription(Distribution type, Value param1);            ///< initialize single parameter distributions
    DistributionDescription(Distribution type, double param1, double param2);            ///< initialize dual parameter distributions
    DistributionDescription(Distribution type, Value param1, double param2);       ///< initialize dual parameter distributions
    DistributionDescription(Distribution type, Value param1, Value param2);  ///< initialize dual parameter distributions
    virtual ~DistributionDescription();
 
    bool isEmpty() const;
 
    void reset();
 
    Distribution getDistribution() const;
    
    unsigned getParamCount() const;
    double   getParamValue(unsigned idx) const;
    Value    getParamType(unsigned idx) const;
 
    /// creates new DistributionDescription object and fill in all non numeric parameters with the given values
    DistributionDescription copyFill(double min, double max, double mean, double median, double mode, double stdDev, double stdDevMAD, double rms, double skewness) const;
 
    //generic set function. make sure that you call validate afterwards 
    void setDistribution(Distribution type);
    void setParam(unsigned degrees_of_freedom1);
    void setParam(unsigned degrees_of_freedom1, unsigned degrees_of_freedom2);
    void setParam(double   param1);
    void setParam(Value    param1, Value  param2);
    void setParam(Value    param1, double param2);
    void setParam(double   param1, double param2);
    void setParam(double   param1, Value  param2);
 
    void validate() const;  ///< validates combination of parameters and throws exception if they are invalid
 
    void setNormal(Value  mean, Value  stdDev);
    void setNormal(Value  mean, double stdDev);
    void setNormal(double mean, double stdDev);
    void setNormal(double mean, Value  stdDev);
    void setChiSquare(unsigned degrees_of_freedom);
    void setExponential(double lambda);
    void setExponential(Value  lambda);
    void setFisher(unsigned degrees_of_freedom1, unsigned degrees_of_freedom2);
    void setPoisson(double mean);
    void setPoisson(Value  mean);
    void setRayleigh(Value sigma);
    void setStudents(unsigned degrees_of_freedom);
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
 
  protected:
    void clearParam();
    void addValue(Value v);
    void addValue(double v);
    void addValue(unsigned v);
 
    Distribution distribution;
 
    opals::Vector<Value> valueTypes;
    opals::Vector<double> nummericValues;
 
    friend struct DistributionDescriptionAccess;
  };
}