PyArrayOfSets.hpp

Go to the documentation of this file.

/*
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * 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.
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#pragma once

// Source includes
#include "pythonForwardDeclarations.hpp"
#include "numpyHelpers.hpp"
#include "../ArrayOfSets.hpp"
#include "../Macros.hpp"
#include "../limits.hpp"
#include "../output.hpp"

// System includes
#include <string>
#include <memory>
#include <typeindex>

namespace LvArray
{
namespace python
{
namespace internal
{

class PyArrayOfSetsWrapperBase
{
public:

  virtual ~PyArrayOfSetsWrapperBase() = default;

  virtual int getAccessLevel() const
  { return m_accessLevel; }

  virtual void setAccessLevel( int const accessLevel ) = 0;

  virtual std::string repr() const = 0;

  virtual long long size() const = 0;

  virtual PyObject * operator[]( long long const setIndex ) = 0;

  virtual std::type_index valueType() const = 0;

  virtual void eraseSet( long long const setIndex ) = 0;

  virtual void insertSet( long long const setIndex, long long const capacity ) = 0;

  virtual long long removeFromSet( long long const setIndex, void const * const values, long long const numVals ) = 0;

  virtual long long insertIntoSet( long long const setIndex, void const * const values, long long const numVals ) = 0;

protected:

  PyArrayOfSetsWrapperBase():
    m_accessLevel( static_cast< int >( LvArray::python::PyModify::READ_ONLY ) )
  {}

  int m_accessLevel;
};

template< typename T,
          typename INDEX_TYPE,
          template< typename > class BUFFER_TYPE >
class PyArrayOfSetsWrapper final : public PyArrayOfSetsWrapperBase
{
public:

  PyArrayOfSetsWrapper( ArrayOfSets< T, INDEX_TYPE, BUFFER_TYPE > & arrayOfSets ):
    PyArrayOfSetsWrapperBase( ),
    m_arrayOfSets( arrayOfSets )
  {}

  virtual ~PyArrayOfSetsWrapper() = default;

  virtual void setAccessLevel( int const accessLevel ) final override
  {
    if( accessLevel >= static_cast< int >( LvArray::python::PyModify::RESIZEABLE ) )
    {
      // touch
    }
    m_accessLevel = accessLevel;
  }

  virtual std::string repr() const final override
  { return system::demangleType< ArrayOfSets< T, INDEX_TYPE, BUFFER_TYPE > >(); }

  virtual long long size() const final override
  { return integerConversion< long long >( m_arrayOfSets.size() ); }

  virtual PyObject * operator[]( long long const setIndex ) final override
  {
    INDEX_TYPE convertedIndex = integerConversion< INDEX_TYPE >( setIndex );
    ArraySlice< T const, 1, 0, INDEX_TYPE > slice = m_arrayOfSets[ convertedIndex ];
    T const * data = slice;
    constexpr INDEX_TYPE strides = 1;
    INDEX_TYPE size = slice.size();
    return createNumPyArray( data, false, 1, &size, &strides );
  }

  virtual std::type_index valueType() const final override
  { return std::type_index( typeid( T ) ); }

  virtual void eraseSet( long long const setIndex ) final override
  {
    INDEX_TYPE convertedIndex = integerConversion< INDEX_TYPE >( setIndex );
    m_arrayOfSets.eraseSet( convertedIndex );
  }

  virtual void insertSet( long long const setIndex, long long const capacity ) final override
  {
    INDEX_TYPE convertedIndex = integerConversion< INDEX_TYPE >( setIndex );
    INDEX_TYPE convertedCapacity = integerConversion< INDEX_TYPE >( capacity );
    m_arrayOfSets.insertSet( convertedIndex, convertedCapacity );
  }

  virtual long long removeFromSet( long long const setIndex,
                                   void const * const values,
                                   long long const numVals ) final override
  {
    INDEX_TYPE convertedIndex = integerConversion< INDEX_TYPE >( setIndex );
    T const * begin = static_cast< T const * >( values );
    T const * end = begin + numVals;
    return integerConversion< long long >( m_arrayOfSets.removeFromSet( convertedIndex, begin, end ) );
  }

  virtual long long insertIntoSet( long long const setIndex,
                                   void const * const values,
                                   long long const numVals ) final override
  {
    INDEX_TYPE convertedSetIndex = integerConversion< INDEX_TYPE >( setIndex );
    T const * begin = static_cast< T const * >( values );
    T const * end = begin + numVals;
    return integerConversion< long long >( m_arrayOfSets.insertIntoSet( convertedSetIndex, begin, end ) );
  }

private:
  ArrayOfSets< T, INDEX_TYPE, BUFFER_TYPE > & m_arrayOfSets;
};

PyObject * create( std::unique_ptr< internal::PyArrayOfSetsWrapperBase > && arrayOfSets );

} // namespace internal


template< typename T, typename INDEX_TYPE, template< typename > class BUFFER_TYPE >
std::enable_if_t< internal::canExportToNumpy< T >, PyObject * >
create( ArrayOfSets< T, INDEX_TYPE, BUFFER_TYPE > & arrayOfSets )
{
  auto tmp = std::make_unique< internal::PyArrayOfSetsWrapper< T, INDEX_TYPE, BUFFER_TYPE > >( arrayOfSets );
  return internal::create( std::move( tmp ) );
}

PyTypeObject * getPyArrayOfSetsType();

} // namespace python
} // namespace LvArray