BCParameter.h

#ifndef __BCPARAMETER__H
#define __BCPARAMETER__H

/*
 * Copyright (C) 2007-2018, the BAT core developer team
 * All rights reserved.
 *
 * For the licensing terms see doc/COPYING.
 * For documentation see http://mpp.mpg.de/bat
 */

// ---------------------------------------------------------
#include "BCVariable.h"

#include <limits>

class TRandom;
class BCPrior;

// ---------------------------------------------------------

class BCParameter : public BCVariable
{

public:

    BCParameter();

    BCParameter(const BCParameter& other);

    BCParameter(const std::string& name, double lowerlimit, double upperlimit, const std::string& latexname = "", const std::string& unitstring = "");

    virtual ~BCParameter();

    BCParameter& operator=(BCParameter other);

    friend void swap(BCParameter& A, BCParameter& B);

    virtual bool Fixed() const
    { return fFixed or fLowerLimit == fUpperLimit; }

    virtual double GetFixedValue() const
    { return fFixedValue; }

    virtual BCPrior* GetPrior()
    { return fPrior;}

    virtual const BCPrior* GetPrior() const
    { return fPrior;}

    virtual double GetPrior(double x) const
    { double lp = GetLogPrior(x); return (std::isfinite(lp)) ? exp(lp) : ((lp < 0) ? 0 : std::numeric_limits<double>::infinity()); }

    virtual double GetLogPrior(double x) const;

    virtual double GetPriorMode() const;

    virtual double GetPriorMean() const;

    virtual double GetPriorVariance() const;

    virtual double GetRandomValueAccordingToPrior(TRandom* const rng) const;

    virtual void SetLimits(double lowerlimit = 0, double upperlimit = 1);

    virtual bool Fix(double value)
    {   fFixed = true; fFixedValue = value; return true;}

    virtual bool Unfix()
    { fFixed = false; return true;}

    virtual void SetPrior(BCPrior* const prior);

    virtual void SetPriorConstant();

    std::string OneLineSummary(bool print_prefix = true, int name_length = -1) const;

private:
    bool fFixed;

    double fFixedValue;

    BCPrior* fPrior;

};
#endif