Public Member Functions | List of all members
labelRange::const_iterator Class Reference

Forward iterator with const access. More...

Inheritance diagram for labelRange::const_iterator:
[legend]
Collaboration diagram for labelRange::const_iterator:
[legend]

Public Member Functions

 const_iterator (const labelRange *range, const label i=0)
 Construct from range at given local index. More...
 
label operator* () const noexcept
 Return the (global) value. More...
 
const_iterator & operator++ () noexcept
 Prefix increment, no range checking. More...
 
const_iterator operator++ (int)
 Postfix increment, no range checking. More...
 
const_iterator & operator+= (const label n) noexcept
 Arbitrary increment, no range checking. More...
 
const_iterator & operator-= (const label n) noexcept
 Arbitrary decrement, no range checking. More...
 
bool operator== (const const_iterator &iter) const noexcept
 Test for equality of values. More...
 
bool operator!= (const const_iterator &iter) const noexcept
 Test for inequality of values. More...
 

Detailed Description

Forward iterator with const access.

Definition at line 252 of file labelRange.H.

Constructor & Destructor Documentation

◆ const_iterator()

const_iterator ( const labelRange *  range,
const label  i = 0 
)
inline

Construct from range at given local index.

An out-of-range index (eg, negative) creates an 'end' iterator

Definition at line 75 of file labelRangeI.H.

Member Function Documentation

◆ operator*()

Foam::label operator* ( ) const
inlinenoexcept

Return the (global) value.

Definition at line 88 of file labelRangeI.H.

◆ operator++() [1/2]

Foam::labelRange::const_iterator & operator++ ( )
inlinenoexcept

Prefix increment, no range checking.

Definition at line 95 of file labelRangeI.H.

◆ operator++() [2/2]

Foam::labelRange::const_iterator operator++ ( int  )
inline

Postfix increment, no range checking.

Definition at line 103 of file labelRangeI.H.

◆ operator+=()

Foam::labelRange::const_iterator & operator+= ( const label  n)
inlinenoexcept

Arbitrary increment, no range checking.

Definition at line 112 of file labelRangeI.H.

References n.

◆ operator-=()

Foam::labelRange::const_iterator & operator-= ( const label  n)
inlinenoexcept

Arbitrary decrement, no range checking.

Definition at line 120 of file labelRangeI.H.

References n.

◆ operator==()

bool operator== ( const const_iterator &  iter) const
inlinenoexcept

Test for equality of values.

Definition at line 128 of file labelRangeI.H.

◆ operator!=()

bool operator!= ( const const_iterator &  iter) const
inlinenoexcept

Test for inequality of values.

Definition at line 137 of file labelRangeI.H.

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