stapl::const_container_iterator< Container, Accessor, Category > Class Template Reference

Const_iterator that is used to globally traverse a container. More...

Public Member Functions
	const_container_iterator (void)
	Create an invalid const_iterator.
	const_container_iterator (Container const *container, index_type index)
	Create a global const_iterator over a given container starting at a specified GID. More...
	const_container_iterator (Container const *container, domain_type const &domain, index_type index)
	Create a global const_iterator over a given container starting at a specified GID with a specific domain. More...
void	operator= (const_container_iterator const &other)
	Assignment operator for a global const_iterator over a given container. If the destination iterator is invalid, the data members are directly copied; otherwise, the two iterators must reside in the same container and domain. More...
index_type	index (void) const
	Return the index (GID) of the const_iterator.
Derived &	derived ()
Derived const &	derived () const
reference	operator* () const
pointer	operator-> ()
reference	operator[] (int n) const
Derived &	operator++ ()
Derived	operator++ (int)
Derived &	operator-- ()
Derived	operator-- (int)
Derived &	operator+= (difference_type n)
Derived &	operator-= (difference_type n)
bool	less_than (iterator_facade const &rhs) const

Public Types
typedef container_traits< Container >::gid_type	index_type
typedef Category	iterator_category
typedef std::remove_const< typename Accessor::value_type >::type	value_type
typedef Difference	difference_type
typedef stub< value_type, Accessor >	pointer
typedef referencer_t::result_type	reference

Friends
class	stapl::iterator_core_access

Detailed Description

template<typename Container, typename Accessor, typename Category>
class stapl::const_container_iterator< Container, Accessor, Category >

Const_iterator that is used to globally traverse a container.

Template Parameters

Container	Type of the container
Accessor	Accessor type used for references (proxies)
Category	Iterator category of this iterator. By default, it's a forward iterator.

See also

proxy

Constructor & Destructor Documentation

const_container_iterator() [1/2]

template<typename Container , typename Accessor , typename Category >

stapl::const_container_iterator< Container, Accessor, Category >::const_container_iterator	(	Container const *	container,
		index_type	index
	)

Create a global const_iterator over a given container starting at a specified GID.

Parameters

container	Pointer to the container
index	Index into the container

const_container_iterator() [2/2]

template<typename Container , typename Accessor , typename Category >

stapl::const_container_iterator< Container, Accessor, Category >::const_container_iterator	(	Container const *	container,
		domain_type const &	domain,
		index_type	index
	)

Create a global const_iterator over a given container starting at a specified GID with a specific domain.

Parameters

container	Pointer to the container
domain	The domain that this iterator will traverse
index	Index into the container

Member Function Documentation

operator=()

template<typename Container , typename Accessor , typename Category >

void stapl::const_container_iterator< Container, Accessor, Category >::operator=

(

const_container_iterator< Container, Accessor, Category > const &

other

)

Assignment operator for a global const_iterator over a given container. If the destination iterator is invalid, the data members are directly copied; otherwise, the two iterators must reside in the same container and domain.

Parameters

other

The iterator being copied

---

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

• const_container_iterator.hpp