IFunctionAdapter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidAPI/IFunction.h"
 
#include <boost/python/list.hpp>
#include <boost/python/object.hpp>
 
namespace Mantid {
namespace PythonInterface {
class IFunctionAdapter : virtual public API::IFunction {
public:
  IFunctionAdapter(PyObject *self, std::string functionMethod, std::string derivMethod);
 
  IFunctionAdapter(const IFunctionAdapter &) = delete;
 
  IFunctionAdapter &operator=(const IFunctionAdapter &) = delete;
 
  std::string name() const override;
  const std::string category() const override;
  void init() override;
 
  void declareAttribute(const std::string &name, const boost::python::object &defaultValue);
  void declareAttribute(const std::string &name, const boost::python::object &defaultValue,
                        const boost::python::object &validator);
  static PyObject *getAttributeValue(const IFunction &self, const std::string &name);
  static PyObject *getAttributeValue(const IFunction &self, const API::IFunction::Attribute &attr);
  static void setAttributePythonValue(IFunction &self, const std::string &name, const boost::python::object &value);
  void setAttribute(const std::string &attName, const API::IFunction::Attribute &attr) override;
  static boost::python::list createPythonEquivalentFunctions(const IFunction &self);
 
  // Each overload of declareParameter requires a different name as we
  // can't use a function pointer with a virtual base class
 
  inline void declareFitParameter(const std::string &name, double initValue, const std::string &description) {
    this->declareParameter(name, initValue, description);
  }
 
  inline void declareFitParameterNoDescr(const std::string &name, double initValue) {
    this->declareFitParameter(name, initValue, "");
  }
 
  inline void declareFitParameterZeroInit(const std::string &name) { this->declareFitParameter(name, 0.0, ""); }
 
  double activeParameter(size_t i) const override;
  void setActiveParameter(size_t i, double value) override;
 
protected:
  inline PyObject *getSelf() const { return m_self; }
  inline bool derivativeOverridden() const { return m_derivOveridden; }
  void evaluateFunction(double *out, const double *xValues, const size_t nData) const;
  void evaluateDerivative(API::Jacobian *out, const double *xValues, const size_t nData) const;
 
private:
  PyObject *m_self;
  std::string m_functionName;
  std::string m_derivName;
  bool m_derivOveridden;
};
} // namespace PythonInterface
} // namespace Mantid