Bidirectional input iterator with const access. More...

#include <sliceRange.H>

Inheritance diagram for sliceRange::const_iterator:

Collaboration diagram for sliceRange::const_iterator:

Public Types
typedef std::random_access_iterator_tag	iterator_category
Public Types inherited from sliceRange::indexer
typedef label	value_type
typedef label	difference_type
typedef const label *	pointer
typedef label	reference

Public Member Functions
constexpr label	operator[] (const label n) const noexcept
	Offset dereference operator.
const_iterator &	operator++ () noexcept
	Prefix increment.
const_iterator	operator++ (int) noexcept
	Postfix increment.
const_iterator &	operator-- () noexcept
	Prefix decrement.
const_iterator	operator-- (int) noexcept
	Postfix decrement.
const_iterator &	operator+= (const label n) noexcept
	Arbitrary increment.
const_iterator &	operator-= (const label n) noexcept
	Arbitrary decrement.
constexpr const_iterator	operator+ (const label n) const noexcept
	Return iterator with offset.
constexpr const_iterator	operator- (const label n) const noexcept
	Return iterator with offset.
constexpr label	operator- (const const_iterator &iter) const noexcept
	Difference operator.
constexpr bool	operator== (const const_iterator &iter) const noexcept
	Test for equality of values (ignore stride).
constexpr bool	operator< (const const_iterator &iter) const noexcept
	Compare less-than values (ignore stride).
constexpr bool	operator!= (const const_iterator &iter) const noexcept
constexpr bool	operator<= (const const_iterator &iter) const noexcept
constexpr bool	operator> (const const_iterator &iter) const noexcept
constexpr bool	operator>= (const const_iterator &iter) const noexcept
constexpr	indexer () noexcept
	Inherit constructors from indexer.
constexpr	indexer (const label val, const label stride) noexcept
	Inherit constructors from indexer.
Public Member Functions inherited from sliceRange::indexer
constexpr	indexer () noexcept
	Default construct with zero value and stride = 1.
constexpr	indexer (const label val, const label stride) noexcept
	Construct with specified value and stride.
constexpr label	value () const noexcept
	The current value.
constexpr label	stride () const noexcept
	The stride.
constexpr label	value (const label n) const noexcept
	Value with offset.
void	prev () noexcept
	Decrement value.
void	prev (const label n) noexcept
	Decrease value.
void	next () noexcept
	Increment value.
void	next (const label n) noexcept
	Increase value.
constexpr label	operator* () const noexcept
	Return the value.
label	operator() () noexcept
	Apply a postfix increment and return the current value.

Detailed Description

Bidirectional input iterator with const access.

Definition at line 390 of file sliceRange.H.

Member Typedef Documentation

◆ iterator_category

typedef std::random_access_iterator_tag iterator_category

Definition at line 397 of file sliceRange.H.

Member Function Documentation

◆ operator[]()

Foam::label operator[] ( const label n ) const

inlineconstexprnoexcept

Offset dereference operator.

Definition at line 115 of file sliceRangeI.H.

References n, and sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator++() [1/2]

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

inlinenoexcept

Prefix increment.

Definition at line 123 of file sliceRangeI.H.

References sliceRange::indexer::next(), and Foam::noexcept.

Here is the call graph for this function:

◆ operator++() [2/2]

Foam::sliceRange::const_iterator operator++ ( int )

inlinenoexcept

Postfix increment.

Definition at line 132 of file sliceRangeI.H.

References sliceRange::indexer::next().

Here is the call graph for this function:

◆ operator--() [1/2]

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

inlinenoexcept

Prefix decrement.

Definition at line 142 of file sliceRangeI.H.

References Foam::noexcept, and sliceRange::indexer::prev().

Here is the call graph for this function:

◆ operator--() [2/2]

Foam::sliceRange::const_iterator operator-- ( int )

inlinenoexcept

Postfix decrement.

Definition at line 151 of file sliceRangeI.H.

References sliceRange::indexer::prev().

Here is the call graph for this function:

◆ operator+=()

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

inlinenoexcept

Arbitrary increment.

Definition at line 161 of file sliceRangeI.H.

References n, and sliceRange::indexer::next().

Here is the call graph for this function:

◆ operator-=()

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

inlinenoexcept

Arbitrary decrement.

Definition at line 170 of file sliceRangeI.H.

References n, and sliceRange::indexer::prev().

Here is the call graph for this function:

◆ operator+()

Foam::sliceRange::const_iterator operator+ ( const label n ) const

inlineconstexprnoexcept

Return iterator with offset.

Definition at line 179 of file sliceRangeI.H.

References n, sliceRange::indexer::stride(), and sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator-() [1/2]

Foam::sliceRange::const_iterator operator- ( const label n ) const

inlineconstexprnoexcept

Return iterator with offset.

Definition at line 187 of file sliceRangeI.H.

References n, sliceRange::indexer::stride(), and sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator-() [2/2]

Foam::label operator- ( const const_iterator & iter ) const

inlineconstexprnoexcept

Difference operator.

Definition at line 195 of file sliceRangeI.H.

References sliceRange::indexer::stride(), and sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const const_iterator & iter ) const

inlineconstexprnoexcept

Test for equality of values (ignore stride).

Definition at line 203 of file sliceRangeI.H.

References sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator<()

bool operator< ( const const_iterator & iter ) const

inlineconstexprnoexcept

Compare less-than values (ignore stride).

Definition at line 210 of file sliceRangeI.H.

References sliceRange::indexer::value().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const const_iterator & iter ) const

inlineconstexprnoexcept

Definition at line 487 of file sliceRange.H.

References Foam::noexcept.

◆ operator<=()

bool operator<= ( const const_iterator & iter ) const

inlineconstexprnoexcept

Definition at line 493 of file sliceRange.H.

◆ operator>()

bool operator> ( const const_iterator & iter ) const

inlineconstexprnoexcept

Definition at line 499 of file sliceRange.H.

◆ operator>=()

bool operator>= ( const const_iterator & iter ) const

inlineconstexprnoexcept

Definition at line 505 of file sliceRange.H.

◆ indexer() [1/2]

indexer ( )

inlineconstexprnoexcept

Inherit constructors from indexer.

Definition at line 317 of file sliceRangeI.H.

References sliceRange::indexer::value().

Here is the call graph for this function:

◆ indexer() [2/2]

indexer	(	const label	val,
		const label	stride )

inlineconstexprnoexcept

Inherit constructors from indexer.

Definition at line 322 of file sliceRangeI.H.

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

src/OpenFOAM/primitives/ranges/sliceRange/sliceRange.H
src/OpenFOAM/primitives/ranges/sliceRange/sliceRangeI.H

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ iterator_category

Member Function Documentation

◆ operator[]()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator==()

◆ operator<()

◆ operator!=()

◆ operator<=()

◆ operator>()

◆ operator>=()

◆ indexer() [1/2]

◆ indexer() [2/2]