Detailed Description

template<typename TImage>
template<bool VIsConst>
class itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >

Iterator class that is either 'const' or non-const qualified. A non-const qualified instantiation of this template allows the pixel that it points to, to be modified. A const qualified instantiation does not.

Note: The definition of this class is private. Please use its type alias ImageBufferRange::iterator, or ImageBufferRange::const_iterator!

See also: ImageBufferRange

Definition at line 227 of file itkImageBufferRange.h.

Classes
class	PixelReferenceWrapper

Public Types
using	difference_type = ptrdiff_t

using	iterator_category = std::random_access_iterator_tag

using	pointer = QualifiedPixelType *

using	reference = std::conditional_t< SupportsDirectPixelAccess, QualifiedPixelType &, PixelProxy< IsImageTypeConst > >

using	value_type = PixelType

Public Member Functions
reference	operator* () const noexcept

reference	operator[] (const difference_type n) const noexcept

	QualifiedIterator ()=default


template<bool VIsArgumentConst, typename = std::enable_if_t<VIsConst && !VIsArgumentConst>>
	QualifiedIterator (const QualifiedIterator< VIsArgumentConst > &arg) noexcept


QualifiedIterator &	operator++ () noexcept


QualifiedIterator	operator++ (int) noexcept


QualifiedIterator &	operator-- () noexcept


QualifiedIterator	operator-- (int) noexcept

Private Types
using	QualifiedImageType = std::conditional_t< VIsConst, const TImage, TImage >

using	QualifiedInternalPixelType = std::conditional_t< IsImageTypeConst, const InternalPixelType, InternalPixelType >

using	QualifiedPixelType = std::conditional_t< IsImageTypeConst, const PixelType, PixelType >

Private Member Functions
	QualifiedIterator (const OptionalAccessorFunctorType &accessorFunctor, QualifiedInternalPixelType *const internalPixelPointer) noexcept

Private Attributes
QualifiedInternalPixelType *	m_InternalPixelPointer = nullptr

OptionalAccessorFunctorType	m_OptionalAccessorFunctor

Static Private Attributes
static constexpr bool	IsImageTypeConst = std::is_const_v<QualifiedImageType>

Friends
class	ImageBufferRange

bool	operator!= (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

QualifiedIterator	operator+ (const difference_type n, QualifiedIterator it) noexcept

QualifiedIterator	operator+ (QualifiedIterator it, const difference_type n) noexcept

difference_type	operator- (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

QualifiedIterator	operator- (QualifiedIterator it, const difference_type n) noexcept

bool	operator< (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

bool	operator<= (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

bool	operator== (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

bool	operator> (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

bool	operator>= (const QualifiedIterator &lhs, const QualifiedIterator &rhs) noexcept

class	QualifiedIterator<!VIsConst >


QualifiedIterator &	operator+= (QualifiedIterator &it, const difference_type n) noexcept


QualifiedIterator &	operator-= (QualifiedIterator &it, const difference_type n) noexcept

Member Typedef Documentation

◆ difference_type

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::difference_type = ptrdiff_t

Definition at line 292 of file itkImageBufferRange.h.

◆ iterator_category

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::iterator_category = std::random_access_iterator_tag

Definition at line 296 of file itkImageBufferRange.h.

◆ pointer

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::pointer = QualifiedPixelType *

Definition at line 295 of file itkImageBufferRange.h.

◆ QualifiedImageType

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedImageType = std::conditional_t<VIsConst, const TImage, TImage>

private

Definition at line 239 of file itkImageBufferRange.h.

◆ QualifiedInternalPixelType

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedInternalPixelType = std::conditional_t<IsImageTypeConst, const InternalPixelType, InternalPixelType>

private

Definition at line 243 of file itkImageBufferRange.h.

◆ QualifiedPixelType

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedPixelType = std::conditional_t<IsImageTypeConst, const PixelType, PixelType>

private

Definition at line 246 of file itkImageBufferRange.h.

◆ reference

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::reference = std::conditional_t<SupportsDirectPixelAccess, QualifiedPixelType &, PixelProxy<IsImageTypeConst> >

Definition at line 294 of file itkImageBufferRange.h.

◆ value_type

template<typename TImage >

template<bool VIsConst>

using itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::value_type = PixelType

Definition at line 293 of file itkImageBufferRange.h.

Constructor & Destructor Documentation

◆ QualifiedIterator() [1/3]

template<typename TImage >

template<bool VIsConst>

itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedIterator	(	const OptionalAccessorFunctorType &	accessorFunctor,
		QualifiedInternalPixelType *const	internalPixelPointer
	)

inlineprivatenoexcept

Definition at line 282 of file itkImageBufferRange.h.

◆ QualifiedIterator() [2/3]

template<typename TImage >

template<bool VIsConst>

itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedIterator ( )

default

Default-constructor, as required for any C++11 Forward Iterator. Offers the guarantee added to the C++14 Standard: "value-initialized iterators may be compared and shall compare equal to other value-initialized iterators of the same type."

Note: The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero".

◆ QualifiedIterator() [3/3]

template<typename TImage >

template<bool VIsConst>

template<bool VIsArgumentConst, typename = std::enable_if_t<VIsConst && !VIsArgumentConst>>

itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::QualifiedIterator ( const QualifiedIterator< VIsArgumentConst > & arg )

inlinenoexcept

Constructor for implicit conversion from non-const to const iterator.

Definition at line 311 of file itkImageBufferRange.h.

Member Function Documentation

◆ operator*()

template<typename TImage >

template<bool VIsConst>

reference itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator* ( ) const

inlinenoexcept

Returns a reference to the current pixel.

Definition at line 321 of file itkImageBufferRange.h.

References itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_InternalPixelPointer, and itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_OptionalAccessorFunctor.

◆ operator++() [1/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator & itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator++ ( )

inlinenoexcept

Prefix increment ('++it').

Definition at line 333 of file itkImageBufferRange.h.

References itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_InternalPixelPointer.

◆ operator++() [2/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator++ ( int )

inlinenoexcept

Postfix increment ('it++').

Note: Usually prefix increment ('++it') is preferable.

Definition at line 345 of file itkImageBufferRange.h.

◆ operator--() [1/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator & itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator-- ( )

inlinenoexcept

Prefix decrement ('–it').

Definition at line 356 of file itkImageBufferRange.h.

References itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_InternalPixelPointer.

◆ operator--() [2/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator-- ( int )

inlinenoexcept

Postfix increment ('it–').

Note: Usually prefix increment ('–it') is preferable.

Definition at line 368 of file itkImageBufferRange.h.

◆ operator[]()

template<typename TImage >

template<bool VIsConst>

reference itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator[] ( const difference_type n ) const

inlinenoexcept

Returns it[n] for iterator 'it' and integer value 'n'.

Definition at line 482 of file itkImageBufferRange.h.

Friends And Related Function Documentation

◆ ImageBufferRange

template<typename TImage >

template<bool VIsConst>

friend class ImageBufferRange

friend

Definition at line 236 of file itkImageBufferRange.h.

◆ operator!=

template<typename TImage >

template<bool VIsConst>

bool operator!=	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 != it2) for iterators it1 and it2.

Definition at line 389 of file itkImageBufferRange.h.

◆ operator+ [1/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator operator+	(	const difference_type	n,
		QualifiedIterator< VIsConst >	it
	)

friend

Returns (n + it) for iterator 'it' and integer value 'n'.

Definition at line 467 of file itkImageBufferRange.h.

◆ operator+ [2/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator operator+	(	QualifiedIterator< VIsConst >	it,
		const difference_type	n
	)

friend

Returns (it + n) for iterator 'it' and integer value 'n'.

Definition at line 459 of file itkImageBufferRange.h.

◆ operator+=

template<typename TImage >

template<bool VIsConst>

QualifiedIterator & operator+=	(	QualifiedIterator< VIsConst > &	it,
		const difference_type	n
	)

friend

Does (it += d) for iterator 'it' and integer value 'n'.

Definition at line 433 of file itkImageBufferRange.h.

◆ operator- [1/2]

template<typename TImage >

template<bool VIsConst>

difference_type operator-	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 - it2) for iterators it1 and it2.

Definition at line 451 of file itkImageBufferRange.h.

◆ operator- [2/2]

template<typename TImage >

template<bool VIsConst>

QualifiedIterator operator-	(	QualifiedIterator< VIsConst >	it,
		const difference_type	n
	)

friend

Returns (it - n) for iterator 'it' and integer value 'n'.

Definition at line 475 of file itkImageBufferRange.h.

◆ operator-=

template<typename TImage >

template<bool VIsConst>

QualifiedIterator & operator-=	(	QualifiedIterator< VIsConst > &	it,
		const difference_type	n
	)

friend

Does (it -= d) for iterator 'it' and integer value 'n'.

Definition at line 442 of file itkImageBufferRange.h.

◆ operator<

template<typename TImage >

template<bool VIsConst>

bool operator<	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 < it2) for iterators it1 and it2.

Definition at line 397 of file itkImageBufferRange.h.

◆ operator<=

template<typename TImage >

template<bool VIsConst>

bool operator<=	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 <= it2) for iterators it1 and it2.

Definition at line 414 of file itkImageBufferRange.h.

◆ operator==

template<typename TImage >

template<bool VIsConst>

bool operator==	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 == it2) for iterators it1 and it2. Note that these iterators should be from the same range. This operator does not support comparing iterators from different ranges.

Definition at line 381 of file itkImageBufferRange.h.

◆ operator>

template<typename TImage >

template<bool VIsConst>

bool operator>	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 > it2) for iterators it1 and it2.

Definition at line 406 of file itkImageBufferRange.h.

◆ operator>=

template<typename TImage >

template<bool VIsConst>

bool operator>=	(	const QualifiedIterator< VIsConst > &	lhs,
		const QualifiedIterator< VIsConst > &	rhs
	)

friend

Returns (it1 >= it2) for iterators it1 and it2.

Definition at line 424 of file itkImageBufferRange.h.

◆ QualifiedIterator<!VIsConst >

template<typename TImage >

template<bool VIsConst>

friend class QualifiedIterator<!VIsConst >

friend

Definition at line 202 of file itkImageBufferRange.h.

Member Data Documentation

◆ IsImageTypeConst

template<typename TImage >

template<bool VIsConst>

constexpr bool itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::IsImageTypeConst = std::is_const_v<QualifiedImageType>

staticconstexprprivate

Definition at line 241 of file itkImageBufferRange.h.

◆ m_InternalPixelPointer

template<typename TImage >

template<bool VIsConst>

QualifiedInternalPixelType* itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_InternalPixelPointer = nullptr

private

Definition at line 278 of file itkImageBufferRange.h.

Referenced by itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator*(), itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator++(), and itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator--().

◆ m_OptionalAccessorFunctor

template<typename TImage >

template<bool VIsConst>

OptionalAccessorFunctorType itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::m_OptionalAccessorFunctor

private

Definition at line 275 of file itkImageBufferRange.h.

Referenced by itk::ImageBufferRange< TImage >::QualifiedIterator< VIsConst >::operator*().

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

itkImageBufferRange.h

Detailed Description

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ QualifiedImageType

◆ QualifiedInternalPixelType

◆ QualifiedPixelType

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ QualifiedIterator() [1/3]

◆ QualifiedIterator() [2/3]

◆ QualifiedIterator() [3/3]

Member Function Documentation

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator[]()

Friends And Related Function Documentation

◆ ImageBufferRange

◆ operator!=

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator+=

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator-=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ QualifiedIterator<!VIsConst >

Member Data Documentation

◆ IsImageTypeConst

◆ m_InternalPixelPointer

◆ m_OptionalAccessorFunctor