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 storage_type::value_type	value_type

typedef storage_type::value_type	value_type

typedef storage_type::pointer	pointer

typedef storage_type::pointer	pointer

typedef storage_type::const_pointer	const_pointer

typedef storage_type::const_pointer	const_pointer

typedef storage_type::reference	reference

typedef storage_type::reference	reference

typedef storage_type::const_reference	const_reference

typedef storage_type::const_reference	const_reference

typedef storage_type::size_type	size_type

typedef storage_type::size_type	size_type

typedef storage_type::difference_type	difference_type

typedef storage_type::difference_type	difference_type

typedef storage_type::iterator	iterator

typedef storage_type::iterator	iterator

typedef storage_type::const_iterator	const_iterator

typedef storage_type::const_iterator	const_iterator

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_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.

constexpr bool	operator== (const ReservedVector &that) const noexcept

constexpr bool	operator!= (const ReservedVector &that) const noexcept

constexpr bool	operator< (const ReservedVector &that) const noexcept

constexpr bool	operator< (const ReservedVector &that) const noexcept

constexpr bool	operator> (const ReservedVector &that) const noexcept

constexpr bool	operator> (const ReservedVector &that) const noexcept

constexpr bool	operator<= (const ReservedVector &that) const noexcept

constexpr bool	operator<= (const ReservedVector &that) const noexcept

constexpr bool	operator>= (const ReservedVector &that) const noexcept

constexpr bool	operator>= (const ReservedVector &that) const noexcept

constexpr void	clear () noexcept

constexpr void	clear () noexcept

constexpr void	resize (size_type s) noexcept

constexpr void	resize (size_type s) noexcept

constexpr void	push_back (const value_type &t) noexcept(std::is_nothrow_copy_assignable_v< value_type >)

constexpr void	push_back (value_type &&t) noexcept(std::is_nothrow_move_assignable_v< value_type >)

constexpr void	push_back (const value_type &t) noexcept(std::is_nothrow_copy_assignable_v< value_type >)

constexpr void	push_back (value_type &&t) noexcept(std::is_nothrow_move_assignable_v< value_type >)

reference	emplace_back (Args &&... args) noexcept(std::is_nothrow_constructible_v< value_type, decltype(args)... >)

reference	emplace_back (Args &&... args) noexcept(std::is_nothrow_constructible_v< value_type, decltype(args)... >)

constexpr void	pop_back () noexcept

constexpr void	pop_back () noexcept

constexpr iterator	begin () noexcept

constexpr const_iterator	begin () const noexcept

constexpr iterator	begin () noexcept

constexpr const_iterator	begin () const noexcept

constexpr const_iterator	cbegin () const noexcept

constexpr const_iterator	cbegin () const noexcept

constexpr reverse_iterator	rbegin () noexcept

constexpr const_reverse_iterator	rbegin () const noexcept

constexpr reverse_iterator	rbegin () noexcept

constexpr const_reverse_iterator	rbegin () const noexcept

constexpr const_reverse_iterator	crbegin () const noexcept

constexpr const_reverse_iterator	crbegin () const noexcept

constexpr iterator	end () noexcept

constexpr const_iterator	end () const noexcept

constexpr iterator	end () noexcept

constexpr const_iterator	end () const noexcept

constexpr const_iterator	cend () const noexcept

constexpr const_iterator	cend () const noexcept

constexpr reverse_iterator	rend () noexcept

constexpr const_reverse_iterator	rend () const noexcept

constexpr reverse_iterator	rend () noexcept

constexpr const_reverse_iterator	rend () const noexcept

constexpr const_reverse_iterator	crend () const noexcept

constexpr const_reverse_iterator	crend () const noexcept

constexpr reference	at (size_type i)

constexpr const_reference	at (size_type i) const

constexpr reference	at (size_type i)

constexpr const_reference	at (size_type i) const

constexpr reference	operator[] (size_type i) noexcept

constexpr const_reference	operator[] (size_type i) const noexcept

constexpr reference	operator[] (size_type i) noexcept

constexpr const_reference	operator[] (size_type i) const noexcept

constexpr reference	front () noexcept

constexpr const_reference	front () const noexcept

constexpr reference	front () noexcept

constexpr const_reference	front () const noexcept

constexpr reference	back () noexcept

constexpr const_reference	back () const noexcept

constexpr reference	back () noexcept

constexpr const_reference	back () const noexcept

constexpr pointer	data () noexcept

constexpr const_pointer	data () const noexcept

constexpr pointer	data () noexcept

constexpr const_pointer	data () const noexcept

constexpr void	fill (const value_type &value) noexcept(std::is_nothrow_copy_assignable_v< value_type >)

constexpr void	fill (const value_type &value) noexcept(std::is_nothrow_copy_assignable_v< value_type >)

void	swap (ReservedVector &other) noexcept(std::is_nothrow_swappable_v< value_type >)

void	swap (ReservedVector &other) noexcept(std::is_nothrow_swappable_v< value_type >)

constexpr size_type	size () const noexcept

constexpr bool	empty () const noexcept

Static Public Member Functions
static constexpr size_type	capacity () noexcept

static constexpr size_type	max_size () noexcept

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.