OneDArrayToPython< T > Struct Template Reference

Convert for Array<OneD, T> to Python list of objects for numeric types T. More...

#include <SharedArray.hpp>

Static Public Member Functions
static PyObject *	convert (Array< OneD, T > const &arr)
template<typename U = T, std::enable_if_t< std::is_arithmetic< U >::value > * = nullptr>
static PyObject *	convert_impl (Array< OneD, U > const &arr)
template<typename U = T, std::enable_if_t< is_shared_ptr< U >::value||is_nekarray_oned< U >::value > * = nullptr>
static PyObject *	convert_impl (Array< OneD, U > const &arr)
	Converter function. This copies entries into the Python list and relies on internal boost converter being available for the shared_ptr type. More...

Detailed Description

template<typename T>
struct OneDArrayToPython< T >

Convert for Array<OneD, T> to Python list of objects for numeric types T.

Definition at line 93 of file Python/BasicUtils/SharedArray.hpp.

Member Function Documentation

convert()

template<typename T >

static PyObject * OneDArrayToPython< T >::convert ( Array< OneD, T > const &  arr )

inlinestatic

Definition at line 95 of file Python/BasicUtils/SharedArray.hpp.

    {
        return convert_impl(arr);
    }

References OneDArrayToPython< T >::convert_impl().

convert_impl() [1/2]

template<typename T >

template<typename U = T, std::enable_if_t< std::is_arithmetic< U >::value > * = nullptr>

static PyObject * OneDArrayToPython< T >::convert_impl ( Array< OneD, U > const &  arr )

inlinestatic

Definition at line 102 of file Python/BasicUtils/SharedArray.hpp.

    {
        // Create a Python capsule to hold a pointer that contains a lightweight
        // copy of arr. Uhat way we guarantee Python will still have access to
        // the memory allocated inside arr even if arr is deallocated in C++.
#if PY_MAJOR_VERSION == 2
        py::object capsule(py::handle<>(PyCObject_FromVoidPtr(
            new Array<OneD, U>(arr), CapsuleDestructor<U>)));
#else
        py::object capsule(py::handle<>(
            PyCapsule_New(new Array<OneD, U>(arr), nullptr,
                          (PyCapsule_Destructor)&CapsuleDestructor<U>)));
#endif
        PyObject *tmp =
            py::incref(np::from_data(arr.data(), np::dtype::get_builtin<U>(),
                                     py::make_tuple(arr.size()),
                                     py::make_tuple(sizeof(U)), capsule)
                           .ptr());
 
        return tmp;
    }

Referenced by OneDArrayToPython< T >::convert().

convert_impl() [2/2]

template<typename T >

template<typename U = T, std::enable_if_t< is_shared_ptr< U >::value||is_nekarray_oned< U >::value > * = nullptr>

static PyObject * OneDArrayToPython< T >::convert_impl ( Array< OneD, U > const &  arr )

inlinestatic

Converter function. This copies entries into the Python list and relies on internal boost converter being available for the shared_ptr type.

Definition at line 132 of file Python/BasicUtils/SharedArray.hpp.

    {
        py::list tmp;
        for (std::size_t i = 0; i < arr.size(); ++i)
        {
            tmp.append(arr[i]);
        }
 
        // Increment counter to avoid de-allocation of `tmp`.
        return py::incref(tmp.ptr());
    }