sliceRange::const_iterator Class Reference

Forward iterator with const access. More...

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

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from sliceRange::indexer
 indexer (const sliceRange *range, const label i=0)
 Construct from range at given local index. More...
 
void next () noexcept
 Forward increment, no checking. More...
 
void next (const label n) noexcept
 Forward increment, no checking. More...
 
bool equals (const indexer &other) const noexcept
 Test for equality of values, not stride. More...
 
label operator* () const noexcept
 Return the value. More...
 
label operator() ()
 Apply a postfix increment and return the current value. More...
 

Detailed Description

Forward iterator with const access.

Definition at line 212 of file sliceRange.H.

Constructor & Destructor Documentation

◆ const_iterator()

const_iterator ( const sliceRange 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 106 of file sliceRangeI.H.

Member Function Documentation

◆ operator++()

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

Prefix increment, no checking.

Definition at line 116 of file sliceRangeI.H.

◆ operator+=()

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

Arbitrary increment, no checking.

Definition at line 124 of file sliceRangeI.H.

References n.

◆ operator--()

Foam::sliceRange::const_iterator & operator-- ( )
inlinenoexcept

Prefix decrement, no checking.

Definition at line 132 of file sliceRangeI.H.

◆ operator-=()

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

Arbitrary decrement, no checking.

Definition at line 140 of file sliceRangeI.H.

References n.

◆ operator==()

bool operator== ( const const_iterator iter) const
inlinenoexcept

Test for equality of values, not stride.

Definition at line 148 of file sliceRangeI.H.

◆ operator!=()

bool operator!= ( const const_iterator iter) const
inlinenoexcept

Test for inequality of values, not stride.

Definition at line 157 of file sliceRangeI.H.

◆ operator*()

Foam::label operator*
inlinenoexcept

Return the (global) value.

Definition at line 91 of file sliceRangeI.H.


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