Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ItemVectorView Class Reference

View on a vector of entities. More...

#include <arcane/core/ItemVectorView.h>

Inheritance diagram for Arcane::ItemVectorView:
Collaboration diagram for Arcane::ItemVectorView:

Public Types

using const_iterator = ItemVectorViewConstIterator
using difference_type = std::ptrdiff_t
using value_type = Item
using reference_type = Item&
using const_reference_type = const Item&
using SentinelType = const_iterator

Public Member Functions

 ItemVectorView (const ItemInternalArrayView &aitems, const Int32ConstArrayView &local_ids)
 ItemVectorView (ItemInternalArrayView aitems, ItemIndexArrayView indexes)
 ItemVectorView (const ItemInternalVectorView &view)
 ItemVectorView (ItemInfoListView item_info_list_view, ConstArrayView< Int32 > local_ids)
 ItemVectorView (ItemInfoListView item_info_list_view, ItemIndexArrayView indexes)
 ItemVectorView (IItemFamily *family, ConstArrayView< Int32 > local_ids)
 ItemVectorView (IItemFamily *family, ItemIndexArrayView indexes)
 ItemVectorView (const impl::ItemIndexedListView< DynExtent > &view)
 ItemVectorView (const ItemConnectedListView< DynExtent > &v)
 operator ItemInternalVectorView () const
Item operator[] (Integer index) const
 Access the i-th element of the vector.
Int32 size () const
 Number of elements in the vector.
ItemInternalArrayView items () const
 Array of entities.
Int32ConstArrayView localIds () const
 Array of local IDs of entities.
void fillLocalIds (Array< Int32 > &ids) const
 Adds the list of localIds() of the vector to ids.
ItemVectorView subView (Integer abegin, Integer asize) const
 Sub-view starting from element abegin and containing asize elements.
const_iterator begin () const
SentinelType end () const
const_iterator endIterator () const
ItemIndexArrayView indexes () const
 View on the array of indices.
ItemEnumerator enumerator () const
void _internalSwigSet (ItemVectorViewPOD *vpod)

Protected Member Functions

 ItemVectorView (ItemSharedInfo *shared_info, const impl::ItemLocalIdListContainerView &local_ids)
 ItemVectorView (ItemSharedInfo *shared_info, ConstArrayView< Int32 > local_ids, Int32 local_id_offset)
 ItemVectorView (const ItemInternalArrayView &aitems, const Int32ConstArrayView &local_ids, bool)
 ItemVectorView (ItemInternalArrayView aitems, ItemIndexArrayView indexes, bool)
const Int32_localIdsData () const
Int32 _localIdOffset () const

Protected Attributes

ItemIndexArrayView m_index_view
ItemSharedInfom_shared_info = ItemSharedInfo::nullInstance()

Private Member Functions

void _init (ItemInternalArrayView items)
void _init2 (IItemFamily *family)

Private Attributes

friend ItemVector
friend ItemEnumeratorBase

Detailed Description

View on a vector of entities.

Warning
the view is only valid as long as the associated array is not modified and the entity family associated with this array is not modified itself.

Definition at line 239 of file ItemVectorView.h.

Member Typedef Documentation

◆ const_iterator

using Arcane::ItemVectorView::const_iterator = ItemVectorViewConstIterator

Definition at line 250 of file ItemVectorView.h.

◆ const_reference_type

using Arcane::ItemVectorView::const_reference_type = const Item&

Definition at line 254 of file ItemVectorView.h.

◆ difference_type

using Arcane::ItemVectorView::difference_type = std::ptrdiff_t

Definition at line 251 of file ItemVectorView.h.

◆ reference_type

using Arcane::ItemVectorView::reference_type = Item&

Definition at line 253 of file ItemVectorView.h.

◆ SentinelType

using Arcane::ItemVectorView::SentinelType = const_iterator

Definition at line 256 of file ItemVectorView.h.

◆ value_type

using Arcane::ItemVectorView::value_type = Item

Definition at line 252 of file ItemVectorView.h.

Constructor & Destructor Documentation

◆ ItemVectorView() [1/13]

Arcane::ItemVectorView::ItemVectorView ( const ItemInternalArrayView & aitems,
const Int32ConstArrayView & local_ids )
inline

Definition at line 261 of file ItemVectorView.h.

◆ ItemVectorView() [2/13]

Arcane::ItemVectorView::ItemVectorView ( ItemInternalArrayView aitems,
ItemIndexArrayView indexes )
inline

Definition at line 268 of file ItemVectorView.h.

◆ ItemVectorView() [3/13]

Arcane::ItemVectorView::ItemVectorView ( const ItemInternalVectorView & view)
inline

Definition at line 278 of file ItemVectorView.h.

◆ ItemVectorView() [4/13]

Arcane::ItemVectorView::ItemVectorView ( ItemInfoListView item_info_list_view,
ConstArrayView< Int32 > local_ids )
inline

Definition at line 283 of file ItemVectorView.h.

◆ ItemVectorView() [5/13]

Arcane::ItemVectorView::ItemVectorView ( ItemInfoListView item_info_list_view,
ItemIndexArrayView indexes )
inline

Definition at line 287 of file ItemVectorView.h.

◆ ItemVectorView() [6/13]

Arcane::ItemVectorView::ItemVectorView ( IItemFamily * family,
ConstArrayView< Int32 > local_ids )

Definition at line 27 of file ItemVectorView.cc.

◆ ItemVectorView() [7/13]

Arcane::ItemVectorView::ItemVectorView ( IItemFamily * family,
ItemIndexArrayView indexes )

Definition at line 37 of file ItemVectorView.cc.

◆ ItemVectorView() [8/13]

Arcane::ItemVectorView::ItemVectorView ( const impl::ItemIndexedListView< DynExtent > & view)
inline

Definition at line 293 of file ItemVectorView.h.

◆ ItemVectorView() [9/13]

Arcane::ItemVectorView::ItemVectorView ( const ItemConnectedListView< DynExtent > & v)
inline

Definition at line 299 of file ItemVectorView.h.

◆ ItemVectorView() [10/13]

Arcane::ItemVectorView::ItemVectorView ( ItemSharedInfo * shared_info,
const impl::ItemLocalIdListContainerView & local_ids )
inlineprotected

Definition at line 306 of file ItemVectorView.h.

◆ ItemVectorView() [11/13]

Arcane::ItemVectorView::ItemVectorView ( ItemSharedInfo * shared_info,
ConstArrayView< Int32 > local_ids,
Int32 local_id_offset )
inlineprotected

Definition at line 311 of file ItemVectorView.h.

◆ ItemVectorView() [12/13]

Arcane::ItemVectorView::ItemVectorView ( const ItemInternalArrayView & aitems,
const Int32ConstArrayView & local_ids,
bool  )
inlineprotected

Definition at line 318 of file ItemVectorView.h.

◆ ItemVectorView() [13/13]

Arcane::ItemVectorView::ItemVectorView ( ItemInternalArrayView aitems,
ItemIndexArrayView indexes,
bool  )
inlineprotected

Definition at line 326 of file ItemVectorView.h.

Member Function Documentation

◆ _init()

void Arcane::ItemVectorView::_init ( ItemInternalArrayView items)
inlineprivate

Definition at line 399 of file ItemVectorView.h.

◆ _init2()

void Arcane::ItemVectorView::_init2 ( IItemFamily * family)
private

Definition at line 47 of file ItemVectorView.cc.

◆ _internalSwigSet()

void Arcane::ItemVectorView::_internalSwigSet ( ItemVectorViewPOD * vpod)

Definition at line 109 of file ItemVectorView.cc.

◆ _localIdOffset()

Int32 Arcane::ItemVectorView::_localIdOffset ( ) const
inlineprotected

Definition at line 395 of file ItemVectorView.h.

◆ _localIdsData()

const Int32 * Arcane::ItemVectorView::_localIdsData ( ) const
inlineprotected

Definition at line 394 of file ItemVectorView.h.

◆ begin()

const_iterator Arcane::ItemVectorView::begin ( ) const
inline

Definition at line 368 of file ItemVectorView.h.

◆ end()

SentinelType Arcane::ItemVectorView::end ( ) const
inline

Definition at line 372 of file ItemVectorView.h.

◆ endIterator()

const_iterator Arcane::ItemVectorView::endIterator ( ) const
inline

Definition at line 376 of file ItemVectorView.h.

◆ enumerator()

ItemEnumerator Arcane::ItemVectorView::enumerator ( ) const
inline

Definition at line 337 of file ItemEnumerator.h.

◆ fillLocalIds()

void Arcane::ItemVectorView::fillLocalIds ( Array< Int32 > & ids) const

Adds the list of localIds() of the vector to ids.

Definition at line 61 of file ItemVectorView.cc.

Referenced by Arcane::FaceDirectionMng::_internalComputeInfos().

Here is the caller graph for this function:

◆ indexes()

ItemIndexArrayView Arcane::ItemVectorView::indexes ( ) const
inline

View on the array of indices.

Definition at line 381 of file ItemVectorView.h.

Referenced by Arcane::Loop::_InternalSimpleItemLoop().

Here is the caller graph for this function:

◆ items()

ItemInternalArrayView Arcane::ItemVectorView::items ( ) const
inline

Array of entities.

Definition at line 348 of file ItemVectorView.h.

References items().

Referenced by items().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ localIds()

Int32ConstArrayView Arcane::ItemVectorView::localIds ( ) const
inline

Array of local IDs of entities.

Deprecated
Do not retrieve the list of entities directly. It is preferable to use iterators or the method fillLocalIds() if you want to retrieve the list of localIds().

Definition at line 358 of file ItemVectorView.h.

Referenced by Arcane::Loop::_InternalSimpleItemLoop(), Arcane::Materials::MeshMaterialMng::checkValid(), Arcane::CartesianMeshCoarsening2::createCoarseCells(), Arcane::Materials::AllEnvData::forceRecompute(), Arcane::mesh::ItemsExchangeInfo2::removeSentItems(), and Arcane::mesh::ParticleFamily::setParticlesCell().

Here is the caller graph for this function:

◆ operator ItemInternalVectorView()

Arcane::ItemVectorView::operator ItemInternalVectorView ( ) const
inline

Definition at line 335 of file ItemVectorView.h.

◆ operator[]()

Item Arcane::ItemVectorView::operator[] ( Integer index) const
inline

Access the i-th element of the vector.

Definition at line 341 of file ItemVectorView.h.

◆ size()

◆ subView()

ItemVectorView Arcane::ItemVectorView::subView ( Integer abegin,
Integer asize ) const
inline

Sub-view starting from element abegin and containing asize elements.

Definition at line 364 of file ItemVectorView.h.

Member Data Documentation

◆ ItemEnumeratorBase

friend Arcane::ItemVectorView::ItemEnumeratorBase
private

Definition at line 245 of file ItemVectorView.h.

◆ ItemVector

friend Arcane::ItemVectorView::ItemVector
private

Definition at line 244 of file ItemVectorView.h.

◆ m_index_view

ItemIndexArrayView Arcane::ItemVectorView::m_index_view
protected

Definition at line 389 of file ItemVectorView.h.

◆ m_shared_info

ItemSharedInfo* Arcane::ItemVectorView::m_shared_info = ItemSharedInfo::nullInstance()
protected

Definition at line 390 of file ItemVectorView.h.


The documentation for this class was generated from the following files: