ItemVectorView.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ItemVectorView.h                                            (C) 2000-2024 */
/*                                                                           */
/* Vue sur un vecteur (tableau indirect) d'entités.                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITEMVECTORVIEW_H
#define ARCANE_CORE_ITEMVECTORVIEW_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ItemInternalVectorView.h"
#include "arcane/core/ItemIndexArrayView.h"
#include "arcane/core/ItemInfoListView.h"
#include "arcane/core/ItemConnectedListView.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
// Pour le wrapper C#
class ItemVectorViewPOD;
namespace mesh
{
class IndexedItemConnectivityAccessor;
}
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \internal
 * \brief Itérateur pour la classe ItemVectorView.
 *
 * Cette classe est interne à Arcane. Elle s'utilise via le for-range:
 *
 * \code
 * ItemVectorView view;
 * for( Item item : view )
 *    ;
 * \endcode
 */
class ItemVectorViewConstIterator
{
 protected:
 
  friend class ItemVectorView;
  template <int Extent> friend class ItemConnectedListView;
 
 protected:
 
  ItemVectorViewConstIterator(ItemSharedInfo* shared_info, const Int32* local_id_ptr, Int32 local_id_offset)
  : m_shared_info(shared_info)
  , m_local_id_ptr(local_id_ptr)
  , m_local_id_offset(local_id_offset)
  {}
  ItemVectorViewConstIterator(ItemSharedInfo* shared_info, const Int32* local_id_ptr)
  : m_shared_info(shared_info)
  , m_local_id_ptr(local_id_ptr)
  {}
 
 public:
 
  // Temporaire (01/2023) pour conversion avec nouveau type ItemConnectedListView
  ItemVectorViewConstIterator(const ItemConnectedListViewConstIterator& v)
  : m_shared_info(v.m_shared_info)
  , m_local_id_ptr(v.m_local_id_ptr)
  , m_local_id_offset(v.m_local_id_offset)
  {}
 
 public:
 
  typedef ItemVectorViewConstIterator ThatClass;
  typedef std::random_access_iterator_tag iterator_category;
  //! Type indexant le tableau
  typedef Item value_type;
  //! Type indexant le tableau
  typedef Integer size_type;
  //! Type d'une distance entre itérateur éléments du tableau
  typedef std::ptrdiff_t difference_type;
 
 public:
 
  //TODO A supprimer avec le C++20
  typedef const Item* pointer;
  //TODO A supprimer avec le C++20
  typedef const Item& reference;
 
 public:
 
  Item operator*() const { return Item(m_local_id_offset + (*m_local_id_ptr), m_shared_info); }
 
  ThatClass& operator++()
  {
    ++m_local_id_ptr;
    return (*this);
  }
  ThatClass& operator--()
  {
    --m_local_id_ptr;
    return (*this);
  }
  void operator+=(difference_type v) { m_local_id_ptr += v; }
  void operator-=(difference_type v) { m_local_id_ptr -= v; }
  difference_type operator-(const ThatClass& b) const
  {
    return this->m_local_id_ptr - b.m_local_id_ptr;
  }
  friend ThatClass operator-(const ThatClass& a, difference_type v)
  {
    const Int32* ptr = a.m_local_id_ptr - v;
    return ThatClass(a.m_shared_info, ptr, a.m_local_id_offset);
  }
  friend ThatClass operator+(const ThatClass& a, difference_type v)
  {
    const Int32* ptr = a.m_local_id_ptr + v;
    return ThatClass(a.m_shared_info, ptr, a.m_local_id_offset);
  }
  friend bool operator<(const ThatClass& lhs, const ThatClass& rhs)
  {
    return lhs.m_local_id_ptr <= rhs.m_local_id_ptr;
  }
  //! Compare les indices d'itération de deux instances
  friend bool operator==(const ThatClass& lhs, const ThatClass& rhs)
  {
    return lhs.m_local_id_ptr == rhs.m_local_id_ptr;
  }
  friend bool operator!=(const ThatClass& lhs, const ThatClass& rhs)
  {
    return !(lhs == rhs);
  }
 
  ARCANE_DEPRECATED_REASON("Y2022: This method returns a temporary. Use 'operator*' instead")
  Item operator->() const { return _itemInternal(); }
 
 protected:
 
  ItemSharedInfo* m_shared_info;
  const Int32* m_local_id_ptr;
  Int32 m_local_id_offset = 0;
 
 protected:
 
  inline ItemInternal* _itemInternal() const
  {
    return m_shared_info->m_items_internal[m_local_id_offset + (*m_local_id_ptr)];
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template<typename ItemType>
class ItemVectorViewConstIteratorT
: public ItemVectorViewConstIterator
{
  friend class ItemVectorViewT<ItemType>;
  friend class ItemConnectedListViewT<ItemType>;
 
 private:
 
  ItemVectorViewConstIteratorT(ItemSharedInfo* shared_info,const Int32* ARCANE_RESTRICT local_id_ptr,
                               Int32 local_id_offset)
  : ItemVectorViewConstIterator(shared_info,local_id_ptr,local_id_offset){}
  ItemVectorViewConstIteratorT(ItemSharedInfo* shared_info,const Int32* ARCANE_RESTRICT local_id_ptr)
  : ItemVectorViewConstIterator(shared_info,local_id_ptr){}
 
 public:
 
  // Temporaire (01/2023) pour conversion avec nouveau type ItemConnectedListView
  ItemVectorViewConstIteratorT(const ItemConnectedListViewConstIteratorT<ItemType>& v)
  : ItemVectorViewConstIterator(v){}
 
 public:
 
  typedef ItemVectorViewConstIteratorT<ItemType> ThatClass;
  typedef ItemType value_type;
 
 public:
 
  //TODO A supprimer avec le C++20
  typedef const Item* pointer;
  //TODO A supprimer avec le C++20
  typedef const Item& reference;
 
 public:
 
  ItemType operator*() const { return ItemType(m_local_id_offset + (*m_local_id_ptr), m_shared_info); }
 
  ThatClass& operator++() { ++m_local_id_ptr; return (*this); }
  ThatClass& operator--() { --m_local_id_ptr; return (*this); }
  difference_type operator-(const ThatClass& b) const
  {
    return this->m_local_id_ptr - b.m_local_id_ptr;
  }
  friend ThatClass operator-(const ThatClass& a, difference_type v)
  {
    const Int32* ptr = a.m_local_id_ptr - v;
    return ThatClass(a.m_shared_info, ptr, a.m_local_id_offset);
  }
  friend ThatClass operator+(const ThatClass& a, difference_type v)
  {
    const Int32* ptr = a.m_local_id_ptr + v;
    return ThatClass(a.m_shared_info, ptr, a.m_local_id_offset);
  }
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2022: This method returns a temporary. Use 'operator*' instead")
  ItemType operator->() const { return this->_itemInternal(); }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Vue sur un vecteur d'entités.
 *
 * \warning la vue n'est valide que tant que le tableau associé n'est
 * pas modifié et que la famille d'entité associée à ce tableau n'est
 * elle même pas modifiée.
 */
class ARCANE_CORE_EXPORT ItemVectorView
{
  // NOTE: Cette classe est mappée en C# et si on change sa structure il
  // faut mettre à jour la version C# correspondante.
 
  friend ItemVector;
  friend ItemEnumeratorBase;
  friend mesh::IndexedItemConnectivityAccessor;
 
 public:
 
  using const_iterator = ItemVectorViewConstIterator;
  using difference_type = std::ptrdiff_t;
  using value_type = Item;
  using reference_type = Item&;
  using const_reference_type = const Item&;
  // TODO: Créér le type 'Sentinel' lorsqu'on sera en C++20
  using SentinelType = const_iterator;
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2022: Use constructor with ItemInfoListView instead")
  ItemVectorView(const ItemInternalArrayView& aitems, const Int32ConstArrayView& local_ids)
  : m_index_view(local_ids)
  {
    _init(aitems);
  }
 
  ARCANE_DEPRECATED_REASON("Y2022: Use constructor with ItemInfoListView instead")
  ItemVectorView(ItemInternalArrayView aitems, ItemIndexArrayView indexes)
  : m_index_view(indexes)
  {
    _init(aitems);
  }
 
 public:
 
  ItemVectorView() = default;
  // TODO Rendre obsolète (3.11+)
  ItemVectorView(const ItemInternalVectorView& view)
  : m_index_view(view.localIds(),view.m_local_id_offset,0)
  , m_shared_info(view.m_shared_info)
  {}
  // TODO A supprimer
  ItemVectorView(ItemInfoListView item_info_list_view, ConstArrayView<Int32> local_ids)
  : m_index_view(local_ids,0,0)
  , m_shared_info(item_info_list_view.m_item_shared_info)
  {}
  ItemVectorView(ItemInfoListView item_info_list_view, ItemIndexArrayView indexes)
  : m_index_view(indexes)
  , m_shared_info(item_info_list_view.m_item_shared_info)
  {}
  ItemVectorView(IItemFamily* family, ConstArrayView<Int32> local_ids);
  ItemVectorView(IItemFamily* family, ItemIndexArrayView indexes);
  ItemVectorView(const impl::ItemIndexedListView<DynExtent>& view)
  : m_index_view(view.constLocalIds(),view.m_local_id_offset,0)
  , m_shared_info(view.m_shared_info)
  {}
 
  // Temporaire (01/2023) pour conversion avec nouveau type ItemConnectedListView
  ItemVectorView(const ItemConnectedListView<DynExtent>& v)
  : m_index_view(v.m_index_view)
  , m_shared_info(v.m_shared_info)
  {}
 
 protected:
 
  ItemVectorView(ItemSharedInfo* shared_info, const impl::ItemLocalIdListContainerView& local_ids)
  : m_index_view(local_ids)
  , m_shared_info(shared_info)
  {}
 
  ItemVectorView(ItemSharedInfo* shared_info, ConstArrayView<Int32> local_ids, Int32 local_id_offset)
  : m_index_view(local_ids,local_id_offset,0)
  , m_shared_info(shared_info)
  {}
 
  // Temporaire pour éviter un avertissement de compilation lorsqu'on utilise le
  // constructeur obsolète de ItemVectorViewT
  ItemVectorView(const ItemInternalArrayView& aitems, const Int32ConstArrayView& local_ids, bool)
  : m_index_view(local_ids)
  {
    _init(aitems);
  }
 
  // Temporaire pour éviter un avertissement de compilation lorsqu'on utilise le
  // constructeur obsolète de ItemVectorViewT
  ItemVectorView(ItemInternalArrayView aitems, ItemIndexArrayView indexes, bool)
  : m_index_view(indexes)
  {
    _init(aitems);
  }
 
 public:
 
  // TODO: a supprimer
  operator ItemInternalVectorView() const
  {
    return ItemInternalVectorView(m_shared_info, m_index_view._localIds(), _localIdOffset());
  }
 
  //! Accède au \a i-ème élément du vecteur
  Item operator[](Integer index) const { return Item(m_index_view[index], m_shared_info); }
 
  //! Nombre d'éléments du vecteur
  Int32 size() const { return m_index_view.size(); }
 
  //! Tableau des entités
  ARCANE_DEPRECATED_REASON("Y2022: Do not use this method")
  ItemInternalArrayView items() const { return m_shared_info->m_items_internal; }
 
  // TODO Rendre obsolète (3.11+)
  /*!
   * \brief Tableau des numéros locaux des entités.
   *
   * \deprecated Ne pas récupérer directement la liste des entités.
   * Il est préférable de passer par des itérateurs ou par la méthode
   * fillLocalIds() si on souhaite récupérer la liste des localId().
   */
  Int32ConstArrayView localIds() const { return m_index_view._localIds(); }
 
  //! Ajoute à \a ids la liste des localIds() du vecteur.
  void fillLocalIds(Array<Int32>& ids) const;
 
  //! Sous-vue à partir de l'élément \a abegin et contenant \a asize éléments
  ItemVectorView subView(Integer abegin, Integer asize) const
  {
    return ItemVectorView(m_shared_info, m_index_view.subView(abegin, asize)._localIds(), _localIdOffset());
  }
  const_iterator begin() const
  {
    return const_iterator(m_shared_info, m_index_view._data(), _localIdOffset());
  }
  SentinelType end() const
  {
    return endIterator();
  }
  const_iterator endIterator() const
  {
    return const_iterator(m_shared_info, (m_index_view._data() + this->size()), _localIdOffset());
  }
  //! Vue sur le tableau des indices
  ItemIndexArrayView indexes() const { return m_index_view; }
 
 public:
 
  inline ItemEnumerator enumerator() const;
 
 protected:
 
  ItemIndexArrayView m_index_view;
  ItemSharedInfo* m_shared_info = ItemSharedInfo::nullInstance();
 
 protected:
 
  const Int32* _localIdsData() const { return m_index_view._data(); }
  Int32 _localIdOffset() const { return m_index_view._localIdOffset(); }
 
 private:
 
  void _init(ItemInternalArrayView items)
  {
    m_shared_info = (size() > 0 && !items.empty()) ? ItemInternalCompatibility::_getSharedInfo(items[0]) : ItemSharedInfo::nullInstance();
  }
  void _init2(IItemFamily* family);
 
 public:
 
  // Pour SWIG pour positionner les valeurs l'instance POD
  void _internalSwigSet(ItemVectorViewPOD* vpod);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Vue sur un tableau typé d'entités.
 */
template<typename ItemType>
class ItemVectorViewT
: public ItemVectorView
{
  friend class ItemVectorT<ItemType>;
  friend class ItemConnectedListViewT<ItemType>;
 
 public:
 
  using const_iterator = ItemVectorViewConstIteratorT<ItemType>;
  using difference_type = std::ptrdiff_t;
  using value_type = ItemType;
  //TODO a supprimer avec le C++20
  using reference_type = ItemType&;
  //TODO a supprimer avec le C++20
  using const_reference_type = const ItemType&;
  // TODO: Créér le type 'Sentinel' lorsqu'on sera en C++20
  using SentinelType = const_iterator;
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2022: Use constructor with ItemInfoListView instead")
  ItemVectorViewT(const ItemInternalArrayView& aitems,const Int32ConstArrayView& local_ids)
  : ItemVectorView(aitems,local_ids,true) {}
 
  ARCANE_DEPRECATED_REASON("Y2022: Use constructor with ItemInfoListView instead")
  ItemVectorViewT(ItemInternalArrayView aitems,ItemIndexArrayView indexes)
  : ItemVectorView(aitems,indexes,true) {}
 
 public:
 
  ItemVectorViewT() = default;
  ItemVectorViewT(const ItemVectorView& rhs)
  : ItemVectorView(rhs) {}
  inline ItemVectorViewT(const ItemVectorT<ItemType>& rhs);
  ItemVectorViewT(const ItemInternalVectorView& rhs)
  : ItemVectorView(rhs) {}
  ItemVectorViewT(const impl::ItemIndexedListView<DynExtent>& rhs)
  : ItemVectorView(rhs) {}
  ItemVectorViewT(ItemInfoListView item_info_list_view,ConstArrayView<Int32> local_ids)
  : ItemVectorView(item_info_list_view,local_ids) {}
  ItemVectorViewT(ItemInfoListView item_info_list_view,ItemIndexArrayView indexes)
  : ItemVectorView(item_info_list_view,indexes) {}
  ItemVectorViewT(IItemFamily* family,ConstArrayView<Int32> local_ids)
  : ItemVectorView(family,local_ids) {}
  ItemVectorViewT(IItemFamily* family,ItemIndexArrayView indexes)
  : ItemVectorView(family,indexes) {}
 
  // Temporaire (01/2023) pour conversion avec nouveau type ItemConnectedListView
  ItemVectorViewT(const ItemConnectedListViewT<ItemType>& v)
  : ItemVectorView(v){}
 
 protected:
 
  ItemVectorViewT(ItemSharedInfo* shared_info,ConstArrayView<Int32> local_ids,Int32 local_id_offset)
  : ItemVectorView(shared_info,local_ids,local_id_offset) { }
 
 public:
 
  ItemType operator[](Integer index) const
  {
    return ItemType(m_index_view[index],m_shared_info);
  }
 
 public:
  
  inline ItemEnumeratorT<ItemType> enumerator() const
  {
    return ItemEnumeratorT<ItemType>(m_shared_info,m_index_view.m_view);
  }
  inline const_iterator begin() const
  {
    return const_iterator(m_shared_info, _localIdsData(), _localIdOffset());
  }
  inline SentinelType end() const
  {
    return const_iterator(m_shared_info, _localIdsData() + this->size(), _localIdOffset());
  }
  inline const_iterator endIterator() const
  {
    return const_iterator(m_shared_info, _localIdsData() + this->size(), _localIdOffset());
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif