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

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

Public Member Functions

 const_iterator (const globalIndex *globalIdx, const label i=0) noexcept
 Construct from globalIndex list at given index. More...
 
label index () const noexcept
 The index into the arrays. More...
 
label start () const
 The local start. More...
 
label size () const
 The local size. More...
 
labelRange range () const
 The local range. More...
 
labelRange operator* () const
 The local range. More...
 
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 580 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 571 of file globalIndexI.H.

Member Function Documentation

◆ index()

Foam::label index ( ) const
inlinenoexcept

The index into the arrays.

Definition at line 582 of file globalIndexI.H.

◆ start()

Foam::label start ( ) const
inline

The local start.

Definition at line 589 of file globalIndexI.H.

◆ size()

Foam::label size ( ) const
inline

The local size.

Definition at line 596 of file globalIndexI.H.

◆ range()

Foam::labelRange range ( ) const
inline

The local range.

Definition at line 603 of file globalIndexI.H.

◆ operator*()

Foam::labelRange operator* ( ) const
inline

The local range.

Definition at line 610 of file globalIndexI.H.

References range.

◆ operator++() [1/2]

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

Definition at line 618 of file globalIndexI.H.

◆ operator++() [2/2]

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

Definition at line 627 of file globalIndexI.H.

◆ operator--() [1/2]

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

Definition at line 637 of file globalIndexI.H.

◆ operator--() [2/2]

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

Definition at line 646 of file globalIndexI.H.

◆ operator==()

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

Definition at line 657 of file globalIndexI.H.

◆ operator!=()

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

Definition at line 668 of file globalIndexI.H.

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