ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator Class Reference
Group Core » Module ITKCommon

#include <itkVectorContainer.h>

Detailed Description

template<typename TElementIdentifier, typename TElement>
class itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator

Simulate STL-map style const iteration where dereferencing the iterator gives read access to both the index and the value.

Definition at line 278 of file itkVectorContainer.h.

+ Collaboration diagram for itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator:

Public Types

using difference_type = typename VectorConstIterator::difference_type
 
using iterator_category = typename VectorConstIterator::iterator_category
 
using pointer = typename VectorConstIterator::pointer
 
using reference = typename VectorConstIterator::reference
 
using value_type = typename VectorConstIterator::value_type
 

Public Member Functions

 ConstIterator ()=default
 
 ConstIterator (const Iterator &r)
 
 ConstIterator (size_type d, const VectorConstIterator &i)
 
ElementIdentifier Index () const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (ConstIterator)
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Iterator)
 
ConstIterator & operator* ()
 
ConstIterator & operator++ ()
 
ConstIterator operator++ (int)
 
ConstIterator & operator+= (difference_type n)
 
difference_type operator- (const ConstIterator &r) const
 
ConstIterator & operator-- ()
 
ConstIterator operator-- (int)
 
ConstIterator * operator-> ()
 
bool operator< (const ConstIterator &r) const
 
bool operator<= (const ConstIterator &r) const
 
ConstIterator & operator= (const Iterator &r)
 
bool operator== (const ConstIterator &r) const
 
bool operator== (const Iterator &r) const
 
bool operator> (const ConstIterator &r) const
 
bool operator>= (const ConstIterator &r) const
 
const_reference Value () const
 

Private Attributes

VectorConstIterator m_Iter {}
 
size_type m_Pos {}
 

Friends

class Iterator
 

Member Typedef Documentation

◆ difference_type

template<typename TElementIdentifier , typename TElement >
using itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::difference_type = typename VectorConstIterator::difference_type

Definition at line 283 of file itkVectorContainer.h.

◆ iterator_category

template<typename TElementIdentifier , typename TElement >
using itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::iterator_category = typename VectorConstIterator::iterator_category

Definition at line 281 of file itkVectorContainer.h.

◆ pointer

template<typename TElementIdentifier , typename TElement >
using itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::pointer = typename VectorConstIterator::pointer

Definition at line 284 of file itkVectorContainer.h.

◆ reference

template<typename TElementIdentifier , typename TElement >
using itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::reference = typename VectorConstIterator::reference

Definition at line 285 of file itkVectorContainer.h.

◆ value_type

template<typename TElementIdentifier , typename TElement >
using itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::value_type = typename VectorConstIterator::value_type

Definition at line 282 of file itkVectorContainer.h.

Constructor & Destructor Documentation

◆ ConstIterator() [1/3]

template<typename TElementIdentifier , typename TElement >
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::ConstIterator ( )
default

◆ ConstIterator() [2/3]

template<typename TElementIdentifier , typename TElement >
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::ConstIterator ( size_type  d,
const VectorConstIterator &  i 
)
inline

Definition at line 288 of file itkVectorContainer.h.

◆ ConstIterator() [3/3]

template<typename TElementIdentifier , typename TElement >
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::ConstIterator ( const Iterator &  r)
inline

Definition at line 292 of file itkVectorContainer.h.

Member Function Documentation

◆ Index()

template<typename TElementIdentifier , typename TElement >
ElementIdentifier itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::Index ( ) const
inline

Get the index into the VectorContainer associated with this iterator.

Definition at line 390 of file itkVectorContainer.h.

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION() [1/2]

template<typename TElementIdentifier , typename TElement >
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( ConstIterator  )

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION() [2/2]

template<typename TElementIdentifier , typename TElement >
itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( Iterator  )

◆ operator*()

template<typename TElementIdentifier , typename TElement >
ConstIterator & itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator* ( )
inline

Definition at line 296 of file itkVectorContainer.h.

◆ operator++() [1/2]

template<typename TElementIdentifier , typename TElement >
ConstIterator & itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator++ ( )
inline

Definition at line 299 of file itkVectorContainer.h.

◆ operator++() [2/2]

template<typename TElementIdentifier , typename TElement >
ConstIterator itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator++ ( int  )
inline

Definition at line 306 of file itkVectorContainer.h.

◆ operator+=()

template<typename TElementIdentifier , typename TElement >
ConstIterator & itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator+= ( difference_type  n)
inline

Definition at line 336 of file itkVectorContainer.h.

◆ operator-()

template<typename TElementIdentifier , typename TElement >
difference_type itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator- ( const ConstIterator &  r) const
inline

Definition at line 344 of file itkVectorContainer.h.

References itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::m_Pos.

◆ operator--() [1/2]

template<typename TElementIdentifier , typename TElement >
ConstIterator & itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator-- ( )
inline

Definition at line 314 of file itkVectorContainer.h.

◆ operator--() [2/2]

template<typename TElementIdentifier , typename TElement >
ConstIterator itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator-- ( int  )
inline

Definition at line 321 of file itkVectorContainer.h.

◆ operator->()

template<typename TElementIdentifier , typename TElement >
ConstIterator * itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator-> ( )
inline

Definition at line 297 of file itkVectorContainer.h.

◆ operator<()

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator< ( const ConstIterator &  r) const
inline

Definition at line 365 of file itkVectorContainer.h.

◆ operator<=()

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator<= ( const ConstIterator &  r) const
inline

Definition at line 375 of file itkVectorContainer.h.

◆ operator=()

template<typename TElementIdentifier , typename TElement >
ConstIterator & itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator= ( const Iterator &  r)
inline

Definition at line 329 of file itkVectorContainer.h.

References itk::detail::VectorContainer< TElementIdentifier, TElement >::Iterator::m_Iter, and itk::detail::VectorContainer< TElementIdentifier, TElement >::Iterator::m_Pos.

◆ operator==() [1/2]

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator== ( const ConstIterator &  r) const
inline

Definition at line 358 of file itkVectorContainer.h.

References itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::m_Iter.

◆ operator==() [2/2]

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator== ( const Iterator &  r) const
inline

Definition at line 350 of file itkVectorContainer.h.

References itk::detail::VectorContainer< TElementIdentifier, TElement >::Iterator::m_Iter.

◆ operator>()

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator> ( const ConstIterator &  r) const
inline

Definition at line 371 of file itkVectorContainer.h.

◆ operator>=()

template<typename TElementIdentifier , typename TElement >
bool itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator>= ( const ConstIterator &  r) const
inline

Definition at line 381 of file itkVectorContainer.h.

◆ Value()

template<typename TElementIdentifier , typename TElement >
const_reference itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::Value ( ) const
inline

Get the value at this iterator's location in the VectorContainer.

Definition at line 397 of file itkVectorContainer.h.

Friends And Related Function Documentation

◆ Iterator

template<typename TElementIdentifier , typename TElement >
friend class Iterator
friend

Definition at line 405 of file itkVectorContainer.h.

Member Data Documentation

◆ m_Iter

template<typename TElementIdentifier , typename TElement >
VectorConstIterator itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::m_Iter {}
private

Definition at line 404 of file itkVectorContainer.h.

Referenced by itk::detail::VectorContainer< TElementIdentifier, TElement >::Iterator::operator==(), and itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator==().

◆ m_Pos

template<typename TElementIdentifier , typename TElement >
size_type itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::m_Pos {}
private

Definition at line 403 of file itkVectorContainer.h.

Referenced by itk::detail::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator-().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3