Reference documentation for deal.II version 9.5.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | Related Symbols | List of all members
SynchronousIterators< Iterators > Struct Template Reference

#include <deal.II/base/synchronous_iterator.h>

Public Member Functions

 SynchronousIterators (const Iterators &i)
 
const Iterators & operator* () const
 
Iterators & operator* ()
 

Private Attributes

Iterators iterators
 

Related Symbols

(Note that these are not member symbols.)

template<typename Iterators >
bool operator< (const SynchronousIterators< Iterators > &a, const SynchronousIterators< Iterators > &b)
 
template<typename Iterators >
std::size_t operator- (const SynchronousIterators< Iterators > &a, const SynchronousIterators< Iterators > &b)
 
template<typename I1 , typename I2 >
void advance (std::tuple< I1, I2 > &t, const unsigned int n)
 
template<typename I1 , typename I2 , typename I3 >
void advance (std::tuple< I1, I2, I3 > &t, const unsigned int n)
 
template<typename I1 , typename I2 , typename I3 , typename I4 >
void advance (std::tuple< I1, I2, I3, I4 > &t, const unsigned int n)
 
template<typename I1 , typename I2 >
void advance_by_one (std::tuple< I1, I2 > &t)
 
template<typename I1 , typename I2 , typename I3 >
void advance_by_one (std::tuple< I1, I2, I3 > &t)
 
template<typename I1 , typename I2 , typename I3 , typename I4 >
void advance_by_one (std::tuple< I1, I2, I3, I4 > &t)
 
template<typename Iterators >
SynchronousIterators< Iterators > operator+ (const SynchronousIterators< Iterators > &a, const std::size_t n)
 
template<typename Iterators >
SynchronousIterators< Iterators > operator++ (SynchronousIterators< Iterators > &a)
 
template<typename Iterators >
bool operator!= (const SynchronousIterators< Iterators > &a, const SynchronousIterators< Iterators > &b)
 

Detailed Description

template<typename Iterators>
struct SynchronousIterators< Iterators >

A class that represents a set of iterators each of which are incremented by one at the same time. This is typically used in calls like std::transform(a.begin(), a.end(), b.begin(), functor); where we have synchronous iterators marching through the containers a,b. If an object of this type represents the end of a range, only the first element is considered (we only have a.end(), not b.end()). An example of how this class is used is given in step-35.

The template argument of the current class shall be of type std::tuple with arguments equal to the iterator types.

The individual iterators can be accessed using std::get<X>(synchronous_iterator.iterators) where X is the number corresponding to the desired iterator.

This type, and the helper functions associated with it, are used as the Value concept for the blocked_range type of the Threading Building Blocks.

Definition at line 50 of file synchronous_iterator.h.

Constructor & Destructor Documentation

◆ SynchronousIterators()

template<typename Iterators >
SynchronousIterators< Iterators >::SynchronousIterators ( const Iterators &  i)
inline

Constructor.

Definition at line 81 of file synchronous_iterator.h.

Member Function Documentation

◆ operator*() [1/2]

template<typename Iterators >
const Iterators & SynchronousIterators< Iterators >::operator*
inline

Dereference const operator. Returns a const reference to the iterators represented by the current class.

Definition at line 89 of file synchronous_iterator.h.

◆ operator*() [2/2]

template<typename Iterators >
Iterators & SynchronousIterators< Iterators >::operator*
inline

Dereference operator. Returns a reference to the iterators represented by the current class.

Definition at line 98 of file synchronous_iterator.h.

Friends And Related Symbol Documentation

◆ operator<()

template<typename Iterators >
bool operator< ( const SynchronousIterators< Iterators > &  a,
const SynchronousIterators< Iterators > &  b 
)
related

Return whether the first element of the first argument is less than the first element of the second argument. Since the objects compared march forward all elements at the same time, comparing the first element is sufficient.

Definition at line 114 of file synchronous_iterator.h.

◆ operator-()

template<typename Iterators >
std::size_t operator- ( const SynchronousIterators< Iterators > &  a,
const SynchronousIterators< Iterators > &  b 
)
related

Return the distance between the first and the second argument. Since the objects compared march forward all elements at the same time, differencing the first element is sufficient.

Definition at line 132 of file synchronous_iterator.h.

◆ advance() [1/3]

template<typename I1 , typename I2 >
void advance ( std::tuple< I1, I2 > &  t,
const unsigned int  n 
)
related

Advance a tuple of iterators by \(n\).

Definition at line 148 of file synchronous_iterator.h.

◆ advance() [2/3]

template<typename I1 , typename I2 , typename I3 >
void advance ( std::tuple< I1, I2, I3 > &  t,
const unsigned int  n 
)
related

Advance a tuple of iterators by \(n\).

Definition at line 161 of file synchronous_iterator.h.

◆ advance() [3/3]

template<typename I1 , typename I2 , typename I3 , typename I4 >
void advance ( std::tuple< I1, I2, I3, I4 > &  t,
const unsigned int  n 
)
related

Advance a tuple of iterators by \(n\).

Definition at line 175 of file synchronous_iterator.h.

◆ advance_by_one() [1/3]

template<typename I1 , typename I2 >
void advance_by_one ( std::tuple< I1, I2 > &  t)
related

Advance a tuple of iterators by 1.

Definition at line 192 of file synchronous_iterator.h.

◆ advance_by_one() [2/3]

template<typename I1 , typename I2 , typename I3 >
void advance_by_one ( std::tuple< I1, I2, I3 > &  t)
related

Advance a tuple of iterators by 1.

Definition at line 205 of file synchronous_iterator.h.

◆ advance_by_one() [3/3]

template<typename I1 , typename I2 , typename I3 , typename I4 >
void advance_by_one ( std::tuple< I1, I2, I3, I4 > &  t)
related

Advance a tuple of iterators by 1.

Definition at line 219 of file synchronous_iterator.h.

◆ operator+()

template<typename Iterators >
SynchronousIterators< Iterators > operator+ ( const SynchronousIterators< Iterators > &  a,
const std::size_t  n 
)
related

Advance the elements of this iterator by \(n\).

Definition at line 236 of file synchronous_iterator.h.

◆ operator++()

template<typename Iterators >
SynchronousIterators< Iterators > operator++ ( SynchronousIterators< Iterators > &  a)
related

Advance the elements of this iterator by 1.

Definition at line 250 of file synchronous_iterator.h.

◆ operator!=()

template<typename Iterators >
bool operator!= ( const SynchronousIterators< Iterators > &  a,
const SynchronousIterators< Iterators > &  b 
)
related

Compare synch iterators for inequality. Since they march in synch, comparing only the first element is sufficient.

Definition at line 265 of file synchronous_iterator.h.

Member Data Documentation

◆ iterators

template<typename Iterators >
Iterators SynchronousIterators< Iterators >::iterators
private

Storage for the iterators represented by the current class.

Definition at line 75 of file synchronous_iterator.h.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.7