/*

*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Copyright (c) 2019, Lawrence Livermore National Security, LLC.

*

* Produced at the Lawrence Livermore National Laboratory

*

* LLNL-CODE-746361

*

* All rights reserved. See COPYRIGHT for details.

*

* This file is part of the GEOSX Simulation Framework.

*

* GEOSX is a free software; you can redistribute it and/or modify it under

* the terms of the GNU Lesser General Public License (as published by the

* Free Software Foundation) version 2.1 dated February 1999.

*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*/

// Python must be the first include.

#define PY_SSIZE_T_CLEAN

#include <Python.h>

// Python include for converting struct attributes to Python objects

#include "structmember.h"

// Source includes

#include "PyArray.hpp"

#include "pythonHelpers.hpp"

#include "../limits.hpp"

// System includes

#pragma GCC diagnostic push

#pragma GCC diagnostic ignored "-Wcast-qual"

#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION

#include <numpy/arrayobject.h>

#pragma GCC diagnostic pop

/// @cond DO_NOT_DOCUMENT

namespace LvArray

{

namespace python

{

#define VERIFY_NON_NULL_SELF( self ) \

PYTHON_ERROR_IF( self == nullptr, PyExc_RuntimeError, "Passed a nullptr as self.", nullptr )

#define VERIFY_INITIALIZED( self ) \

PYTHON_ERROR_IF( self->array == nullptr, PyExc_RuntimeError, "The PyArray is not initialized.", nullptr )

#define VERIFY_RESIZEABLE( self ) \

PYTHON_ERROR_IF( self->array->getAccessLevel() < static_cast< int >( LvArray::python::PyModify::RESIZEABLE ), PyExc_RuntimeError, "The PyArray is not resizeable.", nullptr )

struct PyArray

{

PyObject_HEAD

static constexpr char const * docString =

"A Python interface to an LvArray::Array. Cannot be constructed in Python.\n\n"

"New instances must be returned from C modules.\n"

"The `dtype` attribute is the numpy.dtype of the underlying data.";

internal::PyArrayWrapperBase * array;

PyObject * numpyDtype;

};

/**

* @brief The Python destructor for PyArray.

* @param self The PyArray to destroy.

*/

static void PyArray_dealloc( PyArray * const self )

{ delete self->array; Py_XDECREF( self->numpyDtype ); }

/**

* @brief The Python __repr__ method for PyArray.

* @param self The PyArray to represent.

*/

static PyObject * PyArray_repr( PyObject * const obj )

{

PyArray * const self = convert< PyArray >( obj, getPyArrayType() );

if( self == nullptr )

{

return nullptr;

}

VERIFY_INITIALIZED( self );

std::string const repr = self->array->repr();

return PyUnicode_FromString( repr.c_str() );

}

static constexpr char const * PyArray_resizeDocString =

"resize(self, size)\n"

"--\n\n"

"Resize the default dimension.\n";

static PyObject * PyArray_resize( PyArray * const self, PyObject * const args )

{

VERIFY_NON_NULL_SELF( self );

VERIFY_INITIALIZED( self );

VERIFY_RESIZEABLE( self );

long newSize;

if( !PyArg_ParseTuple( args, "l", &newSize ) )

{

return nullptr;

}

PYTHON_ERROR_IF( newSize < 0, PyExc_ValueError, "Size must be positive.", nullptr );

self->array->resize( integerConversion< long long >( newSize ) );

Py_RETURN_NONE;

}

static constexpr char const * PyArray_resizeAllDocString =

"resize_all(self, new_dims)\n"

"--\n\n"

"Resize all of the dimensions in place, discarding values.\n\n";

static PyObject * PyArray_resizeAll( PyArray * const self, PyObject * const args )

{

VERIFY_NON_NULL_SELF( self );

VERIFY_INITIALIZED( self );

VERIFY_RESIZEABLE( self );

PyObject * obj;

if( !PyArg_ParseTuple( args, "O", &obj ) )

{

return nullptr;

}

std::tuple< PyObjectRef< PyObject >, void const *, long long > ret =

parseNumPyArray( obj, typeid( long long ) );

if( std::get< 0 >( ret ) == nullptr )

{

return nullptr;

}

PYTHON_ERROR_IF( std::get< 2 >( ret ) != self->array->ndim(), PyExc_RuntimeError,

"Invalid number of dimensions, should be " << self->array->ndim(), nullptr );

self->array->resize( reinterpret_cast< long long const * >( std::get< 1 >( ret ) ) );

Py_RETURN_NONE;

}

static constexpr char const * PyArray_toNumPyDocString =

"to_numpy(self)\n"

"--\n\n"

"Return a Numpy view of the instance.\n\n"

"The view can be modified if permissions\n"

"have been set to ``MODIFIABLE`` or ``RESIZEABLE``.";

static PyObject * PyArray_toNumPy( PyArray * const self, PyObject * const args )

{

LVARRAY_UNUSED_VARIABLE( args );

VERIFY_NON_NULL_SELF( self );

VERIFY_INITIALIZED( self );

return self->array->toNumPy();

}

static constexpr char const * PyArray_getAccessLevelDocString =

"get_access_level(self)\n"

"--\n\n"

"Return the read/write/resize permissions for the array.";

static PyObject * PyArray_getAccessLevel( PyArray * const self, PyObject * const args )

{

LVARRAY_UNUSED_VARIABLE( args );

VERIFY_NON_NULL_SELF( self );

VERIFY_INITIALIZED( self );

return PyLong_FromLong( self->array->getAccessLevel() );

}

static constexpr char const * PyArray_setAccessLevelDocString =

"set_access_level(self, level, space=pylvarray.CPU)\n"

"--\n\n"

"Set read/write/resize permissions for the instance.\n\n"

"If ``space`` is provided, move the instance to that space.";

static PyObject * PyArray_setAccessLevel( PyArray * const self, PyObject * const args )

{

VERIFY_NON_NULL_SELF( self );

VERIFY_INITIALIZED( self );

int newAccessLevel;

int newSpace = static_cast< int >( LvArray::MemorySpace::host );

if( !PyArg_ParseTuple( args, "i|i", &newAccessLevel, &newSpace ) )

{

return nullptr;

}

if( newSpace != static_cast< int >( LvArray::MemorySpace::host ) )

{

PyErr_SetString( PyExc_ValueError, "Invalid space" );

return nullptr;

}

self->array->setAccessLevel( newAccessLevel, newSpace );

Py_RETURN_NONE;

}

BEGIN_ALLOW_DESIGNATED_INITIALIZERS

static PyMemberDef PyArray_members[] = {

{"dtype", T_OBJECT_EX, offsetof( PyArray, numpyDtype ), READONLY,

"Numpy dtype of the object"},

{nullptr, 0, 0, 0, nullptr} /* Sentinel */

};

static PyMethodDef PyArray_methods[] = {

{ "resize", (PyCFunction) PyArray_resize, METH_VARARGS, PyArray_resizeDocString },

{ "resize_all", (PyCFunction) PyArray_resizeAll, METH_VARARGS, PyArray_resizeAllDocString },

{ "to_numpy", (PyCFunction) PyArray_toNumPy, METH_VARARGS, PyArray_toNumPyDocString },

{ "get_access_level", (PyCFunction) PyArray_getAccessLevel, METH_NOARGS, PyArray_getAccessLevelDocString },

{ "set_access_level", (PyCFunction) PyArray_setAccessLevel, METH_VARARGS, PyArray_setAccessLevelDocString },

{ nullptr, nullptr, 0, nullptr } // Sentinel

};

static PyTypeObject PyArrayType = {

PyVarObject_HEAD_INIT( nullptr, 0 )

.tp_name = "pylvarray.Array",

.tp_basicsize = sizeof( PyArray ),

.tp_itemsize = 0,

.tp_dealloc = (destructor) PyArray_dealloc,

.tp_repr = PyArray_repr,

.tp_flags = Py_TPFLAGS_DEFAULT,

.tp_doc = PyArray::docString,

.tp_methods = PyArray_methods,

.tp_members = PyArray_members,

.tp_new = PyType_GenericNew,

};

END_ALLOW_DESIGNATED_INITIALIZERS

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

PyTypeObject * getPyArrayType()

{ return &PyArrayType; }

namespace internal

{

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

PyObject * create( std::unique_ptr< PyArrayWrapperBase > && array )

{

// Create a new Group and set the dataRepository::Group it points to.

PyObject * const ret = PyObject_CallFunction( reinterpret_cast< PyObject * >( getPyArrayType() ), "" );

PyArray * const retArray = reinterpret_cast< PyArray * >( ret );

if( retArray == nullptr )

{

return nullptr;

}

PyObject * typeObject = getNumPyTypeObject( array->valueType() );

if( typeObject == nullptr )

{

return nullptr;

}

retArray->numpyDtype = typeObject;

retArray->array = array.release();

return ret;

}

} // namespace internal

} // namespace python

} // namespace LvArray

/// @endcond DO_NOT_DOCUMENT