sliceRange::const_iterator Class Reference

Bidirectional input iterator with const access. More...

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

Detailed Description

Bidirectional input iterator with const access.

Definition at line 370 of file sliceRange.H.

Member Typedef Documentation

iterator_category

typedef std::random_access_iterator_tag iterator_category

Definition at line 377 of file sliceRange.H.

Member Function Documentation

operator[]()

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

inlinenoexcept

Offset dereference operator.

Definition at line 78 of file sliceRangeI.H.

References n.

operator++() [1/2]

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

inlinenoexcept

Prefix increment.

Definition at line 86 of file sliceRangeI.H.

operator++() [2/2]

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

inlinenoexcept

Postfix increment.

Definition at line 95 of file sliceRangeI.H.

operator--() [1/2]

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

inlinenoexcept

Prefix decrement.

Definition at line 105 of file sliceRangeI.H.

operator--() [2/2]

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

inlinenoexcept

Postfix decrement.

Definition at line 114 of file sliceRangeI.H.

operator+=()

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

inlinenoexcept

Arbitrary increment.

Definition at line 124 of file sliceRangeI.H.

References n.

operator-=()

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

inlinenoexcept

Arbitrary decrement.

Definition at line 133 of file sliceRangeI.H.

References n.

operator+()

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

inlinenoexcept

Return iterator with offset.

Definition at line 142 of file sliceRangeI.H.

References n.

operator-() [1/2]

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

inlinenoexcept

Return iterator with offset.

Definition at line 150 of file sliceRangeI.H.

References n.

operator-() [2/2]

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

inlinenoexcept

Difference operator.

Definition at line 158 of file sliceRangeI.H.

operator==()

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

inlinenoexcept

Test for equality of values (ignore stride)

Definition at line 166 of file sliceRangeI.H.

operator<()

constexpr bool operator< ( const const_iterator &  iter ) const

inlinenoexcept

Compare less-than values (ignore stride)

Definition at line 174 of file sliceRangeI.H.

operator!=()

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

inlinenoexcept

Definition at line 467 of file sliceRange.H.

operator<=()

constexpr bool operator<= ( const const_iterator &  iter ) const

inlinenoexcept

Definition at line 473 of file sliceRange.H.

operator>()

constexpr bool operator> ( const const_iterator &  iter ) const

inlinenoexcept

Definition at line 479 of file sliceRange.H.

operator>=()

constexpr bool operator>= ( const const_iterator &  iter ) const

inlinenoexcept

Definition at line 485 of file sliceRange.H.

indexer() [1/2]

constexpr indexer

inlinenoexcept

Inherit constructors from indexer.

Definition at line 46 of file sliceRangeI.H.

indexer() [2/2]

constexpr indexer

inlinenoexcept

Inherit constructors from indexer.

Definition at line 54 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