Dune::PDELab::MultiIndex< T, n > Class Template Reference

A class for representing multi-indices. More...

#include <dune/pdelab/common/multiindex.hh>

Inheritance diagram for Dune::PDELab::MultiIndex< T, n >:

Classes
class	View

Public Types
typedef T	value_type
typedef T	value_type
typedef T *	pointer
typedef T *	pointer
typedef T &	reference
typedef T &	reference
typedef const T &	const_reference
typedef const T &	const_reference
typedef size_t	size_type
typedef size_t	size_type
typedef std::ptrdiff_t	difference_type
typedef std::ptrdiff_t	difference_type
typedef Dune::GenericIterator< ReservedVector, value_type >	iterator
typedef Dune::GenericIterator< ReservedVector, value_type >	iterator
typedef Dune::GenericIterator< const ReservedVector, const value_type >	const_iterator
typedef Dune::GenericIterator< const ReservedVector, const value_type >	const_iterator

Public Member Functions
	MultiIndex ()
	MultiIndex (const View &view)
void	set (typename ReservedVector< T, n >::value_type index)
void	pop_front ()
	Erases the first element of the multi-index, O(N) time.
View	view () const
View	view (std::size_t size) const
bool	operator== (const MultiIndex &r) const
	Tests whether two MultiIndices are equal.
bool	operator!= (const MultiIndex &r) const
	Tests whether two MultiIndices are not equal.
bool	operator== (const ReservedVector &other) const
void	clear ()
void	clear ()
void	resize (size_t s)
void	resize (size_t s)
void	push_back (const T &t)
void	push_back (const T &t)
void	pop_back ()
void	pop_back ()
iterator	begin ()
const_iterator	begin () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
iterator	end ()
const_iterator	end () const
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
reference	front ()
const_reference	front () const
reference	front ()
const_reference	front () const
reference	back ()
const_reference	back () const
reference	back ()
const_reference	back () const
size_type	size () const
bool	empty () const

Static Public Member Functions
static constexpr size_type	capacity ()
static constexpr size_type	max_size ()

Static Public Attributes
static const std::size_t	max_depth = n
	The maximum possible depth of the MultiIndex.

Detailed Description

template<typename T, std::size_t n>
class Dune::PDELab::MultiIndex< T, n >

A class for representing multi-indices.

A MultiIndex represents an ordered tuple of indices.

Template Parameters

T	the type of the index entries.
n	the maximum number of indices in the MultiIndex.

Constructor & Destructor Documentation

MultiIndex() [1/2]

template<typename T , std::size_t n>

Dune::PDELab::MultiIndex< T, n >::MultiIndex ( )

inline

MultiIndex() [2/2]

template<typename T , std::size_t n>

Dune::PDELab::MultiIndex< T, n >::MultiIndex ( const View &  view )

inline

Member Function Documentation

operator!=()

template<typename T , std::size_t n>

bool Dune::PDELab::MultiIndex< T, n >::operator!= ( const MultiIndex< T, n > &  r ) const

inline

Tests whether two MultiIndices are not equal.

operator==()

template<typename T , std::size_t n>

bool Dune::PDELab::MultiIndex< T, n >::operator== ( const MultiIndex< T, n > &  r ) const

inline

Tests whether two MultiIndices are equal.

Note

Only MultiIndices of identical max_depth are comparable.

pop_front()

template<typename T , std::size_t n>

void Dune::PDELab::MultiIndex< T, n >::pop_front ( )

inline

Erases the first element of the multi-index, O(N) time.

set()

template<typename T , std::size_t n>

void Dune::PDELab::MultiIndex< T, n >::set ( typename ReservedVector< T, n >::value_type  index )

inline

view() [1/2]

template<typename T , std::size_t n>

View Dune::PDELab::MultiIndex< T, n >::view ( ) const

inline

view() [2/2]

template<typename T , std::size_t n>

View Dune::PDELab::MultiIndex< T, n >::view ( std::size_t  size ) const

inline

Member Data Documentation

max_depth

template<typename T , std::size_t n>

const std::size_t Dune::PDELab::MultiIndex< T, n >::max_depth = n

static

The maximum possible depth of the MultiIndex.

---

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

• multiindex.hh