StatedFCN.h

Go to the documentation of this file.

/* -*- mode: c++ -*- */

#ifndef _StatedFCN_H_
#define _StatedFCN_H_

#ifdef _MSC_VER
#pragma warning(disable:4275) // non dll 9nterface coming from Minuit's FCNBase
#endif

// for have minuit
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#ifdef HAVE_MINUIT
#include "pattern/libhippo.h"
#include "Minuit/FCNBase.h"
#else

#ifdef HAVE_MINUIT2
#include "pattern/libhippo.h"
#include "Minuit2/FCNBase.h"
#else
#include "FCNBase.h"
#endif

#endif

#include <string>
#include <vector>

namespace hippodraw {

class DataSource;
class FunctionBase;
class TupleCut;

#ifdef HAVE_MINUIT2
class MDL_HIPPOPLOT_API StatedFCN : public ROOT::Minuit2::FCNBase 
#else
class MDL_HIPPOPLOT_API StatedFCN : public FCNBase 
#endif

{

// private:

//   /** The flags to indicated which parameters are to be held fixed
//       during minimization of this objective function.

//       @note The flags are held as int because it is more space and
//       time efficient for the expected number of parameters.
//   */
//   std::vector < int > m_fixed_flags;

protected:

  FunctionBase * m_function;

  bool m_needs_derivs;

  StatedFCN ();

  StatedFCN ( const StatedFCN & );

 public:

  virtual StatedFCN * clone ( ) const = 0;

  virtual void copyFrom ( const StatedFCN * other );

  bool hasFunction () const;

  void setFunction ( FunctionBase * function );

  virtual void setDataSource ( const DataSource * source ) = 0;

  virtual void setDataSource ( const DataSource * source,
                               int dimension,
                               const std::vector < int > & ) = 0;

  virtual bool setUseErrors ( bool yes = true ) = 0;

  virtual bool getUseErrors () const = 0;

  const std::vector < std::string > & getParmNames () const;

  const std::vector < double > & getParameters () const;

  void setParameters ( const std::vector < double > & parms );

  void fillFreeParameters ( std::vector < double > & free_parms ) const;

  unsigned int getNumberFreeParms () const;

//   const std::vector < int > & getFixedFlags () const;

  virtual void setFixedFlags ( const std::vector < int > & flags );

  virtual void setFreeParameters ( const std::vector < double > & parms );

  void fillFreeDerivatives ( std::vector < double > &, double x );

  virtual double operator () ( const std::vector < double > & parms ) const;

  virtual double objectiveValue () const = 0;

  virtual int degreesOfFreedom() const = 0;

  virtual void calcAlphaBeta ( std::vector < std::vector < double > > & alpha,
                               std::vector < double > & beta ) = 0;

  virtual bool needsIntegrated () const = 0;

  virtual void setFitCut ( TupleCut * cut ) = 0;

  virtual void setFitRange ( bool yes = true ) = 0;

  void setNeedsDerivatives ( bool yes );

  bool isCompatible ( const FunctionBase * ) const;

  const std::vector < int > & getFixedFlags() const;

};

} // namespace hippodraw

#endif // _StatedFCN_H_