Model.h

Go to the documentation of this file.

/********************************************************************
 *  Copyright (C) 2014 by Federico Marulli and Alfonso Veropalumbo  *
 *  federico.marulli3@unibo.it                                      *
 *                                                                  *
 *  This program is free software; you can redistribute it and/or   *
 *  modify it under the terms of the GNU General Public License as  *
 *  published by the Free Software Foundation; either version 2 of  *
 *  the License, or (at your option) any later version.             *
 *                                                                  *
 *  This program is distributed in the hope that it will be useful, *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of  *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the   *
 *  GNU General Public License for more details.                    *
 *                                                                  *
 *  You should have received a copy of the GNU General Public       *
 *  License along with this program; if not, write to the Free      *
 *  Software Foundation, Inc.,                                      *
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.       *
 ********************************************************************/
 
#ifndef __MODEL__
#define __MODEL__
 
#include "ModelParameters.h"
 
 
// ======================================================================================
 
 
namespace cbl {
 
  namespace statistics {
 
    typedef std::function<std::vector<double>(std::vector<double>, std::shared_ptr<void>, std::vector<double> &)> model_function_1D;
    
    typedef std::function<std::vector<std::vector<double>>(std::vector<double>, std::vector<double>, std::shared_ptr<void>, std::vector<double> &)> model_function_2D;
 
    typedef std::function<std::vector<std::vector<double>>(std::vector<std::vector<double>>, std::shared_ptr<void>, std::vector<double> &)> model_function_generic;
 
    class Model {
 
    protected:
      
      std::shared_ptr<void> m_inputs;
 
      std::shared_ptr<ModelParameters> m_parameters;
 
      model_function_generic m_function;
 
      Dim m_dimension;
 
    public:
 
      
      Model () = default;
 
      Model (const int nparameters, std::vector<ParameterType> parameterTypes, std::vector<std::string> parameterNames, const std::shared_ptr<void> inputs)
    { set_inputs(inputs); set_parameters(nparameters, parameterTypes, parameterNames); }
 
      virtual ~Model () = default;
 
 
      Dim dimension() const { return m_dimension; }
 
      void set_function (const model_function_1D function)
      { (void)function; ErrorCBL("", "set_function", "Model.h"); } 
 
      void set_function (const std::vector<double>(*function)(const std::vector<double> xx, std::vector<double> &val))
      { (void)function; ErrorCBL("", "set_function", "Model.h"); } 
 
      void set_function (const model_function_2D function)
      { (void)function; ErrorCBL("", "set_function", "Model.h"); } 
 
      void set_inputs (std::shared_ptr<void> inputs) { m_inputs = inputs; }
 
      void set_parameters (const std::shared_ptr<ModelParameters> parameters) {m_parameters = parameters;}
 
      void set_parameters (const size_t nparameters, std::vector<ParameterType> parameterTypes, std::vector<std::string> parameterNames);
 
      std::shared_ptr<void> inputs () { return m_inputs; }
 
      std::shared_ptr<ModelParameters> parameters () { return m_parameters; }
 
      std::vector<std::vector<double>> operator () (const std::vector<std::vector<double>> xx, std::vector<double> &parameters) const;
 
      virtual double operator () (const double xx, std::vector<double> &parameters) const
      { (void)xx; (void)parameters; ErrorCBL("", "operator ()", "Model.h"); return 0; } 
 
      virtual std::vector<double> operator () (const std::vector<double> xx, std::vector<double> &parameters) const
      { (void)xx; (void)parameters; ErrorCBL("", "operator ()", "Model.h"); std::vector<double> vv; return vv; } 
 
      virtual double operator () (const double xx, const double yy, std::vector<double> &parameters) const
      { (void)xx; (void)yy; (void)parameters; ErrorCBL("", "operator ()", "Model.h"); return 0; } 
 
      virtual std::vector<std::vector<double>> operator () (const std::vector<double> xx, const std::vector<double> yy, std::vector<double> &parameters) const
      { (void)xx; (void)yy; (void)parameters; ErrorCBL("", "operator ()", "Model.h"); std::vector<std::vector<double>> vv; return vv; } 
 
      void stats_from_chains (const std::vector<std::vector<double>> xx, std::vector<std::vector<double>> &median_model, std::vector<std::vector<double>> &low_model, std::vector<std::vector<double>> &up_model, const int start=0, const int thin=1);
 
      virtual void stats_from_chains (const std::vector<double> xx, std::vector<double> &median_model, std::vector<double> &low_model, std::vector<double> &up_model, const int start=0, const int thin=1)
      { (void)xx; (void)median_model; (void)low_model; (void)up_model; (void)start; (void)thin; ErrorCBL("", "stats_from_chains", "Model.h"); } 
 
 
      virtual void stats_from_chains (const std::vector<double> xx, const std::vector<double> yy, std::vector<std::vector<double>> &median_model, std::vector<std::vector<double>> &low_model, std::vector<std::vector<double>> &up_model, const int start=0, const int thin=1)
      { (void)xx; (void)yy; (void)median_model; (void)low_model; (void)up_model; (void)start; (void)thin; ErrorCBL("", "stats_from_chains", "Model.h"); } 
 
      virtual void write (const std::string output_dir, const std::string output_file, const std::vector<double> xx, const std::vector<double> parameters)
      { (void)output_dir; (void)output_file; (void)xx; (void)parameters; cbl::ErrorCBL("", "write", "Model.h"); }
 
      virtual void write (const std::string output_dir, const std::string output_file, const std::vector<double> xx, const std::vector<double> yy, const std::vector<double> parameters)
      { (void)output_dir; (void)output_file; (void)xx; (void)yy; (void)parameters; cbl::ErrorCBL("", "write", "Model.h"); }
 
      virtual void write_at_bestfit (const std::string output_dir, const std::string output_file, const std::vector<double> xx)
      { (void)output_dir; (void)output_file; (void)xx; cbl::ErrorCBL("", "write_at_bestfit", "Model.h"); }
 
      virtual void write_at_bestfit (const std::string output_dir, const std::string output_file, const std::vector<double> xx, const std::vector<double> yy)
      { (void)output_dir; (void)output_file; (void)xx; (void)yy; cbl::ErrorCBL("", "write_at_bestfit", "Model.h"); }
 
      virtual void write_from_chains (const std::string output_dir, const std::string output_file, const std::vector<double> xx, const int start=0, const int thin=1)
      { (void)output_dir; (void)output_file; (void)xx; (void)start; (void)thin; cbl::ErrorCBL("", "write_from_chains", "Model.h"); }
 
      virtual void write_from_chains (const std::string output_dir, const std::string output_file, const std::vector<double> xx, const std::vector<double> yy, const int start=0, const int thin=1)
      { (void)output_dir; (void)output_file; (void)xx; (void)yy; (void)start; (void)thin; cbl::ErrorCBL("", "write_from_chains", "Model.h"); }
 
    };
  }
}
 
#endif