libtgd 4.3
A library that makes working with multidimensional arrays in C++ easy
Public Types | Public Member Functions | Friends | List of all members
TGD::Array< T >::ConstComponentIterator Class Reference

Const iterator over all components in the array. This is a random access iterator. More...

#include <array.hpp>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using value_type = T
 
using pointer = const T*
 
using reference = const T&
 
using difference_type = std::ptrdiff_t
 

Public Member Functions

 ConstComponentIterator ()
 
 ConstComponentIterator (const T *rhs)
 
 ConstComponentIterator (const ConstComponentIterator &rhs)
 
ConstComponentIterator & operator+= (difference_type rhs)
 
ConstComponentIterator & operator-= (difference_type rhs)
 
const T & operator* () const
 
const T * operator-> () const
 
const T & operator[] (difference_type rhs) const
 
ConstComponentIterator & operator++ ()
 
ConstComponentIterator & operator-- ()
 
ConstComponentIterator operator++ (int)
 
ConstComponentIterator operator-- (int)
 
difference_type operator- (const ConstComponentIterator &rhs) const
 
ConstComponentIterator operator+ (difference_type rhs) const
 
ConstComponentIterator operator- (difference_type rhs) const
 
bool operator== (const ConstComponentIterator &rhs) const
 
bool operator!= (const ConstComponentIterator &rhs) const
 
bool operator> (const ConstComponentIterator &rhs) const
 
bool operator< (const ConstComponentIterator &rhs) const
 
bool operator>= (const ConstComponentIterator &rhs) const
 
bool operator<= (const ConstComponentIterator &rhs) const
 

Friends

ConstComponentIterator operator+ (difference_type lhs, const ConstComponentIterator &rhs)
 
ConstComponentIterator operator- (difference_type lhs, const ConstComponentIterator &rhs)
 

Detailed Description

template<typename T>
class TGD::Array< T >::ConstComponentIterator

Const iterator over all components in the array. This is a random access iterator.

Member Typedef Documentation

◆ difference_type

template<typename T >
using TGD::Array< T >::ConstComponentIterator::difference_type = std::ptrdiff_t

◆ iterator_category

template<typename T >
using TGD::Array< T >::ConstComponentIterator::iterator_category = std::random_access_iterator_tag

◆ pointer

template<typename T >
using TGD::Array< T >::ConstComponentIterator::pointer = const T*

◆ reference

template<typename T >
using TGD::Array< T >::ConstComponentIterator::reference = const T&

◆ value_type

template<typename T >
using TGD::Array< T >::ConstComponentIterator::value_type = T

Constructor & Destructor Documentation

◆ ConstComponentIterator() [1/3]

template<typename T >
TGD::Array< T >::ConstComponentIterator::ConstComponentIterator ( )
inline

◆ ConstComponentIterator() [2/3]

template<typename T >
TGD::Array< T >::ConstComponentIterator::ConstComponentIterator ( const T * rhs)
inline

◆ ConstComponentIterator() [3/3]

template<typename T >
TGD::Array< T >::ConstComponentIterator::ConstComponentIterator ( const ConstComponentIterator & rhs)
inline

Member Function Documentation

◆ operator!=()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator!= ( const ConstComponentIterator & rhs) const
inline

◆ operator*()

template<typename T >
const T & TGD::Array< T >::ConstComponentIterator::operator* ( ) const
inline

◆ operator+()

template<typename T >
ConstComponentIterator TGD::Array< T >::ConstComponentIterator::operator+ ( difference_type rhs) const
inline

◆ operator++() [1/2]

template<typename T >
ConstComponentIterator & TGD::Array< T >::ConstComponentIterator::operator++ ( )
inline

◆ operator++() [2/2]

template<typename T >
ConstComponentIterator TGD::Array< T >::ConstComponentIterator::operator++ ( int )
inline

◆ operator+=()

template<typename T >
ConstComponentIterator & TGD::Array< T >::ConstComponentIterator::operator+= ( difference_type rhs)
inline

◆ operator-() [1/2]

template<typename T >
difference_type TGD::Array< T >::ConstComponentIterator::operator- ( const ConstComponentIterator & rhs) const
inline

◆ operator-() [2/2]

template<typename T >
ConstComponentIterator TGD::Array< T >::ConstComponentIterator::operator- ( difference_type rhs) const
inline

◆ operator--() [1/2]

template<typename T >
ConstComponentIterator & TGD::Array< T >::ConstComponentIterator::operator-- ( )
inline

◆ operator--() [2/2]

template<typename T >
ConstComponentIterator TGD::Array< T >::ConstComponentIterator::operator-- ( int )
inline

◆ operator-=()

template<typename T >
ConstComponentIterator & TGD::Array< T >::ConstComponentIterator::operator-= ( difference_type rhs)
inline

◆ operator->()

template<typename T >
const T * TGD::Array< T >::ConstComponentIterator::operator-> ( ) const
inline

◆ operator<()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator< ( const ConstComponentIterator & rhs) const
inline

◆ operator<=()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator<= ( const ConstComponentIterator & rhs) const
inline

◆ operator==()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator== ( const ConstComponentIterator & rhs) const
inline

◆ operator>()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator> ( const ConstComponentIterator & rhs) const
inline

◆ operator>=()

template<typename T >
bool TGD::Array< T >::ConstComponentIterator::operator>= ( const ConstComponentIterator & rhs) const
inline

◆ operator[]()

template<typename T >
const T & TGD::Array< T >::ConstComponentIterator::operator[] ( difference_type rhs) const
inline

Friends And Related Symbol Documentation

◆ operator+

template<typename T >
ConstComponentIterator operator+ ( difference_type lhs,
const ConstComponentIterator & rhs )
friend

◆ operator-

template<typename T >
ConstComponentIterator operator- ( difference_type lhs,
const ConstComponentIterator & rhs )
friend
The documentation for this class was generated from the following file:
Generated by doxygen 1.11.0