dune-pdelab  2.4.1
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
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 >:
Inheritance graph

Classes

class  View
 

Public Member Functions

 MultiIndex ()
 
 MultiIndex (const View &view)
 
void set (typename ReservedVector< T, n >::value_type index)
 
View view () const
 
View view (std::size_t size) const
 
bool operator== (const MultiIndex &r) const
 Tests whether two MultiIndices are equal. More...
 
bool operator!= (const MultiIndex &r) const
 Tests whether two MultiIndices are not equal. More...
 

Static Public Attributes

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

Friends

std::ostream & operator<< (std::ostream &s, const MultiIndex &mi)
 Writes a pretty representation of the MultiIndex to the given std::ostream. More...
 

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
Tthe type of the index entries.
nthe maximum number of indices in the MultiIndex.

Constructor & Destructor Documentation

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

Member Function Documentation

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.

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.
template<typename T, std::size_t n>
void Dune::PDELab::MultiIndex< T, n >::set ( typename ReservedVector< T, n >::value_type  index)
inline
template<typename T, std::size_t n>
View Dune::PDELab::MultiIndex< T, n >::view ( ) const
inline
template<typename T, std::size_t n>
View Dune::PDELab::MultiIndex< T, n >::view ( std::size_t  size) const
inline

Friends And Related Function Documentation

template<typename T, std::size_t n>
std::ostream& operator<< ( std::ostream &  s,
const MultiIndex< T, n > &  mi 
)
friend

Writes a pretty representation of the MultiIndex to the given std::ostream.

Member Data Documentation

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: