BCModel.h

#ifndef __BCMODEL__H
#define __BCMODEL__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 "BCH1D.h"
#include "BCH2D.h"
#include "BCIntegrate.h"
#include "BCDataSet.h"

#include <string>

//BAT classes
class BCPriorModel;

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

class BCModel : public BCIntegrate
{

public:

    BCModel(const std::string& name = "model");

    BCModel(const BCModel& bcmodel);

    BCModel(const std::string& filename, const std::string& name, bool loadObservables = true);

    BCModel& operator=(const BCModel&);

    virtual ~BCModel();

    BCDataSet* GetDataSet()
    { return fDataSet; }

    unsigned GetNDataPoints() const
    { return (fDataSet) ? fDataSet->GetNDataPoints() : 0; }

    int GetNDoF() const
    { return GetNDataPoints() - fParameters.GetNFreeParameters(); }

    virtual BCPriorModel* GetPriorModel(bool prepare = true, bool call_likelihood = false);

    virtual BCH1D GetPrior(unsigned index);

    virtual BCH2D GetPrior(unsigned index1, unsigned index2);

    BCH1D& GetBCH1DPriorDrawingOptions()
    { return fBCH1DPriorDrawingOptions; }

    BCH2D& GetBCH2DPriorDrawingOptions()
    { return fBCH2DPriorDrawingOptions; }

    BCH1D& GetBCH1DPosteriorDrawingOptions()
    { return fBCH1DPosteriorDrawingOptions; }

    BCH2D& GetBCH2DPosteriorDrawingOptions()
    { return fBCH2DPosteriorDrawingOptions; }

    bool GetDrawPriorFirst() const
    { return fDrawPriorFirst; }

    void SetDataSet(BCDataSet* dataset)
    { fDataSet = dataset; }

    void SetKnowledgeUpdateDrawingStyle(BCAux::BCKnowledgeUpdateDrawingStyle style = BCAux::kKnowledgeUpdateDefaultStyle);

    void SetDrawPriorFirst(bool b = true)
    { fDrawPriorFirst = b; }

    virtual double APrioriProbability(const std::vector<double>& parameters)
    { return exp(this->LogAPrioriProbability(parameters)); }

    virtual double LogAPrioriProbability(const std::vector<double>& parameters)
    { fFactorizedPrior = true; return fParameters.GetLogPrior(parameters); }

    virtual double Likelihood(const std::vector<double>& params)
    { return exp(LogLikelihood(params)) ; }

    virtual double LogLikelihood(const std::vector<double>& params) = 0;

    virtual double ProbabilityNN(const std::vector<double>& params)
    { return exp(LogProbabilityNN(params)); }

    virtual double LogProbabilityNN(const std::vector<double>& parameters);

    virtual double Probability(const std::vector<double>& parameters)
    { return exp(LogProbability(parameters)); }

    virtual double LogProbability(const std::vector<double>& parameters);

    virtual double SamplingFunction(const std::vector<double>& parameters);

    virtual double Eval(const std::vector<double>& parameters)
    { return exp(LogEval(parameters)); }

    virtual double LogEval(const std::vector<double>& parameters)
    { return LogProbabilityNN(parameters); }

    virtual void InitializeMarkovChainTree(bool replacetree = false, bool replacefile = false);

    double HessianMatrixElement(unsigned index1, unsigned index2, const std::vector<double>& point);

    void PrintShortFitSummary();

    void PrintHessianMatrix(std::vector<double> parameters);

    virtual unsigned PrintKnowledgeUpdatePlots(const std::string& filename, unsigned hdiv = 1, unsigned vdiv = 1, bool call_likelihood = false);


    /* /\** */
    /*  * Print priors to file */
    /*  * @param filename name of file to print to */
    /*  * @param hdiv number of horizontal divisions on page */
    /*  * @param vdiv number of vertical divisions on page */
    /*  * @param call_likelihood whether to call model likelihood function to prepare for calculating observables */
    /*  * @return number of plots printed. *\/ */
    /* virtual unsigned PrintPriors(const std::string& filename, unsigned hdiv = 1, unsigned vdiv = 1, bool call_likelihood = false); */

    // declare BCPriorModel a friend
    friend class BCPriorModel;

protected:

    BCDataSet* fDataSet;

    BCPriorModel* fPriorModel;

    BCH1D fBCH1DPriorDrawingOptions;

    BCH2D fBCH2DPriorDrawingOptions;

    BCH1D fBCH1DPosteriorDrawingOptions;

    BCH2D fBCH2DPosteriorDrawingOptions;

    bool fDrawPriorFirst;

    bool fFactorizedPrior;

};

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

#endif