CloneToNDArray.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/core/Converters/CloneToNDArray.h"
#include "MantidPythonInterface/core/Converters/DateAndTime.h"
#include "MantidPythonInterface/core/Converters/NDArrayTypeIndex.h"
#include "MantidPythonInterface/core/Converters/NumpyFunctions.h"
#include "MantidPythonInterface/core/DllConfig.h"
#include "MantidTypes/Core/DateAndTime.h"
#include <boost/python/list.hpp>
#include <string>
 
#define PY_ARRAY_UNIQUE_SYMBOL CORE_ARRAY_API
#define NO_IMPORT_ARRAY
#include <numpy/arrayobject.h>
 
namespace Mantid::PythonInterface::Converters {
#ifdef __APPLE__
extern template int NDArrayTypeIndex<bool>::typenum;
extern template int NDArrayTypeIndex<int>::typenum;
extern template int NDArrayTypeIndex<long>::typenum;
extern template int NDArrayTypeIndex<long long>::typenum;
extern template int NDArrayTypeIndex<unsigned int>::typenum;
extern template int NDArrayTypeIndex<unsigned long>::typenum;
extern template int NDArrayTypeIndex<unsigned long long>::typenum;
extern template int NDArrayTypeIndex<float>::typenum;
extern template int NDArrayTypeIndex<double>::typenum;
extern template int NDArrayTypeIndex<Mantid::Types::Core::DateAndTime>::typenum;
#endif
namespace Impl {
template <typename ElementType> PyObject *clone1D(const std::vector<ElementType> &cvector) {
  Py_intptr_t dims[1] = {static_cast<int>(cvector.size())};
  return cloneND(cvector.data(), 1, dims);
}
 
template <> MANTID_PYTHONINTERFACE_CORE_DLL PyObject *clone1D(const std::vector<Types::Core::DateAndTime> &cvector) {
  // create an empty array
  PyArray_Descr *descr = Converters::descr_ns();
  Py_intptr_t dims[1] = {static_cast<int>(cvector.size())};
  auto *nparray = reinterpret_cast<PyArrayObject *>(
      PyArray_NewFromDescr(&PyArray_Type, descr, 1, dims, nullptr, nullptr, 0, nullptr));
 
  for (Py_intptr_t i = 0; i < dims[0]; ++i) {
    void *itemPtr = PyArray_GETPTR1(nparray, i);
    npy_datetime abstime = Converters::to_npy_datetime(cvector[i]);
    auto scalar = PyArray_Scalar(reinterpret_cast<char *>(&abstime), descr, nullptr);
    PyArray_SETITEM(nparray, reinterpret_cast<char *>(itemPtr), scalar);
    Py_DECREF(scalar);
  }
  return reinterpret_cast<PyObject *>(nparray);
}
 
template <> MANTID_PYTHONINTERFACE_CORE_DLL PyObject *clone1D(const std::vector<bool> &cvector) {
  Py_intptr_t dims[1] = {static_cast<int>(cvector.size())};
  int datatype = NDArrayTypeIndex<bool>::typenum;
  PyArrayObject *nparray = func_PyArray_NewFromDescr(datatype, 1, &dims[0]);
 
  for (Py_intptr_t i = 0; i < dims[0]; ++i) {
    void *itemPtr = PyArray_GETPTR1(nparray, i);
    auto py_bool = PyBool_FromLong(static_cast<long int>(cvector[i]));
    PyArray_SETITEM(nparray, reinterpret_cast<char *>(itemPtr), py_bool);
    Py_DECREF(py_bool);
  }
  return reinterpret_cast<PyObject *>(nparray);
}
 
template <typename ElementType> PyObject *cloneND(const ElementType *carray, const int ndims, Py_intptr_t *dims) {
  int datatype = NDArrayTypeIndex<ElementType>::typenum;
  PyArrayObject *nparray = func_PyArray_NewFromDescr(datatype, ndims, &dims[0]);
  // Compute total number of elements
  size_t length(dims[0]);
  if (ndims > 1) {
    for (int i = 1; i < ndims; ++i) {
      length *= dims[i];
    }
  }
  void *arrayData = PyArray_DATA(nparray);
  const void *data = static_cast<void *>(const_cast<ElementType *>(carray));
  if (dims[0] > 0) {
    std::memcpy(arrayData, data, PyArray_ITEMSIZE(nparray) * length);
  }
  return reinterpret_cast<PyObject *>(nparray);
}
 
// cppcheck-suppress constParameterPointer
// Suppressed because one of the cloneND overloads calls
// PyArray_NewFromDescrclasses inside NumpyFunctions::func_PyArray_NewFromDescr, which
// requires the dim parameter to be non-const.
template <> PyObject *cloneND(const std::string *carray, const int ndims, Py_intptr_t *dims) {
  boost::python::list pystrs;
  const std::string *iter = carray;
  for (int i = 0; i < ndims; ++i) {
    const Py_intptr_t length = dims[i];
    for (Py_intptr_t j = 0; j < length; ++j) {
      pystrs.append(iter->c_str());
      ++iter;
    }
  }
  PyObject *rawptr = pystrs.ptr();
  Py_INCREF(rawptr); // Make sure it survives after the wrapper decrefs the count
  return rawptr;
}
 
//-----------------------------------------------------------------------
// Explicit instantiations
//-----------------------------------------------------------------------
#define INSTANTIATE_CLONE1D(ElementType)                                                                               \
  template MANTID_PYTHONINTERFACE_CORE_DLL PyObject *clone1D<ElementType>(const std::vector<ElementType> &cvector);
 
#define INSTANTIATE_CLONEND(ElementType)                                                                               \
  template MANTID_PYTHONINTERFACE_CORE_DLL PyObject *cloneND<ElementType>(const ElementType *, const int ndims,        \
                                                                          Py_intptr_t *dims);
 
#define INSTANTIATE_CLONE(ElementType)                                                                                 \
  INSTANTIATE_CLONE1D(ElementType)                                                                                     \
  INSTANTIATE_CLONEND(ElementType)
 
INSTANTIATE_CLONE(int)
INSTANTIATE_CLONE(long)
INSTANTIATE_CLONE(long long)
INSTANTIATE_CLONE(unsigned int)
INSTANTIATE_CLONE(unsigned long)
INSTANTIATE_CLONE(unsigned long long)
INSTANTIATE_CLONE(double)
INSTANTIATE_CLONE(float)
// Need further 1D specialisation for string
INSTANTIATE_CLONE1D(std::string)
// Need further ND specialisation for DateAndTime
INSTANTIATE_CLONEND(Types::Core::DateAndTime)
// Need further ND specialisation for bool
INSTANTIATE_CLONEND(bool)
} // namespace Impl
} // namespace Mantid::PythonInterface::Converters