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

#include <itkVectorContainer.h>

Detailed Description

template<typename TElementIdentifier, typename TElement>
class itk::VectorContainer< TElementIdentifier, TElement >::Iterator

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

Definition at line 151 of file itkVectorContainer.h.

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

Public Types

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

Public Member Functions

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

Private Attributes

VectorIterator m_Iter {}
 
size_type m_Pos {}
 

Friends

class ConstIterator
 

Member Typedef Documentation

◆ difference_type

template<typename TElementIdentifier, typename TElement>
using itk::VectorContainer< TElementIdentifier, TElement >::Iterator::difference_type = typename VectorIterator::difference_type

Definition at line 156 of file itkVectorContainer.h.

◆ iterator_category

template<typename TElementIdentifier, typename TElement>
using itk::VectorContainer< TElementIdentifier, TElement >::Iterator::iterator_category = typename VectorIterator::iterator_category

Definition at line 154 of file itkVectorContainer.h.

◆ pointer

template<typename TElementIdentifier, typename TElement>
using itk::VectorContainer< TElementIdentifier, TElement >::Iterator::pointer = typename VectorIterator::pointer

Definition at line 157 of file itkVectorContainer.h.

◆ reference

template<typename TElementIdentifier, typename TElement>
using itk::VectorContainer< TElementIdentifier, TElement >::Iterator::reference = typename VectorIterator::reference

Definition at line 158 of file itkVectorContainer.h.

◆ value_type

template<typename TElementIdentifier, typename TElement>
using itk::VectorContainer< TElementIdentifier, TElement >::Iterator::value_type = typename VectorIterator::value_type

Definition at line 155 of file itkVectorContainer.h.

Constructor & Destructor Documentation

◆ Iterator() [1/2]

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

◆ Iterator() [2/2]

template<typename TElementIdentifier, typename TElement>
itk::VectorContainer< TElementIdentifier, TElement >::Iterator::Iterator ( size_type  d,
const VectorIterator &  i 
)
inline

Definition at line 161 of file itkVectorContainer.h.

Member Function Documentation

◆ Index()

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

Get the index into the VectorContainer associated with this iterator.

Definition at line 252 of file itkVectorContainer.h.

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION() [1/2]

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

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION() [2/2]

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

◆ operator*()

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

Definition at line 165 of file itkVectorContainer.h.

◆ operator++() [1/2]

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

Definition at line 168 of file itkVectorContainer.h.

◆ operator++() [2/2]

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

Definition at line 175 of file itkVectorContainer.h.

◆ operator+=()

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

Definition at line 242 of file itkVectorContainer.h.

◆ operator-()

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

Definition at line 199 of file itkVectorContainer.h.

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

◆ operator--() [1/2]

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

Definition at line 183 of file itkVectorContainer.h.

◆ operator--() [2/2]

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

Definition at line 190 of file itkVectorContainer.h.

◆ operator->()

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

Definition at line 166 of file itkVectorContainer.h.

◆ operator<()

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

Definition at line 221 of file itkVectorContainer.h.

◆ operator<=()

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

Definition at line 236 of file itkVectorContainer.h.

◆ operator==() [1/2]

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

Definition at line 213 of file itkVectorContainer.h.

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

◆ operator==() [2/2]

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

Definition at line 205 of file itkVectorContainer.h.

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

◆ operator>()

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

Definition at line 226 of file itkVectorContainer.h.

◆ operator>=()

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

Definition at line 231 of file itkVectorContainer.h.

◆ Value()

template<typename TElementIdentifier, typename TElement>
reference itk::VectorContainer< TElementIdentifier, TElement >::Iterator::Value ( ) const
inline

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

Definition at line 259 of file itkVectorContainer.h.

Friends And Related Function Documentation

◆ ConstIterator

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

Definition at line 267 of file itkVectorContainer.h.

Member Data Documentation

◆ m_Iter

template<typename TElementIdentifier, typename TElement>
VectorIterator itk::VectorContainer< TElementIdentifier, TElement >::Iterator::m_Iter {}
private

Definition at line 266 of file itkVectorContainer.h.

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

◆ m_Pos

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

Definition at line 265 of file itkVectorContainer.h.

Referenced by itk::VectorContainer< TElementIdentifier, TElement >::Iterator::operator-(), and itk::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.8.16