Loading...
Searching...
No Matches
globalIndex::const_iterator Class Reference

Forward input iterator with const access that is used to iterate across the globalIndex offsets() table. More...

#include <globalIndex.H>

Public Member Functions

 const_iterator (const globalIndex *globalIdx, const label i=0) noexcept
 Construct from globalIndex list at given index.
label index () const noexcept
 The index into the arrays.
label start () const
 The local start.
label size () const
 The local size.
labelRange range () const
 The local range.
labelRange operator* () const
 The local range.
const_iterator & operator++ ()
const_iterator operator++ (int)
const_iterator & operator-- ()
const_iterator operator-- (int)
bool operator== (const const_iterator &iter) const noexcept
bool operator!= (const const_iterator &iter) const noexcept

Detailed Description

Forward input iterator with const access that is used to iterate across the globalIndex offsets() table.

The de-referenced value is the range() with (start, size), but it also provides separate index, start, size information.

Definition at line 651 of file globalIndex.H.

Constructor & Destructor Documentation

◆ const_iterator()

const_iterator ( const globalIndex * globalIdx,
const label i = 0 )
inlineexplicitnoexcept

Construct from globalIndex list at given index.

Definition at line 623 of file globalIndexI.H.

References globalIndex::globalIndex(), and Foam::noexcept.

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ index()

Foam::label index ( ) const
inlinenoexcept

The index into the arrays.

Definition at line 635 of file globalIndexI.H.

References Foam::noexcept.

◆ start()

Foam::label start ( ) const
inline

The local start.

Definition at line 642 of file globalIndexI.H.

◆ size()

Foam::label size ( ) const
inline

The local size.

Definition at line 649 of file globalIndexI.H.

◆ range()

Foam::labelRange range ( ) const
inline

The local range.

Definition at line 656 of file globalIndexI.H.

◆ operator*()

Foam::labelRange operator* ( ) const
inline

The local range.

Definition at line 663 of file globalIndexI.H.

References range.

◆ operator++() [1/2]

Foam::globalIndex::const_iterator & operator++ ( )
inline

Definition at line 671 of file globalIndexI.H.

◆ operator++() [2/2]

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

Definition at line 680 of file globalIndexI.H.

References const_iterator().

Here is the call graph for this function:

◆ operator--() [1/2]

Foam::globalIndex::const_iterator & operator-- ( )
inline

Definition at line 690 of file globalIndexI.H.

◆ operator--() [2/2]

Foam::globalIndex::const_iterator operator-- ( int )
inline

Definition at line 699 of file globalIndexI.H.

References const_iterator().

Here is the call graph for this function:

◆ operator==()

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

Definition at line 709 of file globalIndexI.H.

References const_iterator().

Here is the call graph for this function:

◆ operator!=()

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

Definition at line 720 of file globalIndexI.H.

References const_iterator().

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