libMesh::Threads::BlockedRange< T > Class Template Reference

Blocked range which can be subdivided and executed in parallel. More...

#include <threads.h>

Public Types
typedef T	const_iterator
	Allows an StoredRange to behave like an STL container.

Public Member Functions
	BlockedRange (const unsigned int new_grainsize=libMesh::default_grainsize())
	Constructor.
	BlockedRange (const const_iterator first, const const_iterator last, const unsigned int new_grainsize=libMesh::default_grainsize())
	Constructor.
	BlockedRange (const BlockedRange< T > &r)
	Copy constructor.
	BlockedRange (BlockedRange< T > &r, Threads::split)
	Splits the range r.
void	reset (const const_iterator first, const const_iterator last)
	Resets the StoredRange to contain [first,last).
const_iterator	begin () const
	Beginning of the range.
const_iterator	end () const
	End of the range.
unsigned int	grainsize () const
	The grain size for the range.
void	grainsize (const unsigned int &gs)
	Set the grain size.
int	size () const
bool	empty () const
bool	is_divisible () const

Private Attributes
const_iterator	_end
const_iterator	_begin
unsigned int	_grainsize

Detailed Description

template<typename T>
class libMesh::Threads::BlockedRange< T >

Blocked range which can be subdivided and executed in parallel.

Definition at line 165 of file threads.h.

Member Typedef Documentation

const_iterator

template<typename T >

typedef T libMesh::Threads::BlockedRange< T >::const_iterator

Allows an StoredRange to behave like an STL container.

Definition at line 171 of file threads.h.

Constructor & Destructor Documentation

BlockedRange() [1/4]

template<typename T >

libMesh::Threads::BlockedRange< T >::BlockedRange ( const unsigned int  new_grainsize = libMesh::default_grainsize() )

inlineexplicit

Constructor.

Optionally takes the grainsize parameter, which is the smallest chunk the range may be broken into for parallel execution.

Definition at line 178 of file threads.h.

                                                                                        :
    _grainsize(new_grainsize)
  {}

BlockedRange() [2/4]

template<typename T >

libMesh::Threads::BlockedRange< T >::BlockedRange ( const const_iterator  first, const const_iterator  last, const unsigned int  new_grainsize = libMesh::default_grainsize()  )

inline

Constructor.

Takes the beginning and end of the range. Optionally takes the grainsize parameter, which is the smallest chunk the range may be broken into for parallel execution.

Definition at line 188 of file threads.h.

                                                                               :
    _grainsize(new_grainsize)
  {
    this->reset(first, last);
  }

References libMesh::Threads::BlockedRange< T >::reset().

BlockedRange() [3/4]

template<typename T >

libMesh::Threads::BlockedRange< T >::BlockedRange ( const BlockedRange< T > &  r )

inline

Copy constructor.

The StoredRange can be copied into subranges for parallel execution. In this way the initial StoredRange can be thought of as the root of a binary tree. The root element is the only element which interacts with the user. It takes a specified range of objects and packs it into a contiguous vector which can be split efficiently. However, there is no need for the child ranges to contain this vector, so long as the parent outlives the children. So we implement the copy constructor to specifically omit the _objs vector.

Definition at line 209 of file threads.h.

                                          :
    _end(r._end),
    _begin(r._begin),
    _grainsize(r._grainsize)
  {}

BlockedRange() [4/4]

template<typename T >

libMesh::Threads::BlockedRange< T >::BlockedRange ( BlockedRange< T > &  r, Threads::split    )

inline

Splits the range r.

The first half of the range is left in place, the second half of the range is placed in *this.

Definition at line 220 of file threads.h.

                                                    :
    _end(r._end),
    _begin(r._begin),
    _grainsize(r._grainsize)
  {
    const_iterator
      beginning = r._begin,
      ending    = r._end,
      middle    = beginning + (ending - beginning)/2u;
 
    r._end = _begin = middle;
  }

References libMesh::Threads::BlockedRange< T >::_begin, and libMesh::Threads::BlockedRange< T >::_end.

Member Function Documentation

begin()

template<typename T >

const_iterator libMesh::Threads::BlockedRange< T >::begin ( ) const

inline

Beginning of the range.

Definition at line 246 of file threads.h.

{ return _begin; }

References libMesh::Threads::BlockedRange< T >::_begin.

empty()

template<typename T >

bool libMesh::Threads::BlockedRange< T >::empty ( ) const

inline

Returns

true if the range is empty.

Definition at line 276 of file threads.h.

{ return (_begin == _end); }

References libMesh::Threads::BlockedRange< T >::_begin, and libMesh::Threads::BlockedRange< T >::_end.

end()

template<typename T >

const_iterator libMesh::Threads::BlockedRange< T >::end ( ) const

inline

End of the range.

Definition at line 251 of file threads.h.

{ return _end; }

References libMesh::Threads::BlockedRange< T >::_end.

grainsize() [1/2]

template<typename T >

unsigned int libMesh::Threads::BlockedRange< T >::grainsize ( ) const

inline

The grain size for the range.

The range will be subdivided into subranges not to exceed the grain size.

Definition at line 257 of file threads.h.

{return _grainsize;}

References libMesh::Threads::BlockedRange< T >::_grainsize.

Referenced by libMesh::Threads::BlockedRange< T >::is_divisible().

grainsize() [2/2]

template<typename T >

void libMesh::Threads::BlockedRange< T >::grainsize ( const unsigned int &  gs )

inline

Set the grain size.

Definition at line 262 of file threads.h.

{_grainsize = gs;}

References libMesh::Threads::BlockedRange< T >::_grainsize.

is_divisible()

template<typename T >

bool libMesh::Threads::BlockedRange< T >::is_divisible ( ) const

inline

Returns

true if the range can be subdivided.

Definition at line 281 of file threads.h.

{ return ((_begin + this->grainsize()) < _end); }

References libMesh::Threads::BlockedRange< T >::_begin, libMesh::Threads::BlockedRange< T >::_end, and libMesh::Threads::BlockedRange< T >::grainsize().

reset()

template<typename T >

void libMesh::Threads::BlockedRange< T >::reset ( const const_iterator  first, const const_iterator  last  )

inline

Resets the StoredRange to contain [first,last).

Definition at line 236 of file threads.h.

  {
    _begin = first;
    _end   = last;
  }

References libMesh::Threads::BlockedRange< T >::_begin, and libMesh::Threads::BlockedRange< T >::_end.

Referenced by libMesh::Threads::BlockedRange< T >::BlockedRange().

size()

template<typename T >

int libMesh::Threads::BlockedRange< T >::size ( ) const

inline

Returns

The size of the range.

Definition at line 267 of file threads.h.

{ return (_end -_begin); }

References libMesh::Threads::BlockedRange< T >::_begin, and libMesh::Threads::BlockedRange< T >::_end.

Member Data Documentation

_begin

template<typename T >

const_iterator libMesh::Threads::BlockedRange< T >::_begin

private

Definition at line 286 of file threads.h.

Referenced by libMesh::Threads::BlockedRange< T >::begin(), libMesh::Threads::BlockedRange< T >::BlockedRange(), libMesh::Threads::BlockedRange< T >::empty(), libMesh::Threads::BlockedRange< T >::is_divisible(), libMesh::Threads::BlockedRange< T >::reset(), and libMesh::Threads::BlockedRange< T >::size().

_end

template<typename T >

const_iterator libMesh::Threads::BlockedRange< T >::_end

private

Definition at line 285 of file threads.h.

Referenced by libMesh::Threads::BlockedRange< T >::BlockedRange(), libMesh::Threads::BlockedRange< T >::empty(), libMesh::Threads::BlockedRange< T >::end(), libMesh::Threads::BlockedRange< T >::is_divisible(), libMesh::Threads::BlockedRange< T >::reset(), and libMesh::Threads::BlockedRange< T >::size().

_grainsize

template<typename T >

unsigned int libMesh::Threads::BlockedRange< T >::_grainsize

private

Definition at line 287 of file threads.h.

Referenced by libMesh::Threads::BlockedRange< T >::grainsize(), and libMesh::Threads::BlockedRange< T >::grainsize().

---

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

• include/parallel/threads.h