DDC 0.0.0

a discrete domain computation library

ddc::DiscreteDomainIterator< DDim > Struct Template Reference

Public Types

using iterator_category = std::random_access_iterator_tag
 
using value_type = DiscreteElement< DDim >
 
using difference_type = std::ptrdiff_t
 

Public Member Functions

 DiscreteDomainIterator ()=default
 
constexpr DiscreteDomainIterator (DiscreteElement< DDim > value)
 
constexpr DiscreteElement< DDim > operator* () const noexcept
 
constexpr DiscreteDomainIteratoroperator++ ()
 
constexpr DiscreteDomainIterator operator++ (int)
 
constexpr DiscreteDomainIteratoroperator-- ()
 
constexpr DiscreteDomainIterator operator-- (int)
 
constexpr DiscreteDomainIteratoroperator+= (difference_type n)
 
constexpr DiscreteDomainIteratoroperator-= (difference_type n)
 
constexpr DiscreteElement< DDim > operator[] (difference_type n) const
 

Friends

constexpr bool operator== (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr bool operator!= (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr bool operator< (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr bool operator> (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr bool operator<= (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr bool operator>= (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 
constexpr DiscreteDomainIterator operator+ (DiscreteDomainIterator i, difference_type n)
 
constexpr DiscreteDomainIterator operator+ (difference_type n, DiscreteDomainIterator i)
 
constexpr DiscreteDomainIterator operator- (DiscreteDomainIterator i, difference_type n)
 
constexpr difference_type operator- (DiscreteDomainIterator const &xx, DiscreteDomainIterator const &yy)
 

Member Typedef Documentation

◆ iterator_category

template<class DDim >
using ddc::DiscreteDomainIterator< DDim >::iterator_category = std::random_access_iterator_tag

◆ value_type

template<class DDim >
using ddc::DiscreteDomainIterator< DDim >::value_type = DiscreteElement<DDim>

◆ difference_type

template<class DDim >
using ddc::DiscreteDomainIterator< DDim >::difference_type = std::ptrdiff_t

Constructor & Destructor Documentation

◆ DiscreteDomainIterator() [1/2]

template<class DDim >
ddc::DiscreteDomainIterator< DDim >::DiscreteDomainIterator ( )
default

◆ DiscreteDomainIterator() [2/2]

template<class DDim >
constexpr ddc::DiscreteDomainIterator< DDim >::DiscreteDomainIterator ( DiscreteElement< DDim >  value)
inlineexplicitconstexpr

Member Function Documentation

◆ operator*()

template<class DDim >
constexpr DiscreteElement< DDim > ddc::DiscreteDomainIterator< DDim >::operator* ( ) const
inlineconstexprnoexcept

◆ operator++() [1/2]

template<class DDim >
constexpr DiscreteDomainIterator & ddc::DiscreteDomainIterator< DDim >::operator++ ( )
inlineconstexpr

◆ operator++() [2/2]

template<class DDim >
constexpr DiscreteDomainIterator ddc::DiscreteDomainIterator< DDim >::operator++ ( int  )
inlineconstexpr

◆ operator--() [1/2]

template<class DDim >
constexpr DiscreteDomainIterator & ddc::DiscreteDomainIterator< DDim >::operator-- ( )
inlineconstexpr

◆ operator--() [2/2]

template<class DDim >
constexpr DiscreteDomainIterator ddc::DiscreteDomainIterator< DDim >::operator-- ( int  )
inlineconstexpr

◆ operator+=()

template<class DDim >
constexpr DiscreteDomainIterator & ddc::DiscreteDomainIterator< DDim >::operator+= ( difference_type  n)
inlineconstexpr

◆ operator-=()

template<class DDim >
constexpr DiscreteDomainIterator & ddc::DiscreteDomainIterator< DDim >::operator-= ( difference_type  n)
inlineconstexpr

◆ operator[]()

template<class DDim >
constexpr DiscreteElement< DDim > ddc::DiscreteDomainIterator< DDim >::operator[] ( difference_type  n) const
inlineconstexpr

Friends And Related Function Documentation

◆ operator==

template<class DDim >
constexpr bool operator== ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator!=

template<class DDim >
constexpr bool operator!= ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator<

template<class DDim >
constexpr bool operator< ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator>

template<class DDim >
constexpr bool operator> ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator<=

template<class DDim >
constexpr bool operator<= ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator>=

template<class DDim >
constexpr bool operator>= ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

◆ operator+ [1/2]

template<class DDim >
constexpr DiscreteDomainIterator operator+ ( DiscreteDomainIterator< DDim >  i,
difference_type  n 
)
friend

◆ operator+ [2/2]

template<class DDim >
constexpr DiscreteDomainIterator operator+ ( difference_type  n,
DiscreteDomainIterator< DDim >  i 
)
friend

◆ operator- [1/2]

template<class DDim >
constexpr DiscreteDomainIterator operator- ( DiscreteDomainIterator< DDim >  i,
difference_type  n 
)
friend

◆ operator- [2/2]

template<class DDim >
constexpr difference_type operator- ( DiscreteDomainIterator< DDim > const &  xx,
DiscreteDomainIterator< DDim > const &  yy 
)
friend

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