WrapWithNDArray.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/WrapWithNDArray.h"
#include "MantidPythonInterface/core/Converters/NDArrayTypeIndex.h"
#include "MantidPythonInterface/core/DllConfig.h"
 
#include <boost/python/list.hpp>
#define PY_ARRAY_UNIQUE_SYMBOL CORE_ARRAY_API
#define NO_IMPORT_ARRAY
#include <numpy/arrayobject.h>
 
#include <string>
 
namespace {
 
template <typename T> void capsule_cleanup(PyObject *capsule) {
  auto *memory = static_cast<T *>(PyCapsule_GetPointer(capsule, NULL));
  delete[] memory;
}
 
} // namespace
 
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;
#endif
 
namespace {
void markReadOnly(PyArrayObject *arr) {
#if NPY_API_VERSION >= 0x00000007 //(1.7)
  PyArray_CLEARFLAGS(arr, NPY_ARRAY_WRITEABLE);
#else
  arr->flags &= ~NPY_WRITEABLE;
#endif
}
} // namespace
 
namespace Impl {
 
template <typename ElementType>
PyObject *wrapWithNDArray(const ElementType *carray, const int ndims, Py_intptr_t *dims, const NumpyWrapMode mode,
                          const OwnershipMode oMode /* = Cpp */) {
  int datatype = NDArrayTypeIndex<ElementType>::typenum;
  auto *nparray = reinterpret_cast<PyArrayObject *>(
      PyArray_SimpleNewFromData(ndims, dims, datatype, static_cast<void *>(const_cast<ElementType *>(carray))));
 
  if (oMode == Python) {
    PyObject *capsule = PyCapsule_New(const_cast<ElementType *>(carray), NULL, capsule_cleanup<ElementType>);
    PyArray_SetBaseObject(reinterpret_cast<PyArrayObject *>(nparray), capsule);
  }
 
  if (mode == ReadOnly)
    markReadOnly(nparray);
  return reinterpret_cast<PyObject *>(nparray);
}
 
//-----------------------------------------------------------------------
// Explicit instantiations
//-----------------------------------------------------------------------
#define INSTANTIATE_WRAPNUMPY(ElementType)                                                                             \
  template MANTID_PYTHONINTERFACE_CORE_DLL PyObject *wrapWithNDArray<ElementType>(                                     \
      const ElementType *, const int ndims, Py_intptr_t *dims, const NumpyWrapMode mode, const OwnershipMode oMode);
 
INSTANTIATE_WRAPNUMPY(int)
INSTANTIATE_WRAPNUMPY(long)
INSTANTIATE_WRAPNUMPY(long long)
INSTANTIATE_WRAPNUMPY(unsigned int)
INSTANTIATE_WRAPNUMPY(unsigned long)
INSTANTIATE_WRAPNUMPY(unsigned long long)
INSTANTIATE_WRAPNUMPY(double)
INSTANTIATE_WRAPNUMPY(float)
} // namespace Impl
} // namespace Mantid::PythonInterface::Converters