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

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 = T *
 
using reference = T &
 
using difference_type = std::ptrdiff_t
 

Public Member Functions

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

Friends

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

Detailed Description

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

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 >::ComponentIterator::difference_type = std::ptrdiff_t

◆ iterator_category

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

◆ pointer

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

◆ reference

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

◆ value_type

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

Constructor & Destructor Documentation

◆ ComponentIterator() [1/3]

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

◆ ComponentIterator() [2/3]

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

◆ ComponentIterator() [3/3]

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

Member Function Documentation

◆ operator!=()

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

◆ operator*()

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

◆ operator+()

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

◆ operator++() [1/2]

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

◆ operator++() [2/2]

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

◆ operator+=()

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

◆ operator-() [1/2]

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

◆ operator-() [2/2]

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

◆ operator--() [1/2]

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

◆ operator--() [2/2]

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

◆ operator-=()

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

◆ operator->()

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

◆ operator<()

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

◆ operator<=()

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

◆ operator==()

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

◆ operator>()

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

◆ operator>=()

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

◆ operator[]()

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

Friends And Related Function Documentation

◆ operator+

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

◆ operator-

template<typename T >
ComponentIterator operator- ( difference_type  lhs,
const ComponentIterator rhs 
)
friend

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