STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::operations::iterable< Derived > Class Template Reference

Operations class for container distributions that provides global iteration. More...

Public Member Functions

iterator make_iterator (gid_type const &gid)
 Construct an iterator to a specific GID of the container. More...
 
const_iterator make_const_iterator (gid_type const &gid) const
 Construct a const_iterator to a specific GID of the container. More...
 
iterator begin ()
 Construct an iterator to the beginning of the container. More...
 
const_iterator begin () const
 Construct a const_iterator to the beginning of the container. More...
 
const_iterator cbegin () const
 Construct a const_iterator to the beginning of the container. More...
 
iterator end ()
 Construct an iterator to the end of the container. More...
 
const_iterator end () const
 Construct a const_iterator to the end of the container. More...
 
const_iterator cend () const
 Construct a const_iterator to the end of the container. More...
 

Public Types

typedef std::random_access_iterator_tag iterator_category
 
typedef traits_t::gid_type gid_type
 
typedef container_accessor< container_t > accessor_type
 
typedef const_container_accessor< container_t > const_accessor_type
 
typedef container_iterator< container_t, accessor_type, iterator_category > iterator
 
typedef const_container_iterator< container_t, const_accessor_type, iterator_category > const_iterator
 

Detailed Description

template<typename Derived>
class stapl::operations::iterable< Derived >

Operations class for container distributions that provides global iteration.

Template Parameters
DerivedThe most derived distribution class

Member Function Documentation

◆ make_iterator()

template<typename Derived>
iterator stapl::operations::iterable< Derived >::make_iterator ( gid_type const &  gid)

Construct an iterator to a specific GID of the container.

Parameters
gidThe GID for which to create the iterator
Returns
An iterator to the value at gid

◆ make_const_iterator()

template<typename Derived>
const_iterator stapl::operations::iterable< Derived >::make_const_iterator ( gid_type const &  gid) const

Construct a const_iterator to a specific GID of the container.

Parameters
gidThe GID for which to create the const_iterator
Returns
A const_iterator to the value at gid

◆ begin() [1/2]

template<typename Derived>
iterator stapl::operations::iterable< Derived >::begin ( void  )

Construct an iterator to the beginning of the container.

Returns
A global iterator to the first GID in the domain

◆ begin() [2/2]

template<typename Derived>
const_iterator stapl::operations::iterable< Derived >::begin ( void  ) const

Construct a const_iterator to the beginning of the container.

Returns
A global const_iterator to the first GID in the domain

◆ cbegin()

template<typename Derived>
const_iterator stapl::operations::iterable< Derived >::cbegin ( ) const

Construct a const_iterator to the beginning of the container.

Returns
A global const_iterator to the first GID in the domain

◆ end() [1/2]

template<typename Derived>
iterator stapl::operations::iterable< Derived >::end ( void  )

Construct an iterator to the end of the container.

Returns
A global iterator to the one past the last GID in the domain

◆ end() [2/2]

template<typename Derived>
const_iterator stapl::operations::iterable< Derived >::end ( void  ) const

Construct a const_iterator to the end of the container.

Returns
A global const_iterator to the one past the last GID in the domain

◆ cend()

template<typename Derived>
const_iterator stapl::operations::iterable< Derived >::cend ( ) const

Construct a const_iterator to the end of the container.

Returns
A global const_iterator to the one past the last GID in the domain

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