IFunctionAdapter.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#include "MantidPythonInterface/api/FitFunctions/IFunctionAdapter.h"
#include "MantidKernel/WarningSuppressions.h"
#include "MantidPythonInterface/core/CallMethod.h"
#include "MantidPythonInterface/core/Converters/PyNativeTypeExtractor.h"
#include "MantidPythonInterface/core/Converters/WrapWithNDArray.h"
#include "MantidPythonInterface/core/GlobalInterpreterLock.h"
 
#include <boost/python/class.hpp>
#include <boost/python/list.hpp>
#include <boost/variant/apply_visitor.hpp>
#include <utility>
 
#define PY_ARRAY_UNIQUE_SYMBOL API_ARRAY_API
#define NO_IMPORT_ARRAY
#include <numpy/arrayobject.h>
 
namespace Mantid::PythonInterface {
using API::IFunction;
using PythonInterface::callMethod;
using PythonInterface::callMethodNoCheck;
using PythonInterface::UndefinedAttributeError;
using namespace boost::python;
 
namespace {
 
class AttrVisitor : Mantid::PythonInterface::IPyTypeVisitor {
public:
  AttrVisitor(IFunction::Attribute &attrToUpdate) : m_attr(attrToUpdate) {}
 
  void operator()(bool value) const override { m_attr.setValue(value); }
  void operator()(int value) const override { m_attr.setValue(value); }
  void operator()(double value) const override { m_attr.setValue(value); }
  void operator()(std::string value) const override { m_attr.setValue(std::move(value)); }
  void operator()(Mantid::API::Workspace_sptr) const override { throw std::invalid_argument(m_errorMsg); }
 
  void operator()(std::vector<bool>) const override { throw std::invalid_argument(m_errorMsg); }
  void operator()(std::vector<int> value) const override {
    // Previous existing code blindly converted any list type into a list of doubles.
    // We now have to preserve this behaviour to maintain API compatibility as
    // setValue only takes std::vector<double>.
    std::vector<double> doubleVals(value.cbegin(), value.cend());
    m_attr.setValue(std::move(doubleVals));
  }
  void operator()(std::vector<double> value) const override { m_attr.setValue(std::move(value)); }
  void operator()(std::vector<std::string>) const override { throw std::invalid_argument(m_errorMsg); }
 
  using Mantid::PythonInterface::IPyTypeVisitor::operator();
 
private:
  IFunction::Attribute &m_attr;
  const std::string m_errorMsg = "Invalid attribute. Allowed types=float,int,str,bool,list(float),list(int)";
};
 
IFunction::Attribute createAttributeFromPythonValue(IFunction::Attribute attrToUpdate, const object &value) {
 
  using Mantid::PythonInterface::PyNativeTypeExtractor;
  auto variantObj = PyNativeTypeExtractor::convert(value);
 
  boost::apply_visitor(AttrVisitor(attrToUpdate), variantObj);
  return attrToUpdate;
}
 
} // namespace
 
IFunctionAdapter::IFunctionAdapter(PyObject *self, std::string functionMethod, std::string derivMethod)
    : m_self(self), m_functionName(std::move(functionMethod)), m_derivName(std::move(derivMethod)),
      m_derivOveridden(typeHasAttribute(self, m_derivName.c_str())) {
  if (!typeHasAttribute(self, "init"))
    throw std::runtime_error("Function does not define an init method.");
  if (!typeHasAttribute(self, m_functionName.c_str()))
    throw std::runtime_error("Function does not define a " + m_functionName + " method.");
}
 
std::string IFunctionAdapter::name() const { return getSelf()->ob_type->tp_name; }
 
const std::string IFunctionAdapter::category() const {
  try {
    return callMethod<std::string>(getSelf(), "category");
  } catch (UndefinedAttributeError &) {
    return IFunction::category();
  }
}
 
void IFunctionAdapter::init() { callMethodNoCheck<void>(getSelf(), "init"); }
 
void IFunctionAdapter::declareAttribute(const std::string &name, const boost::python::object &defaultValue) {
  auto attr = IFunction::hasAttribute(name) ? IFunction::getAttribute(name) : Attribute();
  attr = createAttributeFromPythonValue(attr, defaultValue);
  IFunction::declareAttribute(name, attr);
  try {
    callMethod<void, std::string, object>(getSelf(), "setAttributeValue", name, defaultValue);
  } catch (UndefinedAttributeError &) {
    // nothing to do
  }
}
 
GNU_DIAG_OFF("maybe-uninitialized")
void IFunctionAdapter::declareAttribute(const std::string &name, const boost::python::object &defaultValue,
                                        const boost::python::object &validator) {
  auto attr = IFunction::hasAttribute(name) ? IFunction::getAttribute(name) : Attribute();
  Mantid::Kernel::IValidator_sptr c_validator = nullptr;
 
  try {
    c_validator = boost::python::extract<Mantid::Kernel::IValidator_sptr>(validator);
  } catch (boost::python::error_already_set &) {
    throw std::invalid_argument("Cannot extract Validator from object ");
  }
  attr = createAttributeFromPythonValue(attr, defaultValue);
  IFunction::declareAttribute(name, attr, *c_validator);
  try {
    callMethod<void, std::string, object>(getSelf(), "setAttributeValue", name, defaultValue);
  } catch (UndefinedAttributeError &) {
    // nothing to do
  }
}
GNU_DIAG_ON("maybe-uninitialized")
 
 
PyObject *IFunctionAdapter::getAttributeValue(const IFunction &self, const std::string &name) {
  auto attr = self.getAttribute(name);
  return getAttributeValue(self, attr);
}
 
PyObject *IFunctionAdapter::getAttributeValue(const IFunction &self, const API::IFunction::Attribute &attr) {
  UNUSED_ARG(self);
  std::string type = attr.type();
  PyObject *result(nullptr);
  GlobalInterpreterLock gilLock;
  if (type == "int")
    result = to_python_value<const int &>()(attr.asInt());
  else if (type == "double")
    result = to_python_value<const double &>()(attr.asDouble());
  else if (type == "std::string")
    result = to_python_value<const std::string &>()(attr.asString());
  else if (type == "bool")
    result = to_python_value<const bool &>()(attr.asBool());
  else if (type == "std::vector<double>")
    result = to_python_value<const std::vector<double> &>()(attr.asVector());
  else
    throw std::runtime_error("Unknown attribute type, cannot convert C++ type "
                             "to Python. Contact developement team.");
  return result;
}
 
void IFunctionAdapter::setAttributePythonValue(IFunction &self, const std::string &name, const object &value) {
  auto previousAttr = self.getAttribute(name);
  self.setAttribute(name, createAttributeFromPythonValue(previousAttr, value));
}
 
void IFunctionAdapter::setAttribute(const std::string &attName, const Attribute &attr) {
  auto self = getSelf();
  if (typeHasAttribute(self, "setAttributeValue")) {
    object value = object(handle<>(getAttributeValue(*this, attr)));
    callMethod<void, std::string, object>(self, "setAttributeValue", attName, value);
    storeAttributeValue(attName, attr);
  } else {
    IFunction::setAttribute(attName, attr);
  }
}
 
boost::python::list IFunctionAdapter::createPythonEquivalentFunctions(const IFunction &self) {
  auto functions = self.createEquivalentFunctions();
  boost::python::list list;
  for (const auto &fun : functions) {
    list.append(fun);
  }
  return list;
}
 
double IFunctionAdapter::activeParameter(size_t i) const {
  try {
    return callMethod<double, size_t>(getSelf(), "activeParameter", i);
  } catch (UndefinedAttributeError &) {
    return IFunction::activeParameter(i);
  }
}
 
void IFunctionAdapter::setActiveParameter(size_t i, double value) {
  try {
    callMethod<void, size_t, double>(getSelf(), "setActiveParameter", i, value);
  } catch (UndefinedAttributeError &) {
    IFunction::setActiveParameter(i, value);
  }
}
 
void IFunctionAdapter::evaluateFunction(double *out, const double *xValues, const size_t nData) const {
  using namespace Converters;
  // GIL must be held while numpy wrappers are destroyed as they access Python
  // state information
  GlobalInterpreterLock gil;
 
  Py_intptr_t dims[1] = {static_cast<Py_intptr_t>(nData)};
  PyObject *xvals = WrapReadOnly::apply<double>::createFromArray(xValues, 1, dims);
 
  // Deliberately avoids using the CallMethod wrappers. They lock the GIL again
  // and
  // will check for each function call whether the wrapped method exists. It
  // also avoid unnecessary construction of
  // boost::python::objects whn using boost::python::call_method
 
  PyObject *result =
      PyObject_CallMethod(getSelf(), const_cast<char *>(m_functionName.c_str()), const_cast<char *>("(O)"), xvals);
  Py_DECREF(xvals);
  if (PyErr_Occurred()) {
    Py_XDECREF(result);
    throw PythonException();
  }
  if (PyArray_Check(result)) {
    auto nparray = reinterpret_cast<PyArrayObject *>(result);
    // dtype matches so use memcpy for speed
    if (PyArray_TYPE(nparray) == NPY_DOUBLE) {
      std::memcpy(static_cast<void *>(out), PyArray_DATA(nparray), nData * sizeof(npy_double));
      Py_DECREF(result);
    } else {
      Py_DECREF(result);
      PyArray_Descr *dtype = PyArray_DESCR(nparray);
      std::string err("Unsupported numpy data type: '");
      err.append(dtype->typeobj->tp_name).append("'. Currently only numpy.float64 is supported.");
      throw std::runtime_error(err);
    }
  } else {
    std::string err("Expected ");
    err.append(m_functionName)
        .append(" to return a numpy array, however an ")
        .append(result->ob_type->tp_name)
        .append(" was returned.");
    throw std::runtime_error(err);
  }
}
 
void IFunctionAdapter::evaluateDerivative(API::Jacobian *out, const double *xValues, const size_t nData) const {
  using namespace Converters;
  // GIL must be held while numpy wrappers are destroyed as they access Python
  // state information
  GlobalInterpreterLock gil;
 
  Py_intptr_t dims[1] = {static_cast<Py_intptr_t>(nData)};
  PyObject *xvals = WrapReadOnly::apply<double>::createFromArray(xValues, 1, dims);
  PyObject *jacobian = boost::python::to_python_value<API::Jacobian *>()(out);
 
  // Deliberately avoids using the CallMethod wrappers. They lock the GIL
  // again and
  // will check for each function call whether the wrapped method exists. It
  // also avoid unnecessary construction of
  // boost::python::objects when using boost::python::call_method
  PyObject_CallMethod(getSelf(), const_cast<char *>(m_derivName.c_str()), const_cast<char *>("(OO)"), xvals, jacobian);
  if (PyErr_Occurred())
    throw PythonException();
}
} // namespace Mantid::PythonInterface