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

Forward input iterator with const access. More...

Public Member Functions

 const_iterator (const globalIndex *globalIdx, const label proci=0) noexcept
 Construct from globalIndex list at given index. More...
 
label proci () const noexcept
 The associated local proc. 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.

Definition at line 287 of file globalIndex.H.

Constructor & Destructor Documentation

◆ const_iterator()

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

Construct from globalIndex list at given index.

Definition at line 329 of file globalIndexI.H.

Member Function Documentation

◆ proci()

Foam::label proci ( ) const
inlinenoexcept

The associated local proc.

Definition at line 340 of file globalIndexI.H.

◆ start()

Foam::label start ( ) const
inline

The local start.

Definition at line 347 of file globalIndexI.H.

◆ size()

Foam::label size ( ) const
inline

The local size.

Definition at line 354 of file globalIndexI.H.

◆ range()

Foam::labelRange range ( ) const
inline

The local range.

Definition at line 361 of file globalIndexI.H.

◆ operator*()

Foam::labelRange operator* ( ) const
inline

The local range.

Definition at line 368 of file globalIndexI.H.

References range.

◆ operator++() [1/2]

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

Definition at line 376 of file globalIndexI.H.

◆ operator++() [2/2]

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

Definition at line 385 of file globalIndexI.H.

◆ operator--() [1/2]

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

Definition at line 395 of file globalIndexI.H.

◆ operator--() [2/2]

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

Definition at line 404 of file globalIndexI.H.

◆ operator==()

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

Definition at line 415 of file globalIndexI.H.

◆ operator!=()

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

Definition at line 426 of file globalIndexI.H.

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