dune-spgrid 2.7
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Dune::SPMultiIndex< dim > Class Template Reference

multiindex More...

#include <dune/grid/spgrid/multiindex.hh>

Inheritance diagram for Dune::SPMultiIndex< dim >:
Inheritance graph

Public Types

typedef std::array< int, dimension >::const_iterator ConstIterator
 
typedef std::array< int, dimension >::iterator Iterator
 

Public Member Functions

 SPMultiIndex ()
 default constructor More...
 
 SPMultiIndex (const int(&index)[dimension])
 constructor from int array More...
 
 SPMultiIndex (const std::array< int, dimension > &index)
 constructor from int array More...
 
 SPMultiIndex (const This &other)
 copy constructor More...
 
Thisoperator= (const This &other)
 copy assignment More...
 
Thisoperator= (const int(&index)[dimension])
 assignment operator from int array More...
 
Thisoperator= (const std::array< int, dimension > &index)
 
Thisoperator+= (const This &other)
 add another multiindex to this one (vector operation) More...
 
Thisoperator-= (const This &other)
 subtract another multiindex from this one (vector operation) More...
 
Thisoperator*= (int a)
 scale this multiindex (vector operation) More...
 
Thisoperator/= (int a)
 scale this multiindex (vector operation) More...
 
const int & operator[] (int i) const
 access i-th component More...
 
int & operator[] (int i)
 access i-th component More...
 
bool operator== (const This &other) const
 compare two multiindices for equality More...
 
bool operator!= (const This &other) const
 compare two multiindices for inequality More...
 
void axpy (const int a, const This &other)
 add multiple of a multiindex to this one (vector operation) More...
 
ConstIterator begin () const
 
Iterator begin ()
 
ConstIterator cbegin () const
 
ConstIterator end () const
 
Iterator end ()
 
ConstIterator cend () const
 
void clear ()
 initialize to zero More...
 
void increment (const This &bound, const int k=1)
 
int codimension () const
 

Static Public Member Functions

static This zero ()
 obtain the zero multiindex More...
 

Static Public Attributes

static const int dimension = dim
 dimension of the multiindex More...
 

Detailed Description

template<int dim>
class Dune::SPMultiIndex< dim >

multiindex

Template Parameters
dimdimension of the multiindex

Member Typedef Documentation

◆ ConstIterator

template<int dim>
typedef std::array<int,dimension>::const_iterator Dune::SPMultiIndex< dim >::ConstIterator

◆ Iterator

template<int dim>
typedef std::array<int,dimension>::iterator Dune::SPMultiIndex< dim >::Iterator

Constructor & Destructor Documentation

◆ SPMultiIndex() [1/4]

template<int dim>
Dune::SPMultiIndex< dim >::SPMultiIndex ( )
inline

default constructor

◆ SPMultiIndex() [2/4]

template<int dim>
Dune::SPMultiIndex< dim >::SPMultiIndex ( const int(&)  index[dimension])
inline

constructor from int array

Note
This constructor defines an implicit conversion.
Parameters
[in]indexint array to copy

◆ SPMultiIndex() [3/4]

template<int dim>
Dune::SPMultiIndex< dim >::SPMultiIndex ( const std::array< int, dimension > &  index)
inline

constructor from int array

Note
This constructor defines an implicit conversion.
Parameters
[in]indexint array to copy

◆ SPMultiIndex() [4/4]

template<int dim>
Dune::SPMultiIndex< dim >::SPMultiIndex ( const This other)
inline

copy constructor

Member Function Documentation

◆ axpy()

template<int dim>
void Dune::SPMultiIndex< dim >::axpy ( const int  a,
const This other 
)
inline

add multiple of a multiindex to this one (vector operation)

◆ begin() [1/2]

template<int dim>
Iterator Dune::SPMultiIndex< dim >::begin ( )
inline

◆ begin() [2/2]

template<int dim>
ConstIterator Dune::SPMultiIndex< dim >::begin ( ) const
inline

◆ cbegin()

template<int dim>
ConstIterator Dune::SPMultiIndex< dim >::cbegin ( ) const
inline

◆ cend()

template<int dim>
ConstIterator Dune::SPMultiIndex< dim >::cend ( ) const
inline

◆ clear()

template<int dim>
void Dune::SPMultiIndex< dim >::clear ( )
inline

initialize to zero

◆ codimension()

template<int dim>
int Dune::SPMultiIndex< dim >::codimension ( ) const
inline
Todo:
please doc me

◆ end() [1/2]

template<int dim>
Iterator Dune::SPMultiIndex< dim >::end ( )
inline

◆ end() [2/2]

template<int dim>
ConstIterator Dune::SPMultiIndex< dim >::end ( ) const
inline

◆ increment()

template<int dim>
void Dune::SPMultiIndex< dim >::increment ( const This bound,
const int  k = 1 
)
inline
Todo:
please doc me

◆ operator!=()

template<int dim>
bool Dune::SPMultiIndex< dim >::operator!= ( const This other) const
inline

compare two multiindices for inequality

◆ operator*=()

template<int dim>
This & Dune::SPMultiIndex< dim >::operator*= ( int  a)
inline

scale this multiindex (vector operation)

◆ operator+=()

template<int dim>
This & Dune::SPMultiIndex< dim >::operator+= ( const This other)
inline

add another multiindex to this one (vector operation)

◆ operator-=()

template<int dim>
This & Dune::SPMultiIndex< dim >::operator-= ( const This other)
inline

subtract another multiindex from this one (vector operation)

◆ operator/=()

template<int dim>
This & Dune::SPMultiIndex< dim >::operator/= ( int  a)
inline

scale this multiindex (vector operation)

◆ operator=() [1/3]

template<int dim>
This & Dune::SPMultiIndex< dim >::operator= ( const int(&)  index[dimension])
inline

assignment operator from int array

◆ operator=() [2/3]

template<int dim>
This & Dune::SPMultiIndex< dim >::operator= ( const std::array< int, dimension > &  index)
inline

◆ operator=() [3/3]

template<int dim>
This & Dune::SPMultiIndex< dim >::operator= ( const This other)
inline

copy assignment

◆ operator==()

template<int dim>
bool Dune::SPMultiIndex< dim >::operator== ( const This other) const
inline

compare two multiindices for equality

◆ operator[]() [1/2]

template<int dim>
int & Dune::SPMultiIndex< dim >::operator[] ( int  i)
inline

access i-th component

◆ operator[]() [2/2]

template<int dim>
const int & Dune::SPMultiIndex< dim >::operator[] ( int  i) const
inline

access i-th component

◆ zero()

template<int dim>
static This Dune::SPMultiIndex< dim >::zero ( )
inlinestatic

obtain the zero multiindex

Member Data Documentation

◆ dimension

template<int dim>
const int Dune::SPMultiIndex< dim >::dimension = dim
static

dimension of the multiindex


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