VTK  9.3.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtk::detail::ComponentIterator< ArrayType, TupleSize > Struct Template Reference

#include <vtkDataArrayTupleRange_Generic.h>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using value_type = APIType
 
using difference_type = ComponentIdType
 
using pointer = ComponentReference< ArrayType, TupleSize >
 
using reference = ComponentReference< ArrayType, TupleSize >
 

Public Member Functions

VTK_ITER_INLINE ComponentIterator () noexcept=default
 
VTK_ITER_INLINE ComponentIterator (ArrayType *array, NumCompsType numComps, TupleIdType tupleId, ComponentIdType comp) noexcept
 
VTK_ITER_INLINE ComponentIterator (const ComponentIterator &o) noexcept=default
 
VTK_ITER_INLINE ComponentIterator & operator= (const ComponentIterator &o) noexcept
 
VTK_ITER_INLINE ComponentIterator & operator++ () noexcept
 
VTK_ITER_INLINE ComponentIterator operator++ (int) noexcept
 
VTK_ITER_INLINE ComponentIterator & operator-- () noexcept
 
VTK_ITER_INLINE ComponentIterator operator-- (int) noexcept
 
VTK_ITER_INLINE reference operator[] (difference_type i) const noexcept
 
VTK_ITER_INLINE reference operator* () const noexcept
 
VTK_ITER_INLINE const pointer & operator-> () const noexcept
 
VTK_ITER_INLINE ComponentIterator & operator+= (difference_type offset) noexcept
 
VTK_ITER_INLINE ComponentIterator & operator-= (difference_type offset) noexcept
 

Protected Member Functions

ArrayType * GetArray () const noexcept
 
TupleIdType & GetTupleId () noexcept
 
const TupleIdType & GetTupleId () const noexcept
 
ComponentIdType & GetComponentId () noexcept
 
const ComponentIdType & GetComponentId () const noexcept
 
NumCompsType & GetNumComps () noexcept
 
const NumCompsType & GetNumComps () const noexcept
 

Protected Attributes

ComponentReference< ArrayType, TupleSize > Ref
 

Friends

struct ConstComponentIterator< ArrayType, TupleSize >
 
VTK_ITER_INLINE ComponentIterator operator+ (const ComponentIterator &it, difference_type offset) noexcept
 
VTK_ITER_INLINE ComponentIterator operator+ (difference_type offset, const ComponentIterator &it) noexcept
 
VTK_ITER_INLINE ComponentIterator operator- (const ComponentIterator &it, difference_type offset) noexcept
 
VTK_ITER_INLINE difference_type operator- (const ComponentIterator &it1, const ComponentIterator &it2) noexcept
 
VTK_ITER_INLINE void swap (ComponentIterator &lhs, ComponentIterator &rhs) noexcept
 

Detailed Description

template<typename ArrayType, ComponentIdType TupleSize>
struct vtk::detail::ComponentIterator< ArrayType, TupleSize >

Definition at line 549 of file vtkDataArrayTupleRange_Generic.h.

Member Typedef Documentation

◆ iterator_category

template<typename ArrayType , ComponentIdType TupleSize>
using vtk::detail::ComponentIterator< ArrayType, TupleSize >::iterator_category = std::random_access_iterator_tag

Definition at line 559 of file vtkDataArrayTupleRange_Generic.h.

◆ value_type

template<typename ArrayType , ComponentIdType TupleSize>
using vtk::detail::ComponentIterator< ArrayType, TupleSize >::value_type = APIType

Definition at line 560 of file vtkDataArrayTupleRange_Generic.h.

◆ difference_type

template<typename ArrayType , ComponentIdType TupleSize>
using vtk::detail::ComponentIterator< ArrayType, TupleSize >::difference_type = ComponentIdType

Definition at line 561 of file vtkDataArrayTupleRange_Generic.h.

◆ pointer

template<typename ArrayType , ComponentIdType TupleSize>
using vtk::detail::ComponentIterator< ArrayType, TupleSize >::pointer = ComponentReference<ArrayType, TupleSize>

Definition at line 562 of file vtkDataArrayTupleRange_Generic.h.

◆ reference

template<typename ArrayType , ComponentIdType TupleSize>
using vtk::detail::ComponentIterator< ArrayType, TupleSize >::reference = ComponentReference<ArrayType, TupleSize>

Definition at line 563 of file vtkDataArrayTupleRange_Generic.h.

Constructor & Destructor Documentation

◆ ComponentIterator() [1/3]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE vtk::detail::ComponentIterator< ArrayType, TupleSize >::ComponentIterator ( )
defaultnoexcept

◆ ComponentIterator() [2/3]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE vtk::detail::ComponentIterator< ArrayType, TupleSize >::ComponentIterator ( ArrayType *  array,
NumCompsType  numComps,
TupleIdType  tupleId,
ComponentIdType  comp 
)
inlinenoexcept

Definition at line 569 of file vtkDataArrayTupleRange_Generic.h.

◆ ComponentIterator() [3/3]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE vtk::detail::ComponentIterator< ArrayType, TupleSize >::ComponentIterator ( const ComponentIterator< ArrayType, TupleSize > &  o)
defaultnoexcept

Member Function Documentation

◆ operator=()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator= ( const ComponentIterator< ArrayType, TupleSize > &  o)
inlinenoexcept

Definition at line 585 of file vtkDataArrayTupleRange_Generic.h.

◆ operator++() [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator++ ( )
inlinenoexcept

Definition at line 592 of file vtkDataArrayTupleRange_Generic.h.

◆ operator++() [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator++ ( int  )
inlinenoexcept

Definition at line 601 of file vtkDataArrayTupleRange_Generic.h.

◆ operator--() [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator-- ( )
inlinenoexcept

Definition at line 608 of file vtkDataArrayTupleRange_Generic.h.

◆ operator--() [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator-- ( int  )
inlinenoexcept

Definition at line 617 of file vtkDataArrayTupleRange_Generic.h.

◆ operator[]()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE reference vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator[] ( difference_type  i) const
inlinenoexcept

Definition at line 624 of file vtkDataArrayTupleRange_Generic.h.

◆ operator*()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE reference vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator* ( ) const
inlinenoexcept

Definition at line 631 of file vtkDataArrayTupleRange_Generic.h.

◆ operator->()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE const pointer & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator-> ( ) const
inlinenoexcept

Definition at line 634 of file vtkDataArrayTupleRange_Generic.h.

◆ operator+=()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator+= ( difference_type  offset)
inlinenoexcept

Definition at line 659 of file vtkDataArrayTupleRange_Generic.h.

◆ operator-=()

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator & vtk::detail::ComponentIterator< ArrayType, TupleSize >::operator-= ( difference_type  offset)
inlinenoexcept

Definition at line 682 of file vtkDataArrayTupleRange_Generic.h.

◆ GetArray()

template<typename ArrayType , ComponentIdType TupleSize>
ArrayType * vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetArray ( ) const
inlineprotectednoexcept

Definition at line 725 of file vtkDataArrayTupleRange_Generic.h.

◆ GetTupleId() [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
TupleIdType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetTupleId ( )
inlineprotectednoexcept

Definition at line 726 of file vtkDataArrayTupleRange_Generic.h.

◆ GetTupleId() [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
const TupleIdType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetTupleId ( ) const
inlineprotectednoexcept

Definition at line 727 of file vtkDataArrayTupleRange_Generic.h.

◆ GetComponentId() [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
ComponentIdType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetComponentId ( )
inlineprotectednoexcept

Definition at line 728 of file vtkDataArrayTupleRange_Generic.h.

◆ GetComponentId() [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
const ComponentIdType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetComponentId ( ) const
inlineprotectednoexcept

Definition at line 729 of file vtkDataArrayTupleRange_Generic.h.

◆ GetNumComps() [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
NumCompsType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetNumComps ( )
inlineprotectednoexcept

Definition at line 730 of file vtkDataArrayTupleRange_Generic.h.

◆ GetNumComps() [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
const NumCompsType & vtk::detail::ComponentIterator< ArrayType, TupleSize >::GetNumComps ( ) const
inlineprotectednoexcept

Definition at line 731 of file vtkDataArrayTupleRange_Generic.h.

Friends And Related Symbol Documentation

◆ ConstComponentIterator< ArrayType, TupleSize >

template<typename ArrayType , ComponentIdType TupleSize>
friend struct ConstComponentIterator< ArrayType, TupleSize >
friend

Definition at line 709 of file vtkDataArrayTupleRange_Generic.h.

◆ operator+ [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator operator+ ( const ComponentIterator< ArrayType, TupleSize > &  it,
difference_type  offset 
)
friend

Definition at line 667 of file vtkDataArrayTupleRange_Generic.h.

◆ operator+ [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator operator+ ( difference_type  offset,
const ComponentIterator< ArrayType, TupleSize > &  it 
)
friend

Definition at line 674 of file vtkDataArrayTupleRange_Generic.h.

◆ operator- [1/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE ComponentIterator operator- ( const ComponentIterator< ArrayType, TupleSize > &  it,
difference_type  offset 
)
friend

Definition at line 690 of file vtkDataArrayTupleRange_Generic.h.

◆ operator- [2/2]

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE difference_type operator- ( const ComponentIterator< ArrayType, TupleSize > &  it1,
const ComponentIterator< ArrayType, TupleSize > &  it2 
)
friend

Definition at line 697 of file vtkDataArrayTupleRange_Generic.h.

◆ swap

template<typename ArrayType , ComponentIdType TupleSize>
VTK_ITER_INLINE void swap ( ComponentIterator< ArrayType, TupleSize > &  lhs,
ComponentIterator< ArrayType, TupleSize > &  rhs 
)
friend

Definition at line 709 of file vtkDataArrayTupleRange_Generic.h.

Member Data Documentation

◆ Ref

template<typename ArrayType , ComponentIdType TupleSize>
ComponentReference<ArrayType, TupleSize> vtk::detail::ComponentIterator< ArrayType, TupleSize >::Ref
protected

Definition at line 733 of file vtkDataArrayTupleRange_Generic.h.

The documentation for this struct was generated from the following file:
Generated on Sat Feb 15 2025 13:13:19 for VTK by doxygen 1.9.8