WrapWithNDArray.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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
 
#include "MantidKernel/System.h"
#include <boost/python/detail/prefix.hpp>
#include <vector>
 
namespace Mantid {
namespace PythonInterface {
namespace Converters {
enum NumpyWrapMode { ReadOnly, ReadWrite };
enum OwnershipMode { Cpp, Python };
 
namespace Impl {
// Forward declare a conversion function. This should be specialized for each
// container type that is to be wrapped
template <typename ElementType>
PyObject *wrapWithNDArray(const ElementType *, const int ndims, Py_intptr_t *dims, const NumpyWrapMode mode,
                          const OwnershipMode oMode = OwnershipMode::Cpp);
} // namespace Impl
 
struct WrapReadOnly {
 
  template <typename ElementType> struct apply {
    static PyObject *create1D(const std::vector<ElementType> &cdata) {
      Py_intptr_t dims[1] = {static_cast<int>(cdata.size())};
      return createFromArray(cdata.data(), 1, dims);
    }
    static PyObject *createFromArray(const ElementType *cdata, const int ndims, Py_intptr_t *dims) {
      return Impl::wrapWithNDArray(cdata, ndims, dims, ReadOnly);
    }
  };
};
 
struct WrapReadWrite {
 
  template <typename ElementType> struct apply {
 
    static PyObject *create1D(const std::vector<ElementType> &cdata) {
      Py_intptr_t dims[1] = {static_cast<int>(cdata.size())};
      return createFromArray(cdata.data(), 1, dims);
    }
    static PyObject *createFromArray(const ElementType *cdata, const int ndims, Py_intptr_t *dims) {
      return Impl::wrapWithNDArray(cdata, ndims, dims, ReadWrite);
    }
  };
};
} // namespace Converters
} // namespace PythonInterface
} // namespace Mantid