geosx::ComponentMask< MAX_COMP >::Iterator Class Reference

Forward const iterator over the set components (bits). More...

#include <ComponentMask.hpp>

Public Types
using	difference_type = int
	difference type
using	value_type = int
	value type
using	pointer = void
	pointer type (meaningless but makes it iterator_traits compatible)
using	reference = int
	reference type (no real references since this is a const iterator)
using	iterator_category = std::forward_iterator_tag
	iterator category

Public Member Functions
GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE reference	operator* () const
	Dereference operator. More...
GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE Iterator &	operator++ ()
	Prefix increment operator. More...
GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE Iterator	operator++ (int) &
	Postfix increment operator. More...
GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE bool	operator== (Iterator const &other) const
	Comparison operator. More...
GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE bool	operator!= (Iterator const &other) const
	Comparison operator. More...

Friends
class	ComponentMask

Detailed Description

template<int MAX_COMP>
class geosx::ComponentMask< MAX_COMP >::Iterator

Forward const iterator over the set components (bits).

Note

Iterator is invalidated by any mutating operation on the ComponentMask object.

Definition at line 171 of file ComponentMask.hpp.

Member Function Documentation

operator!=()

template<int MAX_COMP>

GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE bool geosx::ComponentMask< MAX_COMP >::Iterator::operator!= ( Iterator const &  other ) const

inline

Comparison operator.

Parameters

other

the iterator to compare to

Returns

true if iterators are not equal

Definition at line 238 of file ComponentMask.hpp.

operator*()

template<int MAX_COMP>

GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE reference geosx::ComponentMask< MAX_COMP >::Iterator::operator* ( ) const

inline

Dereference operator.

Returns

index of currently pointed-to component

Definition at line 187 of file ComponentMask.hpp.

operator++() [1/2]

template<int MAX_COMP>

GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE Iterator& geosx::ComponentMask< MAX_COMP >::Iterator::operator++ ( )

inline

Prefix increment operator.

Returns

reference to this

Definition at line 198 of file ComponentMask.hpp.

operator++() [2/2]

template<int MAX_COMP>

GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE Iterator geosx::ComponentMask< MAX_COMP >::Iterator::operator++ ( int  ) &

inline

Postfix increment operator.

Returns

copy of this prior to increment

Definition at line 212 of file ComponentMask.hpp.

operator==()

template<int MAX_COMP>

GEOSX_HOST_DEVICE GEOSX_FORCE_INLINE bool geosx::ComponentMask< MAX_COMP >::Iterator::operator== ( Iterator const &  other ) const

inline

Comparison operator.

Parameters

other

the iterator to compare to

Returns

true if iterators are equal (as determined by remaining mask)

Definition at line 226 of file ComponentMask.hpp.

---

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

• coreComponents/linearAlgebra/utilities/ComponentMask.hpp