libMesh::IntRange< T > Class Template Reference

The IntRange templated class is intended to make it easy to loop over integers which are indices of a container. More...

#include <int_range.h>

Classes
class	iterator

Public Types
typedef IntRange< T >::iterator	const_iterator

Public Member Functions
template<typename U , typename V >
	IntRange (U begin, V end)
	IntRange (const IntRange &, const const_iterator &begin, const const_iterator &end)
iterator	begin () const
iterator	end () const
std::size_t	size () const
std::size_t	grainsize () const

Private Attributes
iterator	_begin
iterator	_end

Detailed Description

template<typename T>
class libMesh::IntRange< T >

The IntRange templated class is intended to make it easy to loop over integers which are indices of a container.

In cases where such a range is defined by the result of a virtual function call, this allows range-based for loops to be easily written which make only a single such call, rather than a new call for each iteration.

We perform a cast_int operation (no-op in opt mode, test+assert in debug) at construction time to make sure that the given range bounds are representable by the given range type.

Author

Roy H. Stogner

Definition at line 53 of file int_range.h.

Member Typedef Documentation

const_iterator

template<typename T>

typedef IntRange<T>::iterator libMesh::IntRange< T >::const_iterator

Definition at line 109 of file int_range.h.

Constructor & Destructor Documentation

IntRange() [1/2]

template<typename T>

template<typename U , typename V >

libMesh::IntRange< T >::IntRange ( U  begin, V  end  )

inline

Definition at line 112 of file int_range.h.

                           :
    _begin(cast_int<T>(begin)),
    _end(cast_int<T>(end))
  {}

IntRange() [2/2]

template<typename T>

libMesh::IntRange< T >::IntRange ( const IntRange< T > &  , const const_iterator &  begin, const const_iterator &  end  )

inline

Definition at line 118 of file int_range.h.

                                       :
    _begin(begin),
    _end(end)
  {}

Member Function Documentation

begin()

template<typename T>

iterator libMesh::IntRange< T >::begin ( ) const

inline

Definition at line 125 of file int_range.h.

References libMesh::IntRange< T >::_begin.

{ return _begin; }

end()

template<typename T>

iterator libMesh::IntRange< T >::end ( ) const

inline

Definition at line 127 of file int_range.h.

References libMesh::IntRange< T >::_end.

{ return _end; }

grainsize()

template<typename T>

std::size_t libMesh::IntRange< T >::grainsize ( ) const

inline

Definition at line 133 of file int_range.h.

References libMesh::default_grainsize().

{ return libMesh::default_grainsize(); }

size()

template<typename T>

std::size_t libMesh::IntRange< T >::size ( ) const

inline

Definition at line 129 of file int_range.h.

References libMesh::IntRange< T >::_begin, and libMesh::IntRange< T >::_end.

  { return *_end - *_begin; }

Member Data Documentation

_begin

template<typename T>

iterator libMesh::IntRange< T >::_begin

private

Definition at line 136 of file int_range.h.

Referenced by libMesh::IntRange< T >::begin(), and libMesh::IntRange< T >::size().

_end

template<typename T>

iterator libMesh::IntRange< T >::_end

private

Definition at line 136 of file int_range.h.

Referenced by libMesh::IntRange< T >::end(), and libMesh::IntRange< T >::size().

---

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

• include/utils/int_range.h