SequenceTypeHandler.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 +
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidPythonInterface/kernel/Registry/SequenceTypeHandler.h"
#include "MantidKernel/IPropertyManager.h"
#include "MantidKernel/IValidator.h"
#include "MantidPythonInterface/core/Converters/NDArrayToVector.h"
#include "MantidPythonInterface/core/Converters/PySequenceToVector.h"
#include "MantidPythonInterface/kernel/DllConfig.h"
 
// See
// http://docs.scipy.org/doc/numpy/reference/c-api.array.html#PY_ARRAY_UNIQUE_SYMBOL
#define PY_ARRAY_UNIQUE_SYMBOL KERNEL_ARRAY_API
#define NO_IMPORT_ARRAY
#include <numpy/arrayobject.h>
 
#include <boost/python/extract.hpp>
 
namespace Mantid::PythonInterface::Registry {
namespace {
template <typename HeldType> struct StdVectorExtractor {
  static std::vector<HeldType> extract(const boost::python::object &value) {
    return boost::python::extract<std::vector<HeldType>>(value.ptr());
  }
};
template <> struct StdVectorExtractor<bool> {
  static std::vector<bool> extract(const boost::python::object & /*unused*/) {
    throw std::runtime_error("Unable to supported extracting std::vector<bool> from python object");
  }
};
} // namespace
 
template <typename ContainerType>
void SequenceTypeHandler<ContainerType>::set(Kernel::IPropertyManager *alg, const std::string &name,
                                             const boost::python::object &value) const {
  using namespace boost::python;
  using DestElementType = typename ContainerType::value_type;
 
  // Current workaround for things that still pass back wrapped vectors...
  const std::string tpName = value.ptr()->ob_type->tp_name;
  if (tpName.starts_with("std_vector")) {
    alg->setProperty(name, StdVectorExtractor<DestElementType>::extract(value));
  }
  // numpy arrays requires special handling to extract their types. Hand-off to
  // a more appropriate handler
  else if (NDArray::check(value)) {
    alg->setProperty(name, Converters::NDArrayToVector<DestElementType>(NDArray(value))());
  } else if (PySequence_Check(value.ptr())) {
    alg->setProperty(name, Converters::PySequenceToVector<DestElementType>(value)());
  } else // assume it is a scalar and try to convert into a vector of length one
  {
    DestElementType scalar = boost::python::extract<DestElementType>(value.ptr());
    alg->setProperty(name, std::vector<DestElementType>(1, scalar));
  }
}
 
template <typename ContainerType>
std::unique_ptr<Kernel::Property>
SequenceTypeHandler<ContainerType>::create(const std::string &name, const boost::python::object &defaultValue,
                                           const boost::python::object &validator, const unsigned int direction) const {
  using DestElementType = typename ContainerType::value_type;
  using boost::python::extract;
  using Kernel::IValidator;
  using Kernel::PropertyWithValue;
 
  ContainerType valueInC;
  // Current workaround for things that still pass back wrapped vectors...
  const std::string tpName = defaultValue.ptr()->ob_type->tp_name;
  if (tpName.starts_with("std_vector")) {
    valueInC = StdVectorExtractor<DestElementType>::extract(defaultValue);
  } else if (PySequence_Check(defaultValue.ptr())) {
    valueInC = Converters::PySequenceToVector<DestElementType>(defaultValue)();
  } else // assume it is a scalar and try to convert into a vector of length one
  {
    DestElementType scalar = boost::python::extract<DestElementType>(defaultValue.ptr());
    valueInC = std::vector<DestElementType>(1, scalar);
  }
 
  std::unique_ptr<Kernel::Property> valueProp;
  if (isNone(validator)) {
    valueProp = std::make_unique<PropertyWithValue<ContainerType>>(name, valueInC, direction);
  } else {
    const IValidator *propValidator = extract<IValidator *>(validator);
    valueProp = std::make_unique<PropertyWithValue<ContainerType>>(name, valueInC, propValidator->clone(), direction);
  }
  return valueProp;
}
 
//-----------------------------------------------------------------------
// Concrete instantiations
//-----------------------------------------------------------------------
#define INSTANTIATE(ElementType) template struct PYTHON_KERNEL_DLL SequenceTypeHandler<std::vector<ElementType>>;
 
INSTANTIATE(int)
INSTANTIATE(long)
INSTANTIATE(long long)
INSTANTIATE(unsigned int)
INSTANTIATE(unsigned long)
INSTANTIATE(unsigned long long)
INSTANTIATE(double)
INSTANTIATE(std::string)
INSTANTIATE(bool)
} // namespace Mantid::PythonInterface::Registry