STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Friends
stapl::container_iterator< Container, Accessor, Category > Class Template Reference

Iterator that is used to traverse a container. More...

Public Member Functions

 container_iterator (void)
 Create an invalid iterator.
 
 container_iterator (Container *container, index_type index)
 Create a global iterator over a given container starting at a specified GID. More...
 
 container_iterator (Container *container, domain_type const &domain, index_type index)
 Create a global iterator over a given container starting at a specified GID with a specific domain. More...
 
index_type index (void) const
 Return the index (GID) of the iterator.
 
template<typename conv_Accessor >
 operator const_container_iterator< Container, conv_Accessor, Category > (void) const
 
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::container_iterator< Container, Accessor, Category >

Iterator that is used to traverse a container.

Template Parameters
ContainerType of the container
AccessorAccessor type used for references (proxy)
CategoryIterator category of this iterator. By default, it's a forward iterator.

Constructor & Destructor Documentation

◆ container_iterator() [1/2]

template<typename Container , typename Accessor , typename Category >
stapl::container_iterator< Container, Accessor, Category >::container_iterator ( Container *  container,
index_type  index 
)

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

Parameters
containerPointer to the container
indexIndex into the container

◆ container_iterator() [2/2]

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

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

Parameters
containerPointer to the container
domainThe domain that this iterator will traverse
indexIndex into the container

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