Loading...
Searching...
No Matches
ReverseIndexIterator< IntType > Class Template Reference

A random-access, integer-like, input iterator for integral values that behaves like a reverse iterator. More...

#include <IndexIterator.H>

Public Types

typedef std::random_access_iterator_tag iterator_category
typedef IntType value_type
typedef IntType difference_type
typedef const IntType * pointer
typedef IntType reference

Public Member Functions

constexpr ReverseIndexIterator () noexcept
 Default construct as zero.
constexpr ReverseIndexIterator (value_type n) noexcept
 Construct with specified value.
constexpr value_type operator* () const noexcept
 Return the value.
constexpr value_type operator[] (value_type n) const noexcept
 Offset dereference operator.
ReverseIndexIterator & operator++ () noexcept
 Prefix increment.
ReverseIndexIterator operator++ (int) noexcept
 Postfix increment.
ReverseIndexIterator & operator-- () noexcept
 Prefix decrement.
ReverseIndexIterator operator-- (int) noexcept
 Postfix decrement.
ReverseIndexIterator & operator+= (value_type n) noexcept
 Arbitrary increment.
ReverseIndexIterator & operator-= (value_type n) noexcept
 Arbitrary decrement.
constexpr ReverseIndexIterator operator+ (value_type n) const noexcept
 Return iterator with offset.
constexpr ReverseIndexIterator operator- (value_type n) const noexcept
 Return iterator with offset.
constexpr value_type operator- (const ReverseIndexIterator &iter) const noexcept
 Difference operator.
constexpr bool operator== (const ReverseIndexIterator &iter) const noexcept
 Test for equality of values.
constexpr bool operator< (const ReverseIndexIterator &iter) const noexcept
 Compare less-than.
constexpr bool operator!= (const ReverseIndexIterator &iter) const noexcept
constexpr bool operator<= (const ReverseIndexIterator &iter) const noexcept
constexpr bool operator> (const ReverseIndexIterator &iter) const noexcept
constexpr bool operator>= (const ReverseIndexIterator &iter) const noexcept

Detailed Description

template<class IntType>
class Foam::ReverseIndexIterator< IntType >

A random-access, integer-like, input iterator for integral values that behaves like a reverse iterator.

Note
No operator+(value_type, iterator) is defined since this provokes misleading resolution errors

Definition at line 239 of file IndexIterator.H.

Member Typedef Documentation

◆ iterator_category

template<class IntType>
typedef std::random_access_iterator_tag iterator_category

Definition at line 249 of file IndexIterator.H.

◆ value_type

template<class IntType>
typedef IntType value_type

Definition at line 250 of file IndexIterator.H.

◆ difference_type

template<class IntType>
typedef IntType difference_type

Definition at line 251 of file IndexIterator.H.

◆ pointer

template<class IntType>
typedef const IntType* pointer

Definition at line 252 of file IndexIterator.H.

◆ reference

template<class IntType>
typedef IntType reference

Definition at line 253 of file IndexIterator.H.

Constructor & Destructor Documentation

◆ ReverseIndexIterator() [1/2]

template<class IntType>
ReverseIndexIterator ( )
inlineconstexprnoexcept

Default construct as zero.

Definition at line 261 of file IndexIterator.H.

References Foam::noexcept.

Referenced by operator!=(), operator++(), operator++(), operator+=(), operator-(), operator--(), operator--(), operator-=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

Here is the caller graph for this function:

◆ ReverseIndexIterator() [2/2]

template<class IntType>
ReverseIndexIterator ( value_type n)
inlineconstexprnoexcept

Construct with specified value.

Definition at line 266 of file IndexIterator.H.

References n, and Foam::noexcept.

Member Function Documentation

◆ operator*()

template<class IntType>
value_type operator* ( ) const
inlineconstexprnoexcept

Return the value.

Definition at line 274 of file IndexIterator.H.

References Foam::noexcept.

◆ operator[]()

template<class IntType>
value_type operator[] ( value_type n) const
inlineconstexprnoexcept

Offset dereference operator.

Definition at line 279 of file IndexIterator.H.

References n.

◆ operator++() [1/2]

template<class IntType>
ReverseIndexIterator & operator++ ( )
inlinenoexcept

Prefix increment.

Definition at line 287 of file IndexIterator.H.

References Foam::noexcept, and ReverseIndexIterator().

Here is the call graph for this function:

◆ operator++() [2/2]

template<class IntType>
ReverseIndexIterator operator++ ( int )
inlinenoexcept

Postfix increment.

Definition at line 296 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator--() [1/2]

template<class IntType>
ReverseIndexIterator & operator-- ( )
inlinenoexcept

Prefix decrement.

Definition at line 306 of file IndexIterator.H.

References Foam::noexcept, and ReverseIndexIterator().

Here is the call graph for this function:

◆ operator--() [2/2]

template<class IntType>
ReverseIndexIterator operator-- ( int )
inlinenoexcept

Postfix decrement.

Definition at line 315 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator+=()

template<class IntType>
ReverseIndexIterator & operator+= ( value_type n)
inlinenoexcept

Arbitrary increment.

Definition at line 325 of file IndexIterator.H.

References n, and ReverseIndexIterator().

Here is the call graph for this function:

◆ operator-=()

template<class IntType>
ReverseIndexIterator & operator-= ( value_type n)
inlinenoexcept

Arbitrary decrement.

Definition at line 334 of file IndexIterator.H.

References n, and ReverseIndexIterator().

Here is the call graph for this function:

◆ operator+()

template<class IntType>
ReverseIndexIterator operator+ ( value_type n) const
inlineconstexprnoexcept

Return iterator with offset.

Definition at line 344 of file IndexIterator.H.

References n.

◆ operator-() [1/2]

template<class IntType>
ReverseIndexIterator operator- ( value_type n) const
inlineconstexprnoexcept

Return iterator with offset.

Definition at line 350 of file IndexIterator.H.

References n.

◆ operator-() [2/2]

template<class IntType>
value_type operator- ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Difference operator.

Definition at line 356 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator==()

template<class IntType>
bool operator== ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Test for equality of values.

Definition at line 368 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator<()

template<class IntType>
bool operator< ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Compare less-than.

Definition at line 376 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator!=()

template<class IntType>
bool operator!= ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Definition at line 386 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator<=()

template<class IntType>
bool operator<= ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Definition at line 391 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator>()

template<class IntType>
bool operator> ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Definition at line 398 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:

◆ operator>=()

template<class IntType>
bool operator>= ( const ReverseIndexIterator< IntType > & iter) const
inlineconstexprnoexcept

Definition at line 404 of file IndexIterator.H.

References ReverseIndexIterator().

Here is the call graph for this function:
The documentation for this class was generated from the following file: